{ "openapi": "3.1.1", "info": { "title": "EspoCRM · Sales API", "version": "1.0.0" }, "paths": { "\/CreditNote": { "post": { "tags": [ "CreditNote" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreditNote_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create CreditNote", "description": "Create a new 'CreditNote' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreditNote" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "CreditNote" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "resolved", "openIssued", "issued" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "appliedToInvoice", "number", "numberA", "numberDraftA", "status", "dateIssued", "dateDue", "postingDate", "accountId", "accountName", "invoiceId", "invoiceName", "billingContactId", "billingContactName", "isTaxInclusive", "description", "roundingProfileId", "roundingProfileName", "taxId", "taxName", "taxRate", "taxCodeId", "taxCodeName", "taxTotals", "taxAmountCurrency", "taxAmount", "roundingAmountCurrency", "roundingAmount", "amountCurrency", "amount", "shippingCostCurrency", "shippingCost", "shippingAmountCurrency", "shippingAmount", "shippingTaxMode", "grandTotalAmountCurrency", "grandTotalAmount", "amountDueCurrency", "amountDue", "amountDueConverted", "amountAllocationSubtracted", "amountLocalCurrency", "amountLocal", "grandTotalAmountLocal", "shippingAmountLocal", "taxAmountLocal", "roundingAmountLocal", "currencyRate", "itemList", "allocations", "unallocatedAmountCurrency", "unallocatedAmount", "unallocatedAmountConverted", "buyerReference", "purchaseOrderReference", "note", "buyerName", "buyerElectronicAddressScheme", "buyerElectronicAddressIdentifier", "buyerTaxNumber", "sellerName", "sellerElectronicAddressScheme", "sellerElectronicAddressIdentifier", "sellerTaxNumber", "sellerTaxRegistrationScheme", "sellerTaxRegistrationIdentifier", "sellerAddressStreet", "sellerAddressCity", "sellerAddressState", "sellerAddressCountry", "sellerAddressPostalCode", "sellerContactName", "sellerContactEmailAddress", "sellerContactPhoneNumber", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressCountry", "billingAddressPostalCode", "isDone", "isNotActual", "isIssued", "wasIssued", "issuedById", "issuedByName", "issuedAt", "isLocked", "productsIds", "productsNames", "idForSearch", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "taxAmountConverted", "roundingAmountConverted", "amountConverted", "shippingCostConverted", "shippingAmountConverted", "grandTotalAmountConverted", "amountLocalConverted", "sellerAddressMap", "billingAddressMap" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List CreditNote", "description": "List CreditNote records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CreditNote" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/CreditNote\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "CreditNote" ], "summary": "Read CreditNote", "description": "Read an existing 'CreditNote' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreditNote" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "CreditNote" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreditNote" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update CreditNote", "description": "Update an existing 'CreditNote' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreditNote" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "CreditNote" ], "summary": "Remove CreditNote", "description": "Remove an existing 'CreditNote' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/CreditNoteItem": { "post": { "tags": [ "CreditNoteItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreditNoteItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create CreditNoteItem", "description": "Create a new 'CreditNoteItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreditNoteItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "CreditNoteItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "creditNoteId", "creditNoteName", "accountId", "accountName", "creditNoteStatus", "dateIssued", "postingDate", "productId", "productName", "allowFractionalQuantity", "productType", "productIsSubscribable", "quantity", "quantityInt", "unitPriceCurrency", "unitPrice", "amountCurrency", "amount", "taxRate", "taxCodeId", "taxCodeName", "taxes", "unitPriceNet", "amountLocal", "taxAmount", "order", "description", "periodStartDate", "periodEndDate", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "unitPriceConverted", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List CreditNoteItem", "description": "List CreditNoteItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CreditNoteItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/CreditNoteItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "CreditNoteItem" ], "summary": "Read CreditNoteItem", "description": "Read an existing 'CreditNoteItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreditNoteItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "CreditNoteItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreditNoteItem" } } } }, "parameters": [], "summary": "Update CreditNoteItem", "description": "Update an existing 'CreditNoteItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreditNoteItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "CreditNoteItem" ], "summary": "Remove CreditNoteItem", "description": "Remove an existing 'CreditNoteItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/DeliveryOrder": { "post": { "tags": [ "DeliveryOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeliveryOrder_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create DeliveryOrder", "description": "Create a new 'DeliveryOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeliveryOrder" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "DeliveryOrder" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "completed" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "status", "dateOrdered", "shippingDate", "deliveryDate", "accountId", "accountName", "salesOrderId", "salesOrderName", "description", "warehouseId", "warehouseName", "shippingAddressStreet", "shippingAddressCity", "shippingAddressState", "shippingAddressCountry", "shippingAddressPostalCode", "shippingContactId", "shippingContactName", "shippingProviderId", "shippingProviderName", "shippingCostCurrency", "shippingCost", "amountCurrency", "amount", "amountConverted", "weight", "itemList", "inventoryQuantityMaps", "inventoryData", "inventoryStatus", "isDone", "isNotActual", "isLocked", "isHardLocked", "productsIds", "productsNames", "inventoryNumbersIds", "inventoryNumbersNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "shippingAddressMap", "shippingCostConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List DeliveryOrder", "description": "List DeliveryOrder records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DeliveryOrder" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/DeliveryOrder\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "DeliveryOrder" ], "summary": "Read DeliveryOrder", "description": "Read an existing 'DeliveryOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeliveryOrder" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "DeliveryOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeliveryOrder" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update DeliveryOrder", "description": "Update an existing 'DeliveryOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeliveryOrder" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "DeliveryOrder" ], "summary": "Remove DeliveryOrder", "description": "Remove an existing 'DeliveryOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/DeliveryOrder\/{id}\/inventoryTransactions": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "DeliveryOrder" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "type", "number", "parentId", "parentType", "parentName", "quantity", "productId", "productName", "warehouseId", "warehouseName", "inventoryNumberId", "inventoryNumberName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List DeliveryOrder . inventoryTransactions", "description": "List 'InventoryTransaction' records related through the 'inventoryTransactions' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InventoryTransaction" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "DeliveryOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of InventoryTransaction record." } } } } } }, "summary": "Relate DeliveryOrder . inventoryTransactions", "description": "Relate 'InventoryTransaction' record though the 'inventoryTransactions' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "DeliveryOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of InventoryTransaction record." } } } } } }, "summary": "Unrelate DeliveryOrder . inventoryTransactions", "description": "Unrelate 'InventoryTransaction' record related though the 'inventoryTransactions' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/DeliveryOrderItem": { "post": { "tags": [ "DeliveryOrderItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeliveryOrderItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create DeliveryOrderItem", "description": "Create a new 'DeliveryOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeliveryOrderItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "DeliveryOrderItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "deliveryOrderId", "deliveryOrderName", "accountId", "accountName", "deliveryOrderStatus", "productId", "productName", "quantity", "quantityInt", "inventoryNumberId", "inventoryNumberName", "inventoryNumberType", "isInventory", "allowFractionalQuantity", "productType", "unitWeight", "weight", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List DeliveryOrderItem", "description": "List DeliveryOrderItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DeliveryOrderItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/DeliveryOrderItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "DeliveryOrderItem" ], "summary": "Read DeliveryOrderItem", "description": "Read an existing 'DeliveryOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeliveryOrderItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "DeliveryOrderItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeliveryOrderItem" } } } }, "parameters": [], "summary": "Update DeliveryOrderItem", "description": "Update an existing 'DeliveryOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeliveryOrderItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "DeliveryOrderItem" ], "summary": "Remove DeliveryOrderItem", "description": "Remove an existing 'DeliveryOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/InventoryAdjustment": { "post": { "tags": [ "InventoryAdjustment" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryAdjustment_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create InventoryAdjustment", "description": "Create a new 'InventoryAdjustment' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryAdjustment" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "InventoryAdjustment" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "completed" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "status", "reason", "description", "warehouseId", "warehouseName", "date", "amountCurrency", "amount", "amountConverted", "isLocked", "itemList", "isDone", "isNotActual", "doneAt", "productsIds", "productsNames", "inventoryNumbersIds", "inventoryNumbersNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List InventoryAdjustment", "description": "List InventoryAdjustment records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InventoryAdjustment" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/InventoryAdjustment\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "InventoryAdjustment" ], "summary": "Read InventoryAdjustment", "description": "Read an existing 'InventoryAdjustment' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryAdjustment" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "InventoryAdjustment" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryAdjustment" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update InventoryAdjustment", "description": "Update an existing 'InventoryAdjustment' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryAdjustment" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "InventoryAdjustment" ], "summary": "Remove InventoryAdjustment", "description": "Remove an existing 'InventoryAdjustment' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/InventoryAdjustment\/{id}\/inventoryTransactions": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "InventoryAdjustment" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "type", "number", "parentId", "parentType", "parentName", "quantity", "productId", "productName", "warehouseId", "warehouseName", "inventoryNumberId", "inventoryNumberName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List InventoryAdjustment . inventoryTransactions", "description": "List 'InventoryTransaction' records related through the 'inventoryTransactions' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InventoryTransaction" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "InventoryAdjustment" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of InventoryTransaction record." } } } } } }, "summary": "Relate InventoryAdjustment . inventoryTransactions", "description": "Relate 'InventoryTransaction' record though the 'inventoryTransactions' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "InventoryAdjustment" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of InventoryTransaction record." } } } } } }, "summary": "Unrelate InventoryAdjustment . inventoryTransactions", "description": "Unrelate 'InventoryTransaction' record related though the 'inventoryTransactions' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/InventoryAdjustmentItem": { "post": { "tags": [ "InventoryAdjustmentItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryAdjustmentItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create InventoryAdjustmentItem", "description": "Create a new 'InventoryAdjustmentItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryAdjustmentItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "InventoryAdjustmentItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "completed" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "inventoryAdjustmentId", "inventoryAdjustmentName", "inventoryAdjustmentStatus", "warehouseId", "warehouseName", "productId", "productName", "allowFractionalQuantity", "productType", "quantityOnHand", "newQuantityOnHand", "quantity", "quantityInt", "inventoryNumberId", "inventoryNumberName", "inventoryNumberType", "isInventory", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List InventoryAdjustmentItem", "description": "List InventoryAdjustmentItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InventoryAdjustmentItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/InventoryAdjustmentItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "InventoryAdjustmentItem" ], "summary": "Read InventoryAdjustmentItem", "description": "Read an existing 'InventoryAdjustmentItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryAdjustmentItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "InventoryAdjustmentItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryAdjustmentItem" } } } }, "parameters": [], "summary": "Update InventoryAdjustmentItem", "description": "Update an existing 'InventoryAdjustmentItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryAdjustmentItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "InventoryAdjustmentItem" ], "summary": "Remove InventoryAdjustmentItem", "description": "Remove an existing 'InventoryAdjustmentItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/InventoryNumber": { "post": { "tags": [ "InventoryNumber" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryNumber_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create InventoryNumber", "description": "Create a new 'InventoryNumber' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryNumber" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "InventoryNumber" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "onHand", "notOnHand" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "type", "productId", "productName", "quantityOnHand", "quantityReserved", "quantityInTransit", "quantityWarehouseOnHand", "quantityWarehouseReserved", "warehousesOnHandIds", "warehousesOnHandNames", "incomingDate", "productionDate", "expirationDate", "orderFifo", "orderFefo", "orderLifo", "idForSearch", "deleteId", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List InventoryNumber", "description": "List InventoryNumber records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InventoryNumber" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/InventoryNumber\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "InventoryNumber" ], "summary": "Read InventoryNumber", "description": "Read an existing 'InventoryNumber' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryNumber" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "InventoryNumber" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryNumber" } } } }, "parameters": [], "summary": "Update InventoryNumber", "description": "Update an existing 'InventoryNumber' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryNumber" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "InventoryNumber" ], "summary": "Remove InventoryNumber", "description": "Remove an existing 'InventoryNumber' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/InventoryTransaction": { "post": { "tags": [ "InventoryTransaction" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryTransaction_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create InventoryTransaction", "description": "Create a new 'InventoryTransaction' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryTransaction" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "InventoryTransaction" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "type", "number", "parentId", "parentType", "parentName", "quantity", "productId", "productName", "warehouseId", "warehouseName", "inventoryNumberId", "inventoryNumberName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List InventoryTransaction", "description": "List InventoryTransaction records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InventoryTransaction" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/InventoryTransaction\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "InventoryTransaction" ], "summary": "Read InventoryTransaction", "description": "Read an existing 'InventoryTransaction' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryTransaction" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Invoice": { "post": { "tags": [ "Invoice" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create Invoice", "description": "Create a new 'Invoice' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Invoice" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "paid", "openIssued", "issued" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "numberDraftA", "numberDebitNoteA", "status", "type", "dateInvoiced", "dateDue", "deliveryDate", "periodStartDate", "periodEndDate", "postingDate", "accountId", "accountName", "opportunityId", "opportunityName", "quoteId", "quoteName", "salesOrderId", "salesOrderName", "precedingInvoiceId", "precedingInvoiceName", "description", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressCountry", "billingAddressPostalCode", "shippingAddressStreet", "shippingAddressCity", "shippingAddressState", "shippingAddressCountry", "shippingAddressPostalCode", "billingContactId", "billingContactName", "shippingContactId", "shippingContactName", "roundingProfileId", "roundingProfileName", "installments", "paymentTermsProfileId", "paymentTermsProfileName", "paymentTermsNote", "taxId", "taxName", "taxRate", "taxCodeId", "taxCodeName", "taxTotals", "shippingProviderId", "shippingProviderName", "shippingCostCurrency", "shippingCost", "shippingAmountCurrency", "shippingAmount", "shippingTaxMode", "taxAmountCurrency", "taxAmount", "roundingAmountCurrency", "roundingAmount", "discountAmountCurrency", "discountAmount", "amountCurrency", "amount", "amountDueCurrency", "amountDue", "amountDueConverted", "preDiscountedAmountCurrency", "preDiscountedAmount", "grandTotalAmountCurrency", "grandTotalAmount", "amountLocalCurrency", "amountLocal", "grandTotalAmountLocal", "shippingAmountLocal", "taxAmountLocal", "roundingAmountLocal", "currencyRate", "weight", "itemList", "priceBookId", "priceBookName", "isTaxInclusive", "buyerReference", "purchaseOrderReference", "note", "buyerName", "buyerElectronicAddressScheme", "buyerElectronicAddressIdentifier", "buyerTaxNumber", "sellerName", "sellerElectronicAddressScheme", "sellerElectronicAddressIdentifier", "sellerTaxNumber", "sellerTaxRegistrationScheme", "sellerTaxRegistrationIdentifier", "sellerAddressStreet", "sellerAddressCity", "sellerAddressState", "sellerAddressCountry", "sellerAddressPostalCode", "sellerContactName", "sellerContactEmailAddress", "sellerContactPhoneNumber", "isDone", "isNotActual", "isIssued", "wasIssued", "issuedById", "issuedByName", "issuedAt", "isLocked", "paymentMethodsIds", "paymentMethodsColumns", "paymentMethod", "paymentMethodsNames", "paymentMethodId", "paymentMethodName", "productsIds", "productsNames", "overdueDays", "idForSearch", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "billingAddressMap", "shippingAddressMap", "shippingCostConverted", "shippingAmountConverted", "taxAmountConverted", "roundingAmountConverted", "discountAmountConverted", "amountConverted", "preDiscountedAmountConverted", "grandTotalAmountConverted", "amountLocalConverted", "sellerAddressMap" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List Invoice", "description": "List Invoice records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Invoice\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Invoice" ], "summary": "Read Invoice", "description": "Read an existing 'Invoice' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Invoice" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update Invoice", "description": "Update an existing 'Invoice' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Invoice" ], "summary": "Remove Invoice", "description": "Remove an existing 'Invoice' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/InvoiceItem": { "post": { "tags": [ "InvoiceItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InvoiceItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create InvoiceItem", "description": "Create a new 'InvoiceItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InvoiceItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "InvoiceItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "invoiceId", "invoiceName", "accountId", "accountName", "invoiceStatus", "dateInvoiced", "postingDate", "productId", "productName", "allowFractionalQuantity", "productType", "productIsSubscribable", "quantity", "quantityInt", "listPriceCurrency", "listPrice", "unitPriceCurrency", "unitPrice", "discount", "amountCurrency", "amount", "unitWeight", "weight", "taxRate", "taxCodeId", "taxCodeName", "taxes", "unitPriceNet", "amountLocal", "taxAmount", "order", "description", "periodStartDate", "periodEndDate", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "listPriceConverted", "unitPriceConverted", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List InvoiceItem", "description": "List InvoiceItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/InvoiceItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "InvoiceItem" ], "summary": "Read InvoiceItem", "description": "Read an existing 'InvoiceItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InvoiceItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "InvoiceItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InvoiceItem" } } } }, "parameters": [], "summary": "Update InvoiceItem", "description": "Update an existing 'InvoiceItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InvoiceItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "InvoiceItem" ], "summary": "Remove InvoiceItem", "description": "Remove an existing 'InvoiceItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/OpportunityItem": { "post": { "tags": [ "OpportunityItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OpportunityItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create OpportunityItem", "description": "Create a new 'OpportunityItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OpportunityItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "OpportunityItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "opportunityId", "opportunityName", "productId", "productName", "allowFractionalQuantity", "productType", "quantity", "quantityInt", "listPriceCurrency", "listPrice", "unitPriceCurrency", "unitPrice", "discount", "amountCurrency", "amount", "order", "opportunityStage", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "listPriceConverted", "unitPriceConverted", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List OpportunityItem", "description": "List OpportunityItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OpportunityItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/OpportunityItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "OpportunityItem" ], "summary": "Read OpportunityItem", "description": "Read an existing 'OpportunityItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OpportunityItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "OpportunityItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OpportunityItem" } } } }, "parameters": [], "summary": "Update OpportunityItem", "description": "Update an existing 'OpportunityItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OpportunityItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "OpportunityItem" ], "summary": "Remove OpportunityItem", "description": "Remove an existing 'OpportunityItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PaymentEntry": { "post": { "tags": [ "PaymentEntry" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentEntry_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create PaymentEntry", "description": "Create a new 'PaymentEntry' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentEntry" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "PaymentEntry" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "completed", "openIssued", "issued" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "numberDraftA", "transactionId", "status", "type", "partyType", "accountId", "accountName", "supplierId", "supplierName", "datePaid", "postingDate", "methodId", "methodName", "amountCurrency", "amount", "amountDueCurrency", "amountDue", "amountDueConverted", "amountAllocationSubtracted", "amountLocalCurrency", "amountLocal", "currencyRate", "isLocked", "isDone", "isNotActual", "isIssued", "wasIssued", "issuedById", "issuedByName", "issuedAt", "unallocatedAmountCurrency", "unallocatedAmount", "unallocatedAmountConverted", "description", "allocations", "requestId", "requestName", "teamsIds", "teamsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "amountConverted", "amountLocalConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List PaymentEntry", "description": "List PaymentEntry records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PaymentEntry" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PaymentEntry\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "PaymentEntry" ], "summary": "Read PaymentEntry", "description": "Read an existing 'PaymentEntry' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentEntry" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "PaymentEntry" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentEntry" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update PaymentEntry", "description": "Update an existing 'PaymentEntry' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentEntry" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "PaymentEntry" ], "summary": "Remove PaymentEntry", "description": "Remove an existing 'PaymentEntry' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PaymentRequest": { "post": { "tags": [ "PaymentRequest" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentRequest_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create PaymentRequest", "description": "Create a new 'PaymentRequest' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentRequest" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "PaymentRequest" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "paid" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "status", "methodId", "methodName", "methodProvider", "paymentUrl", "expirationDate", "accountId", "accountName", "amountCurrency", "amount", "invoicesIds", "invoicesNames", "invoiceAmounts", "referenceId", "isLocked", "isDone", "isNotActual", "description", "teamsIds", "teamsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List PaymentRequest", "description": "List PaymentRequest records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PaymentRequest" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PaymentRequest\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "PaymentRequest" ], "summary": "Read PaymentRequest", "description": "Read an existing 'PaymentRequest' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentRequest" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "PaymentRequest" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentRequest" } } } }, "parameters": [], "summary": "Update PaymentRequest", "description": "Update an existing 'PaymentRequest' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentRequest" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "PaymentRequest" ], "summary": "Remove PaymentRequest", "description": "Remove an existing 'PaymentRequest' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PriceBook": { "post": { "tags": [ "PriceBook" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PriceBook_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create PriceBook", "description": "Create a new 'PriceBook' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PriceBook" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "PriceBook" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "active" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "description", "status", "parentPriceBookId", "parentPriceBookName", "isDefault", "isTaxInclusive", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List PriceBook", "description": "List PriceBook records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PriceBook" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PriceBook\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "PriceBook" ], "summary": "Read PriceBook", "description": "Read an existing 'PriceBook' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PriceBook" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "PriceBook" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PriceBook" } } } }, "parameters": [], "summary": "Update PriceBook", "description": "Update an existing 'PriceBook' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PriceBook" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "PriceBook" ], "summary": "Remove PriceBook", "description": "Remove an existing 'PriceBook' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PriceBook\/{id}\/childPriceBooks": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "PriceBook" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "active" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "description", "status", "parentPriceBookId", "parentPriceBookName", "isDefault", "isTaxInclusive", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List PriceBook . childPriceBooks", "description": "List 'PriceBook' records related through the 'childPriceBooks' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PriceBook" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "PriceBook" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of PriceBook record." } } } } } }, "summary": "Relate PriceBook . childPriceBooks", "description": "Relate 'PriceBook' record though the 'childPriceBooks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "PriceBook" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of PriceBook record." } } } } } }, "summary": "Unrelate PriceBook . childPriceBooks", "description": "Unrelate 'PriceBook' record related though the 'childPriceBooks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PriceBook\/{id}\/prices": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "PriceBook" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "active" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "description", "priceBookId", "priceBookName", "status", "productId", "productName", "partNumber", "productIsSubscribable", "productIsSellable", "minQuantity", "priceCurrency", "price", "interval", "dateStart", "dateEnd", "timeline", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "priceConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List PriceBook . prices", "description": "List 'ProductPrice' records related through the 'prices' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ProductPrice" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "PriceBook" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of ProductPrice record." } } } } } }, "summary": "Relate PriceBook . prices", "description": "Relate 'ProductPrice' record though the 'prices' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "PriceBook" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of ProductPrice record." } } } } } }, "summary": "Unrelate PriceBook . prices", "description": "Unrelate 'ProductPrice' record related though the 'prices' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PriceBook\/{id}\/rules": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "PriceBook" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "active" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "description", "priceBookId", "priceBookName", "target", "status", "productCategoryId", "productCategoryName", "conditionSelect", "conditionId", "conditionName", "minQuantity", "basedOn", "supplierId", "supplierName", "price", "percentage", "discount", "roundingMethod", "roundingFactor", "surcharge", "currency", "dateStart", "dateEnd", "timeline", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List PriceBook . rules", "description": "List 'PriceRule' records related through the 'rules' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PriceRule" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "PriceBook" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of PriceRule record." } } } } } }, "summary": "Relate PriceBook . rules", "description": "Relate 'PriceRule' record though the 'rules' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "PriceBook" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of PriceRule record." } } } } } }, "summary": "Unrelate PriceBook . rules", "description": "Unrelate 'PriceRule' record related though the 'rules' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PriceRule": { "post": { "tags": [ "PriceRule" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PriceRule_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create PriceRule", "description": "Create a new 'PriceRule' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PriceRule" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "PriceRule" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "active" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "description", "priceBookId", "priceBookName", "target", "status", "productCategoryId", "productCategoryName", "conditionSelect", "conditionId", "conditionName", "minQuantity", "basedOn", "supplierId", "supplierName", "price", "percentage", "discount", "roundingMethod", "roundingFactor", "surcharge", "currency", "dateStart", "dateEnd", "timeline", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List PriceRule", "description": "List PriceRule records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PriceRule" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PriceRule\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "PriceRule" ], "summary": "Read PriceRule", "description": "Read an existing 'PriceRule' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PriceRule" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "PriceRule" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PriceRule" } } } }, "parameters": [], "summary": "Update PriceRule", "description": "Update an existing 'PriceRule' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PriceRule" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "PriceRule" ], "summary": "Remove PriceRule", "description": "Remove an existing 'PriceRule' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Product": { "post": { "tags": [ "Product" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Product_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create Product", "description": "Create a new 'Product' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Product" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Product" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "available", "inventory", "subscribable", "sellable", "purchasable", "invoiceable", "allVariants", "availableVariants", "availableGoods" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "type", "itemType", "brandId", "brandName", "partNumber", "url", "categoryId", "categoryName", "description", "pricingType", "pricingFactor", "costPriceCurrency", "costPrice", "listPriceCurrency", "listPrice", "unitPriceCurrency", "unitPrice", "suppliersIds", "suppliersNames", "unitPriceSelectCurrency", "unitPriceSelect", "unitPriceSelectConverted", "allowFractionalQuantity", "taxClassesIds", "taxClassesNames", "quantity", "quantityReserved", "quantitySoftReserved", "quantityOnHand", "quantityInTransit", "quantityOnOrder", "quantityWarehouse", "quantityWarehouseOnHand", "quantityWarehouseReserved", "warehousesOnHandIds", "warehousesOnHandNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "teamsIds", "teamsNames", "weight", "isTaxFree", "isSellable", "isPurchasable", "isSubscribable", "isInventory", "inventoryNumberType", "expirationDays", "removalStrategy", "templateId", "templateName", "attributes", "variantAttributeOptionsIds", "variantAttributeOptionsNames", "variantOrder", "costPriceConverted", "listPriceConverted", "unitPriceConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List Product", "description": "List Product records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Product" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Product\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Product" ], "summary": "Read Product", "description": "Read an existing 'Product' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Product" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Product" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Product" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update Product", "description": "Update an existing 'Product' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Product" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Product" ], "summary": "Remove Product", "description": "Remove an existing 'Product' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ProductBrand": { "post": { "tags": [ "ProductBrand" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProductBrand_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create ProductBrand", "description": "Create a new 'ProductBrand' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProductBrand" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "ProductBrand" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "website", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "teamsIds", "teamsNames" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List ProductBrand", "description": "List ProductBrand records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ProductBrand" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ProductBrand\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "ProductBrand" ], "summary": "Read ProductBrand", "description": "Read an existing 'ProductBrand' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProductBrand" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "ProductBrand" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProductBrand" } } } }, "parameters": [], "summary": "Update ProductBrand", "description": "Update an existing 'ProductBrand' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProductBrand" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "ProductBrand" ], "summary": "Remove ProductBrand", "description": "Remove an existing 'ProductBrand' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ProductBrand\/{id}\/products": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "ProductBrand" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "available", "inventory", "subscribable", "sellable", "purchasable", "invoiceable", "allVariants", "availableVariants", "availableGoods" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "type", "itemType", "brandId", "brandName", "partNumber", "url", "categoryId", "categoryName", "description", "pricingType", "pricingFactor", "costPriceCurrency", "costPrice", "listPriceCurrency", "listPrice", "unitPriceCurrency", "unitPrice", "suppliersIds", "suppliersNames", "unitPriceSelectCurrency", "unitPriceSelect", "unitPriceSelectConverted", "allowFractionalQuantity", "taxClassesIds", "taxClassesNames", "quantity", "quantityReserved", "quantitySoftReserved", "quantityOnHand", "quantityInTransit", "quantityOnOrder", "quantityWarehouse", "quantityWarehouseOnHand", "quantityWarehouseReserved", "warehousesOnHandIds", "warehousesOnHandNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "teamsIds", "teamsNames", "weight", "isTaxFree", "isSellable", "isPurchasable", "isSubscribable", "isInventory", "inventoryNumberType", "expirationDays", "removalStrategy", "templateId", "templateName", "attributes", "variantAttributeOptionsIds", "variantAttributeOptionsNames", "variantOrder", "costPriceConverted", "listPriceConverted", "unitPriceConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List ProductBrand . products", "description": "List 'Product' records related through the 'products' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Product" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "ProductBrand" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Product record." } } } } } }, "summary": "Relate ProductBrand . products", "description": "Relate 'Product' record though the 'products' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "ProductBrand" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Product record." } } } } } }, "summary": "Unrelate ProductBrand . products", "description": "Unrelate 'Product' record related though the 'products' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ProductPrice": { "post": { "tags": [ "ProductPrice" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProductPrice_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create ProductPrice", "description": "Create a new 'ProductPrice' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProductPrice" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "ProductPrice" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "active" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "description", "priceBookId", "priceBookName", "status", "productId", "productName", "partNumber", "productIsSubscribable", "productIsSellable", "minQuantity", "priceCurrency", "price", "interval", "dateStart", "dateEnd", "timeline", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "priceConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List ProductPrice", "description": "List ProductPrice records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ProductPrice" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ProductPrice\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "ProductPrice" ], "summary": "Read ProductPrice", "description": "Read an existing 'ProductPrice' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProductPrice" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "ProductPrice" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProductPrice" } } } }, "parameters": [], "summary": "Update ProductPrice", "description": "Update an existing 'ProductPrice' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProductPrice" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "ProductPrice" ], "summary": "Remove ProductPrice", "description": "Remove an existing 'ProductPrice' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PurchaseOrder": { "post": { "tags": [ "PurchaseOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PurchaseOrder_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create PurchaseOrder", "description": "Create a new 'PurchaseOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PurchaseOrder" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "PurchaseOrder" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "completed" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "status", "dateOrdered", "deliveryDate", "accountId", "accountName", "supplierId", "supplierName", "description", "warehouseId", "warehouseName", "supplierAddressStreet", "supplierAddressCity", "supplierAddressState", "supplierAddressCountry", "supplierAddressPostalCode", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressCountry", "billingAddressPostalCode", "shippingAddressStreet", "shippingAddressCity", "shippingAddressState", "shippingAddressCountry", "shippingAddressPostalCode", "billingContactId", "billingContactName", "shippingContactId", "shippingContactName", "taxId", "taxName", "taxRate", "taxCodeId", "taxCodeName", "taxTotals", "shippingProviderId", "shippingProviderName", "shippingCostCurrency", "shippingCost", "shippingAmountCurrency", "shippingAmount", "shippingTaxMode", "taxAmountCurrency", "taxAmount", "discountAmountCurrency", "discountAmount", "amountCurrency", "amount", "preDiscountedAmountCurrency", "preDiscountedAmount", "grandTotalAmountCurrency", "grandTotalAmount", "weight", "itemList", "isReceiptFullyCreated", "hasInventoryItems", "isDone", "isNotActual", "isLocked", "productsIds", "productsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "supplierAddressMap", "billingAddressMap", "shippingAddressMap", "shippingCostConverted", "shippingAmountConverted", "taxAmountConverted", "discountAmountConverted", "amountConverted", "preDiscountedAmountConverted", "grandTotalAmountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List PurchaseOrder", "description": "List PurchaseOrder records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PurchaseOrder" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PurchaseOrder\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "PurchaseOrder" ], "summary": "Read PurchaseOrder", "description": "Read an existing 'PurchaseOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PurchaseOrder" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "PurchaseOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PurchaseOrder" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update PurchaseOrder", "description": "Update an existing 'PurchaseOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PurchaseOrder" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "PurchaseOrder" ], "summary": "Remove PurchaseOrder", "description": "Remove an existing 'PurchaseOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PurchaseOrder\/{id}\/inventoryTransactions": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "PurchaseOrder" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "type", "number", "parentId", "parentType", "parentName", "quantity", "productId", "productName", "warehouseId", "warehouseName", "inventoryNumberId", "inventoryNumberName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List PurchaseOrder . inventoryTransactions", "description": "List 'InventoryTransaction' records related through the 'inventoryTransactions' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InventoryTransaction" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "PurchaseOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of InventoryTransaction record." } } } } } }, "summary": "Relate PurchaseOrder . inventoryTransactions", "description": "Relate 'InventoryTransaction' record though the 'inventoryTransactions' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "PurchaseOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of InventoryTransaction record." } } } } } }, "summary": "Unrelate PurchaseOrder . inventoryTransactions", "description": "Unrelate 'InventoryTransaction' record related though the 'inventoryTransactions' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PurchaseOrderItem": { "post": { "tags": [ "PurchaseOrderItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PurchaseOrderItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create PurchaseOrderItem", "description": "Create a new 'PurchaseOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PurchaseOrderItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "PurchaseOrderItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "purchaseOrderId", "purchaseOrderName", "accountId", "accountName", "purchaseOrderStatus", "productId", "productName", "allowFractionalQuantity", "productType", "itemType", "quantity", "quantityInt", "listPriceCurrency", "listPrice", "unitPriceCurrency", "unitPrice", "discount", "amountCurrency", "amount", "inventoryNumberType", "unitWeight", "weight", "taxRate", "taxCodeId", "taxCodeName", "taxes", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "listPriceConverted", "unitPriceConverted", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List PurchaseOrderItem", "description": "List PurchaseOrderItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PurchaseOrderItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/PurchaseOrderItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "PurchaseOrderItem" ], "summary": "Read PurchaseOrderItem", "description": "Read an existing 'PurchaseOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PurchaseOrderItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "PurchaseOrderItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PurchaseOrderItem" } } } }, "parameters": [], "summary": "Update PurchaseOrderItem", "description": "Update an existing 'PurchaseOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PurchaseOrderItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "PurchaseOrderItem" ], "summary": "Remove PurchaseOrderItem", "description": "Remove an existing 'PurchaseOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Quote": { "post": { "tags": [ "Quote" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Quote_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create Quote", "description": "Create a new 'Quote' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Quote" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Quote" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "approved" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "invoiceNumber", "status", "dateQuoted", "dateOrdered", "dateInvoiced", "expirationDate", "accountId", "accountName", "opportunityId", "opportunityName", "description", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressCountry", "billingAddressPostalCode", "shippingAddressStreet", "shippingAddressCity", "shippingAddressState", "shippingAddressCountry", "shippingAddressPostalCode", "billingContactId", "billingContactName", "shippingContactId", "shippingContactName", "paymentTermsProfileId", "paymentTermsProfileName", "taxId", "taxName", "taxRate", "taxCodeId", "taxCodeName", "taxTotals", "shippingProviderId", "shippingProviderName", "shippingCostCurrency", "shippingCost", "shippingAmountCurrency", "shippingAmount", "shippingTaxMode", "taxAmountCurrency", "taxAmount", "discountAmountCurrency", "discountAmount", "amountCurrency", "amount", "preDiscountedAmountCurrency", "preDiscountedAmount", "grandTotalAmountCurrency", "grandTotalAmount", "weight", "itemList", "priceBookId", "priceBookName", "isTaxInclusive", "isDone", "isNotActual", "isLocked", "inventoryQuantityMaps", "inventoryData", "inventoryStatus", "productsIds", "productsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "billingAddressMap", "shippingAddressMap", "shippingCostConverted", "shippingAmountConverted", "taxAmountConverted", "discountAmountConverted", "amountConverted", "preDiscountedAmountConverted", "grandTotalAmountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List Quote", "description": "List Quote records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Quote" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Quote\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Quote" ], "summary": "Read Quote", "description": "Read an existing 'Quote' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Quote" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Quote" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Quote" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update Quote", "description": "Update an existing 'Quote' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Quote" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Quote" ], "summary": "Remove Quote", "description": "Remove an existing 'Quote' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/QuoteItem": { "post": { "tags": [ "QuoteItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/QuoteItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create QuoteItem", "description": "Create a new 'QuoteItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/QuoteItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "QuoteItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "quoteId", "quoteName", "accountId", "accountName", "quoteStatus", "productId", "productName", "allowFractionalQuantity", "productType", "quantity", "quantityInt", "listPriceCurrency", "listPrice", "unitPriceCurrency", "unitPrice", "discount", "amountCurrency", "amount", "inventoryNumberType", "isInventory", "unitWeight", "weight", "taxRate", "taxCodeId", "taxCodeName", "taxes", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "listPriceConverted", "unitPriceConverted", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List QuoteItem", "description": "List QuoteItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/QuoteItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/QuoteItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "QuoteItem" ], "summary": "Read QuoteItem", "description": "Read an existing 'QuoteItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/QuoteItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "QuoteItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/QuoteItem" } } } }, "parameters": [], "summary": "Update QuoteItem", "description": "Update an existing 'QuoteItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/QuoteItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "QuoteItem" ], "summary": "Remove QuoteItem", "description": "Remove an existing 'QuoteItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ReceiptOrder": { "post": { "tags": [ "ReceiptOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReceiptOrder_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create ReceiptOrder", "description": "Create a new 'ReceiptOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReceiptOrder" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "ReceiptOrder" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "completed" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "status", "dateOrdered", "dateReceived", "accountId", "accountName", "supplierId", "supplierName", "purchaseOrderId", "purchaseOrderName", "returnOrderId", "returnOrderName", "warehouseId", "warehouseName", "description", "shippingContactId", "shippingContactName", "shippingProviderId", "shippingProviderName", "shippingCostCurrency", "shippingCost", "amountCurrency", "amount", "amountConverted", "weight", "itemList", "receivedItemList", "isDone", "isNotActual", "isLocked", "isHardLocked", "productsIds", "productsNames", "inventoryNumbersIds", "inventoryNumbersNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "shippingCostConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List ReceiptOrder", "description": "List ReceiptOrder records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ReceiptOrder" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ReceiptOrder\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "ReceiptOrder" ], "summary": "Read ReceiptOrder", "description": "Read an existing 'ReceiptOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReceiptOrder" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "ReceiptOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReceiptOrder" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update ReceiptOrder", "description": "Update an existing 'ReceiptOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReceiptOrder" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "ReceiptOrder" ], "summary": "Remove ReceiptOrder", "description": "Remove an existing 'ReceiptOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ReceiptOrder\/{id}\/inventoryTransactions": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "ReceiptOrder" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "type", "number", "parentId", "parentType", "parentName", "quantity", "productId", "productName", "warehouseId", "warehouseName", "inventoryNumberId", "inventoryNumberName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List ReceiptOrder . inventoryTransactions", "description": "List 'InventoryTransaction' records related through the 'inventoryTransactions' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InventoryTransaction" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "ReceiptOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of InventoryTransaction record." } } } } } }, "summary": "Relate ReceiptOrder . inventoryTransactions", "description": "Relate 'InventoryTransaction' record though the 'inventoryTransactions' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "ReceiptOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of InventoryTransaction record." } } } } } }, "summary": "Unrelate ReceiptOrder . inventoryTransactions", "description": "Unrelate 'InventoryTransaction' record related though the 'inventoryTransactions' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ReceiptOrderItem": { "post": { "tags": [ "ReceiptOrderItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReceiptOrderItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create ReceiptOrderItem", "description": "Create a new 'ReceiptOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReceiptOrderItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "ReceiptOrderItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "receiptOrderId", "receiptOrderName", "accountId", "accountName", "receiptOrderStatus", "productId", "productName", "allowFractionalQuantity", "productType", "quantity", "quantityInt", "quantityReceived", "quantityReceivedInt", "inventoryNumberType", "isInventory", "unitWeight", "weight", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List ReceiptOrderItem", "description": "List ReceiptOrderItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ReceiptOrderItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ReceiptOrderItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "ReceiptOrderItem" ], "summary": "Read ReceiptOrderItem", "description": "Read an existing 'ReceiptOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReceiptOrderItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "ReceiptOrderItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReceiptOrderItem" } } } }, "parameters": [], "summary": "Update ReceiptOrderItem", "description": "Update an existing 'ReceiptOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReceiptOrderItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "ReceiptOrderItem" ], "summary": "Remove ReceiptOrderItem", "description": "Remove an existing 'ReceiptOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ReturnOrder": { "post": { "tags": [ "ReturnOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReturnOrder_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create ReturnOrder", "description": "Create a new 'ReturnOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReturnOrder" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "ReturnOrder" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "completed" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "status", "dateOrdered", "deliveryDate", "accountId", "accountName", "salesOrderId", "salesOrderName", "description", "warehouseId", "warehouseName", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressCountry", "billingAddressPostalCode", "shippingAddressStreet", "shippingAddressCity", "shippingAddressState", "shippingAddressCountry", "shippingAddressPostalCode", "fromAddressStreet", "fromAddressCity", "fromAddressState", "fromAddressCountry", "fromAddressPostalCode", "billingContactId", "billingContactName", "shippingContactId", "shippingContactName", "taxId", "taxName", "taxRate", "taxCodeId", "taxCodeName", "taxTotals", "shippingProviderId", "shippingProviderName", "shippingCostCurrency", "shippingCost", "shippingAmountCurrency", "shippingAmount", "shippingTaxMode", "taxAmountCurrency", "taxAmount", "discountAmountCurrency", "discountAmount", "amountCurrency", "amount", "preDiscountedAmountCurrency", "preDiscountedAmount", "grandTotalAmountCurrency", "grandTotalAmount", "weight", "itemList", "isTaxInclusive", "isReceiptFullyCreated", "hasInventoryItems", "isDone", "isNotActual", "isLocked", "productsIds", "productsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "billingAddressMap", "shippingAddressMap", "fromAddressMap", "shippingCostConverted", "shippingAmountConverted", "taxAmountConverted", "discountAmountConverted", "amountConverted", "preDiscountedAmountConverted", "grandTotalAmountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List ReturnOrder", "description": "List ReturnOrder records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ReturnOrder" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ReturnOrder\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "ReturnOrder" ], "summary": "Read ReturnOrder", "description": "Read an existing 'ReturnOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReturnOrder" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "ReturnOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReturnOrder" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update ReturnOrder", "description": "Update an existing 'ReturnOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReturnOrder" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "ReturnOrder" ], "summary": "Remove ReturnOrder", "description": "Remove an existing 'ReturnOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ReturnOrder\/{id}\/receiptOrders": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "ReturnOrder" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "completed" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "status", "dateOrdered", "dateReceived", "accountId", "accountName", "supplierId", "supplierName", "purchaseOrderId", "purchaseOrderName", "returnOrderId", "returnOrderName", "warehouseId", "warehouseName", "description", "shippingContactId", "shippingContactName", "shippingProviderId", "shippingProviderName", "shippingCostCurrency", "shippingCost", "amountCurrency", "amount", "amountConverted", "weight", "itemList", "receivedItemList", "isDone", "isNotActual", "isLocked", "isHardLocked", "productsIds", "productsNames", "inventoryNumbersIds", "inventoryNumbersNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "shippingCostConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List ReturnOrder . receiptOrders", "description": "List 'ReceiptOrder' records related through the 'receiptOrders' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ReceiptOrder" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "ReturnOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of ReceiptOrder record." } } } } } }, "summary": "Relate ReturnOrder . receiptOrders", "description": "Relate 'ReceiptOrder' record though the 'receiptOrders' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "ReturnOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of ReceiptOrder record." } } } } } }, "summary": "Unrelate ReturnOrder . receiptOrders", "description": "Unrelate 'ReceiptOrder' record related though the 'receiptOrders' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ReturnOrderItem": { "post": { "tags": [ "ReturnOrderItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReturnOrderItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create ReturnOrderItem", "description": "Create a new 'ReturnOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReturnOrderItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "ReturnOrderItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "returnOrderId", "returnOrderName", "accountId", "accountName", "returnOrderStatus", "productId", "productName", "itemType", "quantity", "quantityInt", "inventoryNumberId", "inventoryNumberName", "inventoryNumberType", "isInventory", "allowFractionalQuantity", "productType", "taxRate", "taxCodeId", "taxCodeName", "taxes", "listPriceCurrency", "listPrice", "unitPriceCurrency", "unitPrice", "discount", "amountCurrency", "amount", "unitWeight", "weight", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "listPriceConverted", "unitPriceConverted", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List ReturnOrderItem", "description": "List ReturnOrderItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ReturnOrderItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/ReturnOrderItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "ReturnOrderItem" ], "summary": "Read ReturnOrderItem", "description": "Read an existing 'ReturnOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReturnOrderItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "ReturnOrderItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReturnOrderItem" } } } }, "parameters": [], "summary": "Update ReturnOrderItem", "description": "Update an existing 'ReturnOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReturnOrderItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "ReturnOrderItem" ], "summary": "Remove ReturnOrderItem", "description": "Remove an existing 'ReturnOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SalesOrder": { "post": { "tags": [ "SalesOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SalesOrder_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create SalesOrder", "description": "Create a new 'SalesOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SalesOrder" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "SalesOrder" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "completed" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "status", "dateOrdered", "dateInvoiced", "accountId", "accountName", "opportunityId", "opportunityName", "quoteId", "quoteName", "description", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressCountry", "billingAddressPostalCode", "shippingAddressStreet", "shippingAddressCity", "shippingAddressState", "shippingAddressCountry", "shippingAddressPostalCode", "billingContactId", "billingContactName", "shippingContactId", "shippingContactName", "paymentTermsProfileId", "paymentTermsProfileName", "taxId", "taxName", "taxRate", "taxCodeId", "taxCodeName", "taxTotals", "shippingProviderId", "shippingProviderName", "shippingCostCurrency", "shippingCost", "shippingAmountCurrency", "shippingAmount", "shippingTaxMode", "taxAmountCurrency", "taxAmount", "discountAmountCurrency", "discountAmount", "amountCurrency", "amount", "preDiscountedAmountCurrency", "preDiscountedAmount", "grandTotalAmountCurrency", "grandTotalAmount", "buyerReference", "purchaseOrderReference", "weight", "itemList", "priceBookId", "priceBookName", "isTaxInclusive", "isDone", "isNotActual", "isLocked", "isHardLocked", "inventoryQuantityMaps", "inventoryData", "inventoryStatus", "isDeliveryCreated", "hasInventoryItems", "isDeliverable", "productsIds", "productsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "billingAddressMap", "shippingAddressMap", "shippingCostConverted", "shippingAmountConverted", "taxAmountConverted", "discountAmountConverted", "amountConverted", "preDiscountedAmountConverted", "grandTotalAmountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List SalesOrder", "description": "List SalesOrder records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SalesOrder" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SalesOrder\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "SalesOrder" ], "summary": "Read SalesOrder", "description": "Read an existing 'SalesOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SalesOrder" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "SalesOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SalesOrder" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update SalesOrder", "description": "Update an existing 'SalesOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SalesOrder" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "SalesOrder" ], "summary": "Remove SalesOrder", "description": "Remove an existing 'SalesOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SalesOrder\/{id}\/inventoryTransactions": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "SalesOrder" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "type", "number", "parentId", "parentType", "parentName", "quantity", "productId", "productName", "warehouseId", "warehouseName", "inventoryNumberId", "inventoryNumberName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List SalesOrder . inventoryTransactions", "description": "List 'InventoryTransaction' records related through the 'inventoryTransactions' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InventoryTransaction" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "SalesOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of InventoryTransaction record." } } } } } }, "summary": "Relate SalesOrder . inventoryTransactions", "description": "Relate 'InventoryTransaction' record though the 'inventoryTransactions' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "SalesOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of InventoryTransaction record." } } } } } }, "summary": "Unrelate SalesOrder . inventoryTransactions", "description": "Unrelate 'InventoryTransaction' record related though the 'inventoryTransactions' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SalesOrderItem": { "post": { "tags": [ "SalesOrderItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SalesOrderItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create SalesOrderItem", "description": "Create a new 'SalesOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SalesOrderItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "SalesOrderItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "salesOrderId", "salesOrderName", "accountId", "accountName", "salesOrderStatus", "productId", "productName", "allowFractionalQuantity", "productType", "itemType", "quantity", "quantityInt", "listPriceCurrency", "listPrice", "unitPriceCurrency", "unitPrice", "discount", "amountCurrency", "amount", "inventoryNumberType", "isInventory", "unitWeight", "weight", "taxRate", "taxCodeId", "taxCodeName", "taxes", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "listPriceConverted", "unitPriceConverted", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List SalesOrderItem", "description": "List SalesOrderItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SalesOrderItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SalesOrderItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "SalesOrderItem" ], "summary": "Read SalesOrderItem", "description": "Read an existing 'SalesOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SalesOrderItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "SalesOrderItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SalesOrderItem" } } } }, "parameters": [], "summary": "Update SalesOrderItem", "description": "Update an existing 'SalesOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SalesOrderItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "SalesOrderItem" ], "summary": "Remove SalesOrderItem", "description": "Remove an existing 'SalesOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Subscription": { "post": { "tags": [ "Subscription" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Subscription_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create Subscription", "description": "Create a new 'Subscription' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Subscription" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Subscription" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "active" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "accountId", "accountName", "billingContactId", "billingContactName", "priceBookId", "priceBookName", "isTaxInclusive", "paymentMethodId", "paymentMethodName", "billingPlanId", "billingPlanName", "interval", "alignmentType", "createPaymentRequests", "sendPaymentRequests", "sendInvoices", "primaryProductId", "primaryProductName", "status", "billingState", "endDate", "amountCurrency", "amount", "productsIds", "productsNames", "templateId", "templateName", "templateHasTrial", "startDate", "hasTrial", "intervalUnit", "buyerReference", "purchaseOrderReference", "itemList", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "description", "hasPaymentMethod", "lastPeriodEndDate", "anchorDay", "taxId", "taxName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List Subscription", "description": "List Subscription records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Subscription" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Subscription\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Subscription" ], "summary": "Read Subscription", "description": "Read an existing 'Subscription' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Subscription" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Subscription" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Subscription" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update Subscription", "description": "Update an existing 'Subscription' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Subscription" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Subscription" ], "summary": "Remove Subscription", "description": "Remove an existing 'Subscription' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SubscriptionItem": { "post": { "tags": [ "SubscriptionItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubscriptionItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create SubscriptionItem", "description": "Create a new 'SubscriptionItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubscriptionItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "SubscriptionItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "subscriptionId", "subscriptionName", "subscriptionUpdateId", "subscriptionUpdateName", "subscriptionStatus", "accountId", "accountName", "productId", "productName", "allowFractionalQuantity", "productType", "quantity", "quantityInt", "unitPriceCurrency", "unitPrice", "amountCurrency", "amount", "inventoryNumberType", "isInventory", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "unitPriceConverted", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List SubscriptionItem", "description": "List SubscriptionItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SubscriptionItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SubscriptionItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "SubscriptionItem" ], "summary": "Read SubscriptionItem", "description": "Read an existing 'SubscriptionItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubscriptionItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "SubscriptionItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubscriptionItem" } } } }, "parameters": [], "summary": "Update SubscriptionItem", "description": "Update an existing 'SubscriptionItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubscriptionItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "SubscriptionItem" ], "summary": "Remove SubscriptionItem", "description": "Remove an existing 'SubscriptionItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Supplier": { "post": { "tags": [ "Supplier" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Supplier_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create Supplier", "description": "Create a new 'Supplier' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Supplier" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Supplier" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "active" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "description", "accountId", "accountName", "status", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressPostalCode", "billingAddressCountry", "isLocked", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List Supplier", "description": "List Supplier records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Supplier" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Supplier\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Supplier" ], "summary": "Read Supplier", "description": "Read an existing 'Supplier' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Supplier" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Supplier" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Supplier" } } } }, "parameters": [], "summary": "Update Supplier", "description": "Update an existing 'Supplier' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Supplier" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Supplier" ], "summary": "Remove Supplier", "description": "Remove an existing 'Supplier' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SupplierBill": { "post": { "tags": [ "SupplierBill" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierBill_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create SupplierBill", "description": "Create a new 'SupplierBill' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierBill" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "SupplierBill" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "paid", "openIssued", "issued" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "numberDraftA", "status", "reference", "dateInvoiced", "dateDue", "postingDate", "accountId", "accountName", "supplierId", "supplierName", "supplierAddressStreet", "supplierAddressCity", "supplierAddressState", "supplierAddressCountry", "supplierAddressPostalCode", "purchaseOrderId", "purchaseOrderName", "billingContactId", "billingContactName", "taxId", "taxName", "taxRate", "taxCodeId", "taxCodeName", "taxTotals", "shippingProviderId", "shippingProviderName", "shippingCostCurrency", "shippingCost", "shippingAmountCurrency", "shippingAmount", "shippingTaxMode", "taxAmountCurrency", "taxAmount", "amountCurrency", "amount", "grandTotalAmountCurrency", "grandTotalAmount", "amountDueCurrency", "amountDue", "amountDueConverted", "amountLocalCurrency", "amountLocal", "grandTotalAmountLocal", "shippingAmountLocal", "taxAmountLocal", "currencyRate", "itemList", "isDone", "isNotActual", "isIssued", "wasIssued", "issuedById", "issuedByName", "issuedAt", "isLocked", "productsIds", "productsNames", "documentId", "documentName", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "supplierAddressMap", "shippingCostConverted", "shippingAmountConverted", "taxAmountConverted", "amountConverted", "grandTotalAmountConverted", "amountLocalConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List SupplierBill", "description": "List SupplierBill records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SupplierBill" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SupplierBill\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "SupplierBill" ], "summary": "Read SupplierBill", "description": "Read an existing 'SupplierBill' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierBill" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "SupplierBill" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierBill" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update SupplierBill", "description": "Update an existing 'SupplierBill' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierBill" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "SupplierBill" ], "summary": "Remove SupplierBill", "description": "Remove an existing 'SupplierBill' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SupplierBillItem": { "post": { "tags": [ "SupplierBillItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierBillItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create SupplierBillItem", "description": "Create a new 'SupplierBillItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierBillItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "SupplierBillItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "supplierBillId", "supplierBillName", "supplierBillStatus", "dateInvoiced", "postingDate", "productId", "productName", "allowFractionalQuantity", "productType", "itemType", "quantity", "quantityInt", "unitPriceCurrency", "unitPrice", "amountCurrency", "amount", "inventoryNumberType", "taxRate", "taxCodeId", "taxCodeName", "taxes", "unitPriceNet", "amountLocal", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "unitPriceConverted", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List SupplierBillItem", "description": "List SupplierBillItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SupplierBillItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SupplierBillItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "SupplierBillItem" ], "summary": "Read SupplierBillItem", "description": "Read an existing 'SupplierBillItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierBillItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "SupplierBillItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierBillItem" } } } }, "parameters": [], "summary": "Update SupplierBillItem", "description": "Update an existing 'SupplierBillItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierBillItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "SupplierBillItem" ], "summary": "Remove SupplierBillItem", "description": "Remove an existing 'SupplierBillItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SupplierCredit": { "post": { "tags": [ "SupplierCredit" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierCredit_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create SupplierCredit", "description": "Create a new 'SupplierCredit' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierCredit" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "SupplierCredit" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "resolved", "openIssued", "issued" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "numberDraftA", "status", "reference", "dateIssued", "dateDue", "postingDate", "accountId", "accountName", "supplierId", "supplierName", "supplierAddressStreet", "supplierAddressCity", "supplierAddressState", "supplierAddressCountry", "supplierAddressPostalCode", "supplierBillId", "supplierBillName", "billingContactId", "billingContactName", "taxId", "taxName", "taxRate", "taxCodeId", "taxCodeName", "taxTotals", "shippingProviderId", "shippingProviderName", "shippingCostCurrency", "shippingCost", "shippingAmountCurrency", "shippingAmount", "shippingTaxMode", "taxAmountCurrency", "taxAmount", "amountCurrency", "amount", "grandTotalAmountCurrency", "grandTotalAmount", "amountDueCurrency", "amountDue", "amountDueConverted", "amountAllocationSubtracted", "amountLocalCurrency", "amountLocal", "grandTotalAmountLocal", "shippingAmountLocal", "taxAmountLocal", "currencyRate", "itemList", "allocations", "unallocatedAmountCurrency", "unallocatedAmount", "unallocatedAmountConverted", "isDone", "isNotActual", "isIssued", "wasIssued", "issuedById", "issuedByName", "issuedAt", "isLocked", "productsIds", "productsNames", "documentId", "documentName", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "supplierAddressMap", "shippingCostConverted", "shippingAmountConverted", "taxAmountConverted", "amountConverted", "grandTotalAmountConverted", "amountLocalConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List SupplierCredit", "description": "List SupplierCredit records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SupplierCredit" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SupplierCredit\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "SupplierCredit" ], "summary": "Read SupplierCredit", "description": "Read an existing 'SupplierCredit' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierCredit" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "SupplierCredit" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierCredit" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update SupplierCredit", "description": "Update an existing 'SupplierCredit' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierCredit" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "SupplierCredit" ], "summary": "Remove SupplierCredit", "description": "Remove an existing 'SupplierCredit' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SupplierCreditItem": { "post": { "tags": [ "SupplierCreditItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierCreditItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create SupplierCreditItem", "description": "Create a new 'SupplierCreditItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierCreditItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "SupplierCreditItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "supplierCreditId", "supplierCreditName", "supplierCreditStatus", "dateIssued", "postingDate", "productId", "productName", "allowFractionalQuantity", "productType", "itemType", "quantity", "quantityInt", "unitPriceCurrency", "unitPrice", "amountCurrency", "amount", "inventoryNumberType", "taxRate", "taxCodeId", "taxCodeName", "taxes", "unitPriceNet", "amountLocal", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "unitPriceConverted", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List SupplierCreditItem", "description": "List SupplierCreditItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SupplierCreditItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SupplierCreditItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "SupplierCreditItem" ], "summary": "Read SupplierCreditItem", "description": "Read an existing 'SupplierCreditItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierCreditItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "SupplierCreditItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierCreditItem" } } } }, "parameters": [], "summary": "Update SupplierCreditItem", "description": "Update an existing 'SupplierCreditItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierCreditItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "SupplierCreditItem" ], "summary": "Remove SupplierCreditItem", "description": "Remove an existing 'SupplierCreditItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SupplierProductPrice": { "post": { "tags": [ "SupplierProductPrice" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierProductPrice_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create SupplierProductPrice", "description": "Create a new 'SupplierProductPrice' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierProductPrice" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "SupplierProductPrice" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "active" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "description", "supplierId", "supplierName", "status", "productId", "productName", "partNumber", "minQuantity", "priceCurrency", "price", "dateStart", "dateEnd", "timeline", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "priceConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List SupplierProductPrice", "description": "List SupplierProductPrice records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SupplierProductPrice" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/SupplierProductPrice\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "SupplierProductPrice" ], "summary": "Read SupplierProductPrice", "description": "Read an existing 'SupplierProductPrice' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierProductPrice" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "SupplierProductPrice" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierProductPrice" } } } }, "parameters": [], "summary": "Update SupplierProductPrice", "description": "Update an existing 'SupplierProductPrice' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SupplierProductPrice" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "SupplierProductPrice" ], "summary": "Remove SupplierProductPrice", "description": "Remove an existing 'SupplierProductPrice' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TransferOrder": { "post": { "tags": [ "TransferOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransferOrder_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create TransferOrder", "description": "Create a new 'TransferOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransferOrder" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "TransferOrder" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "completed" ] }, "description": "A primary filter." }, { "name": "boolFilterList", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] } }, "style": "deepObject", "explode": true, "description": "Bool filters." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "status", "dateOrdered", "shippingDate", "deliveryDate", "description", "fromWarehouseId", "fromWarehouseName", "toWarehouseId", "toWarehouseName", "fromAddressStreet", "fromAddressCity", "fromAddressState", "fromAddressCountry", "fromAddressPostalCode", "toAddressStreet", "toAddressCity", "toAddressState", "toAddressCountry", "toAddressPostalCode", "shippingProviderId", "shippingProviderName", "shippingCostCurrency", "shippingCost", "amountCurrency", "amount", "amountConverted", "weight", "itemList", "inventoryQuantityMaps", "inventoryData", "inventoryStatus", "isDone", "isNotActual", "isLocked", "isHardLocked", "productsIds", "productsNames", "inventoryNumbersIds", "inventoryNumbersNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "fromAddressMap", "toAddressMap", "shippingCostConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List TransferOrder", "description": "List TransferOrder records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TransferOrder" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TransferOrder\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "TransferOrder" ], "summary": "Read TransferOrder", "description": "Read an existing 'TransferOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransferOrder" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "TransferOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransferOrder" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update TransferOrder", "description": "Update an existing 'TransferOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransferOrder" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "TransferOrder" ], "summary": "Remove TransferOrder", "description": "Remove an existing 'TransferOrder' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TransferOrder\/{id}\/inventoryTransactions": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "TransferOrder" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "type", "number", "parentId", "parentType", "parentName", "quantity", "productId", "productName", "warehouseId", "warehouseName", "inventoryNumberId", "inventoryNumberName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List TransferOrder . inventoryTransactions", "description": "List 'InventoryTransaction' records related through the 'inventoryTransactions' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InventoryTransaction" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "TransferOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of InventoryTransaction record." } } } } } }, "summary": "Relate TransferOrder . inventoryTransactions", "description": "Relate 'InventoryTransaction' record though the 'inventoryTransactions' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "TransferOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of InventoryTransaction record." } } } } } }, "summary": "Unrelate TransferOrder . inventoryTransactions", "description": "Unrelate 'InventoryTransaction' record related though the 'inventoryTransactions' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TransferOrder\/{id}\/items": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "TransferOrder" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "transferOrderId", "transferOrderName", "transferOrderStatus", "productId", "productName", "allowFractionalQuantity", "productType", "quantity", "quantityInt", "inventoryNumberId", "inventoryNumberName", "inventoryNumberType", "isInventory", "quantityReceived", "quantityReceivedInt", "unitWeight", "weight", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List TransferOrder . items", "description": "List 'TransferOrderItem' records related through the 'items' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TransferOrderItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "TransferOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TransferOrderItem record." } } } } } }, "summary": "Relate TransferOrder . items", "description": "Relate 'TransferOrderItem' record though the 'items' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "TransferOrder" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TransferOrderItem record." } } } } } }, "summary": "Unrelate TransferOrder . items", "description": "Unrelate 'TransferOrderItem' record related though the 'items' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TransferOrderItem": { "post": { "tags": [ "TransferOrderItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransferOrderItem_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create TransferOrderItem", "description": "Create a new 'TransferOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransferOrderItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "TransferOrderItem" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "transferOrderId", "transferOrderName", "transferOrderStatus", "productId", "productName", "allowFractionalQuantity", "productType", "quantity", "quantityInt", "inventoryNumberId", "inventoryNumberName", "inventoryNumberType", "isInventory", "quantityReceived", "quantityReceivedInt", "unitWeight", "weight", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List TransferOrderItem", "description": "List TransferOrderItem records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TransferOrderItem" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TransferOrderItem\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "TransferOrderItem" ], "summary": "Read TransferOrderItem", "description": "Read an existing 'TransferOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransferOrderItem" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "TransferOrderItem" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransferOrderItem" } } } }, "parameters": [], "summary": "Update TransferOrderItem", "description": "Update an existing 'TransferOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransferOrderItem" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "TransferOrderItem" ], "summary": "Remove TransferOrderItem", "description": "Remove an existing 'TransferOrderItem' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/WriteOffEntry": { "post": { "tags": [ "WriteOffEntry" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WriteOffEntry_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "summary": "Create WriteOffEntry", "description": "Create a new 'WriteOffEntry' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WriteOffEntry" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "WriteOffEntry" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "description": "A pagination offset." }, { "name": "maxSize", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "The maximum number of records to return." }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "description": "An attribute (field) to order by." }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "An order direction." }, { "name": "textFilter", "in": "query", "schema": { "type": "string" }, "description": "A text filter query. Wildcard (*) is supported." }, { "name": "primaryFilter", "in": "query", "schema": { "type": "string", "enum": [ "actual", "applied", "issued" ] }, "description": "A primary filter." }, { "name": "attributeSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "numberA", "numberDraftA", "status", "accountId", "accountName", "date", "postingDate", "amountCurrency", "amount", "isLocked", "isDone", "isNotActual", "isIssued", "wasIssued", "issuedById", "issuedByName", "issuedAt", "unallocatedAmountCurrency", "unallocatedAmount", "unallocatedAmountConverted", "description", "allocations", "teamsIds", "teamsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "amountConverted" ] } }, "style": "form", "explode": false, "description": "Attributes to return. Select only the necessary ones to improve performance." }, { "name": "whereGroup", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, "style": "deepObject", "explode": true, "description": "Where items." } ], "summary": "List WriteOffEntry", "description": "List WriteOffEntry records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WriteOffEntry" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/WriteOffEntry\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "WriteOffEntry" ], "summary": "Read WriteOffEntry", "description": "Read an existing 'WriteOffEntry' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WriteOffEntry" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "WriteOffEntry" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WriteOffEntry" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "summary": "Update WriteOffEntry", "description": "Update an existing 'WriteOffEntry' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WriteOffEntry" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "WriteOffEntry" ], "summary": "Remove WriteOffEntry", "description": "Remove an existing 'WriteOffEntry' record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } } }, "components": { "schemas": { "CreditNote": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "numberDraftA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Issued", "Resolved", "Canceled" ] }, "dateIssued": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "dateDue": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "postingDate": { "type": [ "string", "null" ], "readOnly": true, "format": "date", "description": "A date." }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "invoiceId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Invoice type." }, "invoiceName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "billingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "billingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "isTaxInclusive": { "type": "boolean", "readOnly": false }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "roundingProfileId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the RoundingProfile type." }, "roundingProfileName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Tax type." }, "taxName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "taxAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "taxAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "roundingAmount": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "roundingAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amount": { "readOnly": false, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "shippingCost": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "shippingCostCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "shippingAmount": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "shippingAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "shippingTaxMode": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Proportional", "Fixed" ] }, "grandTotalAmount": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "grandTotalAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amountDue": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountDueCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amountLocal": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountLocalCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "grandTotalAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "shippingAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "taxAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "roundingAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "currencyRate": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "unallocatedAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "unallocatedAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "buyerReference": { "type": [ "string", "null" ], "maxLength": 50, "readOnly": false, "description": "A one-line string." }, "purchaseOrderReference": { "type": [ "string", "null" ], "maxLength": 50, "readOnly": false, "description": "A one-line string." }, "note": { "type": [ "string", "null" ], "maxLength": 4000, "readOnly": false, "description": "A multi-line text." }, "buyerName": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "buyerElectronicAddressScheme": { "type": "string", "readOnly": true }, "buyerElectronicAddressIdentifier": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "buyerTaxNumber": { "type": [ "string", "null" ], "maxLength": 32, "readOnly": true, "description": "A one-line string." }, "sellerName": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "sellerElectronicAddressScheme": { "type": "string", "readOnly": true }, "sellerElectronicAddressIdentifier": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "sellerTaxNumber": { "type": [ "string", "null" ], "maxLength": 32, "readOnly": true, "description": "A one-line string." }, "sellerTaxRegistrationScheme": { "type": "string", "readOnly": true }, "sellerTaxRegistrationIdentifier": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "sellerAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A multi-line text." }, "sellerAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "sellerAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "sellerAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "sellerAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": true, "description": "A one-line string." }, "sellerContactName": { "type": [ "string", "null" ], "maxLength": 150, "readOnly": true, "description": "A one-line string." }, "sellerContactEmailAddress": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "sellerContactPhoneNumber": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isIssued": { "type": "boolean", "readOnly": true }, "wasIssued": { "type": "boolean", "readOnly": true }, "issuedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "issuedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "issuedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "isLocked": { "type": "boolean", "readOnly": true }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "taxAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "roundingAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "shippingCostConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "shippingAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "grandTotalAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountLocalConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "billingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A multi-line text." }, "billingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "billingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "billingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "billingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": true, "description": "A one-line string." } } }, "CreditNote_create": { "$ref": "#\/components\/schemas\/CreditNote", "type": "object" }, "CreditNoteItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "creditNoteId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the CreditNote type." }, "creditNoteName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "creditNoteStatus": { "readOnly": true, "type": [ "string", "null" ] }, "dateIssued": { "readOnly": true, "type": [ "string", "null" ] }, "postingDate": { "readOnly": true, "type": [ "string", "null" ] }, "productId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "quantity": { "type": "number", "readOnly": true }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "unitPrice": { "readOnly": true, "type": "number", "description": "A currency amount." }, "unitPriceCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "taxCodeId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the TaxCode type." }, "taxCodeName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "unitPriceNet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "amountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "taxAmount": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "periodStartDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "periodEndDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "unitPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "CreditNoteItem_create": { "$ref": "#\/components\/schemas\/CreditNoteItem", "type": "object", "required": [ "name", "unitPrice", "unitPriceCurrency" ] }, "DeliveryOrder": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Ready", "In Progress", "Completed", "Canceled", "Failed" ] }, "dateOrdered": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "shippingDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "deliveryDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "salesOrderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the SalesOrder type." }, "salesOrderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "warehouseId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Warehouse type." }, "warehouseName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "shippingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingProviderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ShippingProvider type." }, "shippingProviderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingCost": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "shippingCostCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "inventoryStatus": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Available", "On Hand", "Not Available" ] }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isLocked": { "type": "boolean", "readOnly": true }, "isHardLocked": { "type": "boolean", "readOnly": true }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "inventoryNumbersIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "inventoryNumbersNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "shippingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "shippingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingCostConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "DeliveryOrder_create": { "$ref": "#\/components\/schemas\/DeliveryOrder", "type": "object" }, "DeliveryOrderItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "deliveryOrderId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the DeliveryOrder type." }, "deliveryOrderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "deliveryOrderStatus": { "readOnly": true, "type": [ "string", "null" ] }, "productId": { "type": "string", "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "quantity": { "type": "number", "readOnly": true, "minimum": 0 }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "inventoryNumberId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the InventoryNumber type." }, "inventoryNumberName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "inventoryNumberType": { "readOnly": true, "type": [ "string", "null" ] }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "unitWeight": { "type": [ "number", "null" ], "readOnly": false, "minimum": 0 }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." } } }, "DeliveryOrderItem_create": { "$ref": "#\/components\/schemas\/DeliveryOrderItem", "type": "object", "required": [ "name", "productId" ] }, "InventoryAdjustment": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Started", "Completed", "Canceled" ] }, "reason": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Stocktaking", "Write-off", "Waste", "Shrinkage", "Damage", "Internal" ] }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "warehouseId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Warehouse type." }, "warehouseName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "date": { "type": "string", "readOnly": false, "format": "date", "description": "A date." }, "isLocked": { "type": "boolean", "readOnly": true }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "doneAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "inventoryNumbersIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "inventoryNumbersNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." } } }, "InventoryAdjustment_create": { "$ref": "#\/components\/schemas\/InventoryAdjustment", "type": "object", "required": [ "date" ] }, "InventoryAdjustmentItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "inventoryAdjustmentId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the InventoryAdjustment type." }, "inventoryAdjustmentName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "inventoryAdjustmentStatus": { "readOnly": true, "type": [ "string", "null" ] }, "warehouseId": { "type": [ "string", "null" ], "readOnly": true }, "warehouseName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productId": { "type": "string", "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "quantityOnHand": { "type": [ "number", "null" ], "readOnly": true }, "newQuantityOnHand": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "quantity": { "type": [ "number", "null" ], "readOnly": true }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "inventoryNumberId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the InventoryNumber type." }, "inventoryNumberName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "inventoryNumberType": { "readOnly": true, "type": [ "string", "null" ] }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." } } }, "InventoryAdjustmentItem_create": { "$ref": "#\/components\/schemas\/InventoryAdjustmentItem", "type": "object", "required": [ "name", "productId" ] }, "InventoryNumber": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "number": { "type": "integer", "readOnly": true, "description": "An auto-increment number." }, "type": { "type": "string", "readOnly": false, "enum": [ "Batch", "Serial" ] }, "productId": { "type": "string", "readOnly": false, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "quantityOnHand": { "type": [ "number", "null" ], "readOnly": true }, "quantityReserved": { "type": [ "number", "null" ], "readOnly": true }, "quantityInTransit": { "type": [ "number", "null" ], "readOnly": true }, "quantityWarehouseOnHand": { "type": [ "number", "null" ], "readOnly": true }, "quantityWarehouseReserved": { "type": [ "number", "null" ], "readOnly": true }, "warehousesOnHandIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "warehousesOnHandNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "incomingDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "productionDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "expirationDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." } } }, "InventoryNumber_create": { "$ref": "#\/components\/schemas\/InventoryNumber", "type": "object", "required": [ "name", "productId" ] }, "InventoryTransaction": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "type": { "type": "string", "readOnly": false, "enum": [ "Transfer", "Reserve", "Soft Reserve" ] }, "number": { "type": "integer", "readOnly": true, "description": "An auto-increment number." }, "parentId": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record ID." }, "parentType": { "type": [ "string", "null" ], "readOnly": true, "description": "An entity type." }, "parentName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "quantity": { "type": "number", "readOnly": false }, "productId": { "type": "string", "readOnly": false, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "warehouseId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Warehouse type." }, "warehouseName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "inventoryNumberId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the InventoryNumber type." }, "inventoryNumberName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." } } }, "InventoryTransaction_create": { "$ref": "#\/components\/schemas\/InventoryTransaction", "type": "object", "required": [ "quantity", "productId" ] }, "Invoice": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "numberDraftA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "numberDebitNoteA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Issued", "Paid", "Canceled" ] }, "type": { "type": "string", "readOnly": false, "enum": [ "Invoice", "Debit Note" ] }, "dateInvoiced": { "type": "string", "readOnly": false, "format": "date", "description": "A date." }, "dateDue": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "deliveryDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "periodStartDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "periodEndDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "postingDate": { "type": [ "string", "null" ], "readOnly": true, "format": "date", "description": "A date." }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "opportunityId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Opportunity type." }, "opportunityName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "quoteId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Quote type." }, "quoteName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "salesOrderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the SalesOrder type." }, "salesOrderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "precedingInvoiceId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Invoice type." }, "precedingInvoiceName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "billingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "billingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "shippingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "roundingProfileId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the RoundingProfile type." }, "roundingProfileName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "paymentTermsProfileId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PaymentTermsProfile type." }, "paymentTermsProfileName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "paymentTermsNote": { "type": [ "string", "null" ], "maxLength": 4000, "readOnly": true, "description": "A multi-line text." }, "taxId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Tax type." }, "taxName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "shippingProviderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ShippingProvider type." }, "shippingProviderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingCost": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "shippingCostCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "shippingAmount": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "shippingAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "shippingTaxMode": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Proportional", "Fixed" ] }, "taxAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "taxAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "roundingAmount": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "roundingAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "discountAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "discountAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amount": { "readOnly": false, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "amountDue": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountDueCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "preDiscountedAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "preDiscountedAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "grandTotalAmount": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "grandTotalAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amountLocal": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountLocalCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "grandTotalAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "shippingAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "taxAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "roundingAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "currencyRate": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "priceBookId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PriceBook type." }, "priceBookName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "isTaxInclusive": { "type": "boolean", "readOnly": true }, "buyerReference": { "type": [ "string", "null" ], "maxLength": 50, "readOnly": false, "description": "A one-line string." }, "purchaseOrderReference": { "type": [ "string", "null" ], "maxLength": 50, "readOnly": false, "description": "A one-line string." }, "note": { "type": [ "string", "null" ], "maxLength": 4000, "readOnly": false, "description": "A multi-line text." }, "buyerName": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "buyerElectronicAddressScheme": { "type": "string", "readOnly": true }, "buyerElectronicAddressIdentifier": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "buyerTaxNumber": { "type": [ "string", "null" ], "maxLength": 32, "readOnly": true, "description": "A one-line string." }, "sellerName": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "sellerElectronicAddressScheme": { "type": "string", "readOnly": true }, "sellerElectronicAddressIdentifier": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "sellerTaxNumber": { "type": [ "string", "null" ], "maxLength": 32, "readOnly": true, "description": "A one-line string." }, "sellerTaxRegistrationScheme": { "type": "string", "readOnly": true }, "sellerTaxRegistrationIdentifier": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "sellerAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A multi-line text." }, "sellerAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "sellerAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "sellerAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "sellerAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": true, "description": "A one-line string." }, "sellerContactName": { "type": [ "string", "null" ], "maxLength": 150, "readOnly": true, "description": "A one-line string." }, "sellerContactEmailAddress": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "sellerContactPhoneNumber": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isIssued": { "type": "boolean", "readOnly": true }, "wasIssued": { "type": "boolean", "readOnly": true }, "issuedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "issuedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "issuedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "isLocked": { "type": "boolean", "readOnly": true }, "paymentMethodsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the PaymentMethod type." }, "paymentMethodsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "paymentMethodsColumns": { "type": [ "object", "null" ], "readOnly": false, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "primary": { "type": "boolean" } } } }, "paymentMethodId": { "type": [ "string", "null" ], "readOnly": false }, "paymentMethodName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "overdueDays": { "type": [ "integer", "null" ], "readOnly": true }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "billingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "billingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "shippingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingCostConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "shippingAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "taxAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "roundingAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "discountAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "preDiscountedAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "grandTotalAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountLocalConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "Invoice_create": { "$ref": "#\/components\/schemas\/Invoice", "type": "object", "required": [ "dateInvoiced" ] }, "InvoiceItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "invoiceId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Invoice type." }, "invoiceName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "invoiceStatus": { "readOnly": true, "type": [ "string", "null" ] }, "dateInvoiced": { "readOnly": true, "type": [ "string", "null" ] }, "postingDate": { "readOnly": true, "type": [ "string", "null" ] }, "productId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "quantity": { "type": "number", "readOnly": true }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "listPrice": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "listPriceCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "unitPrice": { "readOnly": true, "type": "number", "description": "A currency amount." }, "unitPriceCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "discount": { "type": [ "number", "null" ], "readOnly": true }, "amount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "unitWeight": { "type": [ "number", "null" ], "readOnly": false, "minimum": 0 }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "taxCodeId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the TaxCode type." }, "taxCodeName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "unitPriceNet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "amountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "taxAmount": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "periodStartDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "periodEndDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "listPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "unitPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "InvoiceItem_create": { "$ref": "#\/components\/schemas\/InvoiceItem", "type": "object", "required": [ "name", "unitPrice", "unitPriceCurrency" ] }, "OpportunityItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "opportunityId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Opportunity type." }, "opportunityName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "quantity": { "type": "number", "readOnly": true }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "listPrice": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "listPriceCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "unitPrice": { "readOnly": true, "type": "number", "description": "A currency amount." }, "unitPriceCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "discount": { "type": [ "number", "null" ], "readOnly": true }, "amount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "opportunityStage": { "readOnly": true, "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "listPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "unitPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "OpportunityItem_create": { "$ref": "#\/components\/schemas\/OpportunityItem", "type": "object", "required": [ "name", "unitPrice", "unitPriceCurrency" ] }, "PaymentEntry": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "numberDraftA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "transactionId": { "type": [ "string", "null" ], "maxLength": 64, "readOnly": false, "description": "A one-line string." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "In Progress", "Paid", "Completed", "Canceled" ] }, "type": { "type": "string", "readOnly": false, "enum": [ "Inbound", "Outbound" ] }, "partyType": { "type": "string", "readOnly": false, "enum": [ "Customer", "Supplier" ] }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "supplierId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Supplier type." }, "supplierName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "datePaid": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "postingDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "methodId": { "type": "string", "readOnly": false, "description": "An ID of the record of the PaymentMethod type." }, "methodName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "amount": { "readOnly": false, "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "amountDue": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountDueCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amountLocal": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountLocalCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "currencyRate": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "isLocked": { "type": "boolean", "readOnly": true }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isIssued": { "type": "boolean", "readOnly": true }, "wasIssued": { "type": "boolean", "readOnly": true }, "issuedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "issuedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "issuedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "unallocatedAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "unallocatedAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "requestId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PaymentRequest type." }, "requestName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountLocalConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "PaymentEntry_create": { "$ref": "#\/components\/schemas\/PaymentEntry", "type": "object", "required": [ "methodId", "amount", "amountCurrency" ] }, "PaymentRequest": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "number": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Pending", "In Progress", "Paid", "Canceled", "Expired" ] }, "methodId": { "type": "string", "readOnly": false, "description": "An ID of the record of the PaymentMethod type." }, "methodName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "paymentUrl": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "expirationDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "amount": { "readOnly": false, "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "invoicesIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Invoice type." }, "invoicesNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "referenceId": { "type": [ "string", "null" ], "maxLength": 36, "readOnly": true, "description": "A one-line string." }, "isLocked": { "type": "boolean", "readOnly": true }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "PaymentRequest_create": { "$ref": "#\/components\/schemas\/PaymentRequest", "type": "object", "required": [ "methodId", "amount", "amountCurrency" ] }, "PriceBook": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "status": { "type": "string", "readOnly": false, "enum": [ "Active", "Inactive" ] }, "parentPriceBookId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PriceBook type." }, "parentPriceBookName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "isDefault": { "type": "boolean", "readOnly": true }, "isTaxInclusive": { "type": "boolean", "readOnly": false }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." } } }, "PriceBook_create": { "$ref": "#\/components\/schemas\/PriceBook", "type": "object", "required": [ "name" ] }, "PriceRule": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "priceBookId": { "type": "string", "readOnly": false, "description": "An ID of the record of the PriceBook type." }, "priceBookName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "target": { "type": "string", "readOnly": false, "enum": [ "Product Category", "All", "Conditional" ] }, "status": { "type": "string", "readOnly": false, "enum": [ "Active", "Inactive" ] }, "productCategoryId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ProductCategory type." }, "productCategoryName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "conditionId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PriceRuleCondition type." }, "conditionName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "minQuantity": { "type": [ "number", "null" ], "readOnly": false }, "basedOn": { "type": "string", "readOnly": false, "enum": [ "Unit", "Price Book", "Supplier", "Cost" ] }, "supplierId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Supplier type." }, "supplierName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "discount": { "type": [ "number", "null" ], "readOnly": false, "maximum": 100 }, "roundingMethod": { "type": "string", "readOnly": false, "enum": [ "Half Up", "Up", "Down" ] }, "roundingFactor": { "type": "number", "readOnly": false, "minimum": 0.001 }, "surcharge": { "type": [ "number", "null" ], "readOnly": false }, "currency": { "type": "string", "readOnly": false }, "dateStart": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "dateEnd": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." } } }, "PriceRule_create": { "$ref": "#\/components\/schemas\/PriceRule", "type": "object", "required": [ "priceBookId" ] }, "Product": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "status": { "type": "string", "readOnly": false, "enum": [ "Available", "Unavailable" ] }, "type": { "type": "string", "readOnly": false, "enum": [ "Regular", "Template", "Variant" ] }, "itemType": { "type": "string", "readOnly": false, "enum": [ "Goods", "Service" ] }, "brandId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ProductBrand type." }, "brandName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "partNumber": { "type": [ "string", "null" ], "maxLength": 50, "readOnly": false, "description": "A one-line string." }, "url": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "categoryId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ProductCategory type." }, "categoryName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "pricingType": { "type": "string", "readOnly": false, "enum": [ "Same as List", "Fixed", "Discount from List", "Markup over Cost", "Profit Margin" ] }, "pricingFactor": { "type": [ "number", "null" ], "readOnly": false }, "costPrice": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "costPriceCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "listPrice": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "listPriceCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "unitPrice": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "unitPriceCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "suppliersIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "suppliersNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "unitPriceSelect": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "unitPriceSelectCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "allowFractionalQuantity": { "type": "boolean", "readOnly": false }, "taxClassesIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the TaxClass type." }, "taxClassesNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "quantity": { "type": [ "number", "null" ], "readOnly": true }, "quantityReserved": { "type": [ "number", "null" ], "readOnly": true }, "quantitySoftReserved": { "type": [ "number", "null" ], "readOnly": true }, "quantityOnHand": { "type": [ "number", "null" ], "readOnly": true }, "quantityInTransit": { "type": [ "number", "null" ], "readOnly": true }, "quantityOnOrder": { "type": [ "number", "null" ], "readOnly": true }, "quantityWarehouse": { "type": [ "number", "null" ], "readOnly": true }, "quantityWarehouseOnHand": { "type": [ "number", "null" ], "readOnly": true }, "quantityWarehouseReserved": { "type": [ "number", "null" ], "readOnly": true }, "warehousesOnHandIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "warehousesOnHandNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "weight": { "type": [ "number", "null" ], "readOnly": false, "minimum": 0 }, "isTaxFree": { "type": "boolean", "readOnly": false }, "isSellable": { "type": "boolean", "readOnly": false }, "isPurchasable": { "type": "boolean", "readOnly": false }, "isSubscribable": { "type": "boolean", "readOnly": false }, "isInventory": { "type": "boolean", "readOnly": false }, "inventoryNumberType": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Batch", "Serial" ] }, "expirationDays": { "type": [ "integer", "null" ], "readOnly": false, "minimum": 0 }, "removalStrategy": { "type": "string", "readOnly": false, "enum": [ "FIFO", "FEFO", "LIFO" ] }, "templateId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Product type." }, "templateName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "variantAttributeOptionsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the ProductAttributeOption type." }, "variantAttributeOptionsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "variantAttributeOptionsColumns": { "type": [ "object", "null" ], "readOnly": true, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "color": { "type": "string", "maxLength": 7 } } } }, "variantOrder": { "type": [ "integer", "null" ], "readOnly": true }, "costPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "listPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "unitPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "Product_create": { "$ref": "#\/components\/schemas\/Product", "type": "object", "required": [ "name" ] }, "ProductBrand": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "website": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." } } }, "ProductBrand_create": { "$ref": "#\/components\/schemas\/ProductBrand", "type": "object", "required": [ "name" ] }, "ProductPrice": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "priceBookId": { "type": "string", "readOnly": false, "description": "An ID of the record of the PriceBook type." }, "priceBookName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "status": { "type": "string", "readOnly": false, "enum": [ "Active", "Inactive" ] }, "productId": { "type": "string", "readOnly": false, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "partNumber": { "readOnly": true, "type": [ "string", "null" ] }, "minQuantity": { "type": [ "number", "null" ], "readOnly": false }, "price": { "readOnly": false, "type": "number", "description": "A currency amount." }, "priceCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "interval": { "type": "string", "readOnly": false }, "dateStart": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "dateEnd": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "priceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "ProductPrice_create": { "$ref": "#\/components\/schemas\/ProductPrice", "type": "object", "required": [ "priceBookId", "productId", "price", "priceCurrency" ] }, "PurchaseOrder": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Released", "Completed", "Canceled" ] }, "dateOrdered": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "deliveryDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "supplierId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Supplier type." }, "supplierName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "warehouseId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Warehouse type." }, "warehouseName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "billingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "billingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "shippingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Tax type." }, "taxName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "shippingProviderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ShippingProvider type." }, "shippingProviderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingCost": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "shippingCostCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "shippingAmount": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "shippingAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "shippingTaxMode": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Proportional", "Fixed" ] }, "taxAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "taxAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "discountAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "discountAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amount": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "preDiscountedAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "preDiscountedAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "grandTotalAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "grandTotalAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "isReceiptFullyCreated": { "type": "boolean", "readOnly": true }, "hasInventoryItems": { "type": "boolean", "readOnly": true }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isLocked": { "type": "boolean", "readOnly": true }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "supplierAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "supplierAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "supplierAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "supplierAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "supplierAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "billingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "billingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "shippingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingCostConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "shippingAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "taxAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "discountAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "preDiscountedAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "grandTotalAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "PurchaseOrder_create": { "$ref": "#\/components\/schemas\/PurchaseOrder", "type": "object" }, "PurchaseOrderItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "purchaseOrderId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the PurchaseOrder type." }, "purchaseOrderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "purchaseOrderStatus": { "readOnly": true, "type": [ "string", "null" ] }, "productId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "itemType": { "readOnly": true, "type": [ "string", "null" ] }, "quantity": { "type": "number", "readOnly": true }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "listPrice": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "listPriceCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "unitPrice": { "readOnly": true, "type": "number", "description": "A currency amount." }, "unitPriceCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "discount": { "type": [ "number", "null" ], "readOnly": true }, "amount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "inventoryNumberType": { "readOnly": true, "type": [ "string", "null" ] }, "unitWeight": { "type": [ "number", "null" ], "readOnly": false, "minimum": 0 }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "taxCodeId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the TaxCode type." }, "taxCodeName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "listPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "unitPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "PurchaseOrderItem_create": { "$ref": "#\/components\/schemas\/PurchaseOrderItem", "type": "object", "required": [ "name", "unitPrice", "unitPriceCurrency" ] }, "Quote": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "invoiceNumber": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Presented", "Approved", "Canceled" ] }, "dateQuoted": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "dateOrdered": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "dateInvoiced": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "expirationDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "opportunityId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Opportunity type." }, "opportunityName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "billingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "billingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "shippingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "paymentTermsProfileId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PaymentTermsProfile type." }, "paymentTermsProfileName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Tax type." }, "taxName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "shippingProviderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ShippingProvider type." }, "shippingProviderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingCost": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "shippingCostCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "shippingAmount": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "shippingAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "shippingTaxMode": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Proportional", "Fixed" ] }, "taxAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "taxAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "discountAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "discountAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amount": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "preDiscountedAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "preDiscountedAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "grandTotalAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "grandTotalAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "priceBookId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PriceBook type." }, "priceBookName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "isTaxInclusive": { "type": "boolean", "readOnly": true }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isLocked": { "type": "boolean", "readOnly": true }, "inventoryStatus": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Available", "Not Available" ] }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "billingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "billingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "shippingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingCostConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "shippingAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "taxAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "discountAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "preDiscountedAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "grandTotalAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "Quote_create": { "$ref": "#\/components\/schemas\/Quote", "type": "object" }, "QuoteItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "quoteId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Quote type." }, "quoteName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "quoteStatus": { "readOnly": true, "type": [ "string", "null" ] }, "productId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "quantity": { "type": "number", "readOnly": true }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "listPrice": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "listPriceCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "unitPrice": { "readOnly": true, "type": "number", "description": "A currency amount." }, "unitPriceCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "discount": { "type": [ "number", "null" ], "readOnly": true }, "amount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "inventoryNumberType": { "readOnly": true, "type": [ "string", "null" ] }, "unitWeight": { "type": [ "number", "null" ], "readOnly": false, "minimum": 0 }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "taxCodeId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the TaxCode type." }, "taxCodeName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "listPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "unitPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "QuoteItem_create": { "$ref": "#\/components\/schemas\/QuoteItem", "type": "object", "required": [ "name", "unitPrice", "unitPriceCurrency" ] }, "ReceiptOrder": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Ready", "Completed", "Canceled" ] }, "dateOrdered": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "dateReceived": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "supplierId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Supplier type." }, "supplierName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "purchaseOrderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PurchaseOrder type." }, "purchaseOrderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "returnOrderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ReturnOrder type." }, "returnOrderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "warehouseId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Warehouse type." }, "warehouseName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "shippingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "shippingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingProviderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ShippingProvider type." }, "shippingProviderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingCost": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "shippingCostCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isLocked": { "type": "boolean", "readOnly": true }, "isHardLocked": { "type": "boolean", "readOnly": true }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "inventoryNumbersIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "inventoryNumbersNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "shippingCostConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "ReceiptOrder_create": { "$ref": "#\/components\/schemas\/ReceiptOrder", "type": "object" }, "ReceiptOrderItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "receiptOrderId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the ReceiptOrder type." }, "receiptOrderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "receiptOrderStatus": { "readOnly": true, "type": [ "string", "null" ] }, "productId": { "type": "string", "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "quantity": { "type": "number", "readOnly": true, "minimum": 0 }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "quantityReceived": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "quantityReceivedInt": { "type": [ "integer", "null" ], "readOnly": true }, "inventoryNumberType": { "readOnly": true, "type": [ "string", "null" ] }, "unitWeight": { "type": [ "number", "null" ], "readOnly": false, "minimum": 0 }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." } } }, "ReceiptOrderItem_create": { "$ref": "#\/components\/schemas\/ReceiptOrderItem", "type": "object", "required": [ "name", "productId" ] }, "ReturnOrder": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Released", "Completed", "Canceled" ] }, "dateOrdered": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "deliveryDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "salesOrderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the SalesOrder type." }, "salesOrderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "warehouseId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Warehouse type." }, "warehouseName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "billingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "billingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "shippingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Tax type." }, "taxName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "shippingProviderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ShippingProvider type." }, "shippingProviderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingCost": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "shippingCostCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "shippingAmount": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "shippingAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "shippingTaxMode": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Proportional", "Fixed" ] }, "taxAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "taxAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "discountAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "discountAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amount": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "preDiscountedAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "preDiscountedAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "grandTotalAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "grandTotalAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "isTaxInclusive": { "type": "boolean", "readOnly": false }, "isReceiptFullyCreated": { "type": "boolean", "readOnly": true }, "hasInventoryItems": { "type": "boolean", "readOnly": true }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isLocked": { "type": "boolean", "readOnly": true }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "billingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "billingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "shippingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "fromAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "fromAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "fromAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "fromAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "fromAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingCostConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "shippingAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "taxAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "discountAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "preDiscountedAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "grandTotalAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "ReturnOrder_create": { "$ref": "#\/components\/schemas\/ReturnOrder", "type": "object" }, "ReturnOrderItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "returnOrderId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the ReturnOrder type." }, "returnOrderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "returnOrderStatus": { "readOnly": true, "type": [ "string", "null" ] }, "productId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "itemType": { "readOnly": true, "type": [ "string", "null" ] }, "quantity": { "type": "number", "readOnly": true, "minimum": 0 }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "inventoryNumberId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the InventoryNumber type." }, "inventoryNumberName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "inventoryNumberType": { "readOnly": true, "type": [ "string", "null" ] }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "taxCodeId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the TaxCode type." }, "taxCodeName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "listPrice": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "listPriceCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "unitPrice": { "readOnly": true, "type": "number", "description": "A currency amount." }, "unitPriceCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "discount": { "type": [ "number", "null" ], "readOnly": true }, "amount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "unitWeight": { "type": [ "number", "null" ], "readOnly": false, "minimum": 0 }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "listPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "unitPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "ReturnOrderItem_create": { "$ref": "#\/components\/schemas\/ReturnOrderItem", "type": "object", "required": [ "name", "unitPrice", "unitPriceCurrency" ] }, "SalesOrder": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Ready", "Completed", "Canceled" ] }, "dateOrdered": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "dateInvoiced": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "opportunityId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Opportunity type." }, "opportunityName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "quoteId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Quote type." }, "quoteName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "billingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "billingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "shippingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "paymentTermsProfileId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PaymentTermsProfile type." }, "paymentTermsProfileName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Tax type." }, "taxName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "shippingProviderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ShippingProvider type." }, "shippingProviderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingCost": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "shippingCostCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "shippingAmount": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "shippingAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "shippingTaxMode": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Proportional", "Fixed" ] }, "taxAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "taxAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "discountAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "discountAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amount": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "preDiscountedAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "preDiscountedAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "grandTotalAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "grandTotalAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "buyerReference": { "type": [ "string", "null" ], "maxLength": 50, "readOnly": false, "description": "A one-line string." }, "purchaseOrderReference": { "type": [ "string", "null" ], "maxLength": 50, "readOnly": false, "description": "A one-line string." }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "priceBookId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PriceBook type." }, "priceBookName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "isTaxInclusive": { "type": "boolean", "readOnly": true }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isLocked": { "type": "boolean", "readOnly": true }, "isHardLocked": { "type": "boolean", "readOnly": true }, "inventoryStatus": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Available", "On Hand", "Not Available" ] }, "isDeliveryCreated": { "type": "boolean", "readOnly": true }, "hasInventoryItems": { "type": "boolean", "readOnly": true }, "isDeliverable": { "type": "boolean", "readOnly": true }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "billingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "billingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "shippingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingCostConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "shippingAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "taxAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "discountAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "preDiscountedAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "grandTotalAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "SalesOrder_create": { "$ref": "#\/components\/schemas\/SalesOrder", "type": "object" }, "SalesOrderItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "salesOrderId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the SalesOrder type." }, "salesOrderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "salesOrderStatus": { "readOnly": true, "type": [ "string", "null" ] }, "productId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "itemType": { "readOnly": true, "type": [ "string", "null" ] }, "quantity": { "type": "number", "readOnly": true }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "listPrice": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "listPriceCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "unitPrice": { "readOnly": true, "type": "number", "description": "A currency amount." }, "unitPriceCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "discount": { "type": [ "number", "null" ], "readOnly": true }, "amount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "inventoryNumberType": { "readOnly": true, "type": [ "string", "null" ] }, "unitWeight": { "type": [ "number", "null" ], "readOnly": false, "minimum": 0 }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "taxCodeId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the TaxCode type." }, "taxCodeName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "listPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "unitPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "SalesOrderItem_create": { "$ref": "#\/components\/schemas\/SalesOrderItem", "type": "object", "required": [ "name", "unitPrice", "unitPriceCurrency" ] }, "Subscription": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "billingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "billingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "priceBookId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PriceBook type." }, "priceBookName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "paymentMethodId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PaymentMethod type." }, "paymentMethodName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "billingPlanId": { "type": "string", "readOnly": false, "description": "An ID of the record of the SubscriptionBillingPlan type." }, "billingPlanName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "interval": { "readOnly": true, "type": [ "string", "null" ] }, "alignmentType": { "readOnly": true, "type": [ "string", "null" ] }, "primaryProductId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Product type." }, "primaryProductName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Trial", "Active", "Paused", "Stopped" ] }, "billingState": { "type": "string", "readOnly": true, "enum": [ "Clear", "Due", "Past Due" ] }, "endDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "amount": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "templateId": { "type": [ "string", "null" ], "readOnly": false }, "templateName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "startDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "hasTrial": { "type": "boolean", "readOnly": false }, "intervalUnit": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "M", "Y", "W", "D" ] }, "buyerReference": { "type": [ "string", "null" ], "maxLength": 50, "readOnly": false, "description": "A one-line string." }, "purchaseOrderReference": { "type": [ "string", "null" ], "maxLength": 50, "readOnly": false, "description": "A one-line string." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "anchorDay": { "type": [ "integer", "null" ], "readOnly": false, "minimum": 1, "maximum": 31 }, "taxId": { "type": "string", "readOnly": false, "description": "An ID of the record of the Tax type." }, "taxName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "Subscription_create": { "$ref": "#\/components\/schemas\/Subscription", "type": "object", "required": [ "billingPlanId", "taxId" ] }, "SubscriptionItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "subscriptionId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Subscription type." }, "subscriptionName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "subscriptionUpdateId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the SubscriptionUpdate type." }, "subscriptionUpdateName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "subscriptionStatus": { "readOnly": true, "type": [ "string", "null" ] }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productId": { "type": "string", "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "quantity": { "type": "number", "readOnly": true }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "unitPrice": { "readOnly": true, "type": "number", "description": "A currency amount." }, "unitPriceCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "inventoryNumberType": { "readOnly": true, "type": [ "string", "null" ] }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "unitPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "SubscriptionItem_create": { "$ref": "#\/components\/schemas\/SubscriptionItem", "type": "object", "required": [ "productId", "unitPrice", "unitPriceCurrency" ] }, "Supplier": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "accountId": { "type": "string", "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "status": { "type": "string", "readOnly": false, "enum": [ "Active", "Inactive" ] }, "billingAddressStreet": { "readOnly": true, "type": [ "string", "null" ] }, "billingAddressCity": { "readOnly": true, "type": [ "string", "null" ] }, "billingAddressState": { "readOnly": true, "type": [ "string", "null" ] }, "billingAddressPostalCode": { "readOnly": true, "type": [ "string", "null" ] }, "billingAddressCountry": { "readOnly": true, "type": [ "string", "null" ] }, "isLocked": { "type": "boolean", "readOnly": true }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." } } }, "Supplier_create": { "$ref": "#\/components\/schemas\/Supplier", "type": "object", "required": [ "name", "accountId" ] }, "SupplierBill": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "numberDraftA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Issued", "Paid", "Canceled" ] }, "reference": { "type": [ "string", "null" ], "maxLength": 50, "readOnly": false, "description": "A one-line string." }, "dateInvoiced": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "dateDue": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "postingDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "supplierId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Supplier type." }, "supplierName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "purchaseOrderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the PurchaseOrder type." }, "purchaseOrderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "billingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "billingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Tax type." }, "taxName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "shippingProviderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ShippingProvider type." }, "shippingProviderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingCost": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "shippingCostCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "shippingAmount": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "shippingAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "shippingTaxMode": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Proportional", "Fixed" ] }, "taxAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "taxAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amount": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "grandTotalAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "grandTotalAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amountDue": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountDueCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amountLocal": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountLocalCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "grandTotalAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "shippingAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "taxAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "currencyRate": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isIssued": { "type": "boolean", "readOnly": true }, "wasIssued": { "type": "boolean", "readOnly": true }, "issuedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "issuedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "issuedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "isLocked": { "type": "boolean", "readOnly": true }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "documentId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Attachment type." }, "documentName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "supplierAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "supplierAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "supplierAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "supplierAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "supplierAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingCostConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "shippingAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "taxAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "grandTotalAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountLocalConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "SupplierBill_create": { "$ref": "#\/components\/schemas\/SupplierBill", "type": "object" }, "SupplierBillItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "supplierBillId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the SupplierBill type." }, "supplierBillName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "supplierBillStatus": { "readOnly": true, "type": [ "string", "null" ] }, "dateInvoiced": { "readOnly": true, "type": [ "string", "null" ] }, "postingDate": { "readOnly": true, "type": [ "string", "null" ] }, "productId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "itemType": { "readOnly": true, "type": [ "string", "null" ] }, "quantity": { "type": "number", "readOnly": true }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "unitPrice": { "readOnly": true, "type": "number", "description": "A currency amount." }, "unitPriceCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "inventoryNumberType": { "readOnly": true, "type": [ "string", "null" ] }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "taxCodeId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the TaxCode type." }, "taxCodeName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "unitPriceNet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "amountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "unitPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "SupplierBillItem_create": { "$ref": "#\/components\/schemas\/SupplierBillItem", "type": "object", "required": [ "name", "unitPrice", "unitPriceCurrency" ] }, "SupplierCredit": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "numberDraftA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Issued", "Resolved", "Canceled" ] }, "reference": { "type": [ "string", "null" ], "maxLength": 50, "readOnly": false, "description": "A one-line string." }, "dateIssued": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "dateDue": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "postingDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "supplierId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Supplier type." }, "supplierName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "supplierBillId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the SupplierBill type." }, "supplierBillName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "billingContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "billingContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Tax type." }, "taxName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "shippingProviderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ShippingProvider type." }, "shippingProviderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingCost": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "shippingCostCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "shippingAmount": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "shippingAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "shippingTaxMode": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Proportional", "Fixed" ] }, "taxAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "taxAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amount": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "grandTotalAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "grandTotalAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amountDue": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountDueCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amountLocal": { "readOnly": true, "type": [ "string", "null" ], "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountLocalCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "grandTotalAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "shippingAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "taxAmountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "currencyRate": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "unallocatedAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "unallocatedAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isIssued": { "type": "boolean", "readOnly": true }, "wasIssued": { "type": "boolean", "readOnly": true }, "issuedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "issuedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "issuedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "isLocked": { "type": "boolean", "readOnly": true }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "documentId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Attachment type." }, "documentName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "supplierAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "supplierAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "supplierAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "supplierAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "supplierAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingCostConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "shippingAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "taxAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "grandTotalAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountLocalConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "SupplierCredit_create": { "$ref": "#\/components\/schemas\/SupplierCredit", "type": "object" }, "SupplierCreditItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "supplierCreditId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the SupplierCredit type." }, "supplierCreditName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "supplierCreditStatus": { "readOnly": true, "type": [ "string", "null" ] }, "dateIssued": { "readOnly": true, "type": [ "string", "null" ] }, "postingDate": { "readOnly": true, "type": [ "string", "null" ] }, "productId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "itemType": { "readOnly": true, "type": [ "string", "null" ] }, "quantity": { "type": "number", "readOnly": true }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "unitPrice": { "readOnly": true, "type": "number", "description": "A currency amount." }, "unitPriceCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "amount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "inventoryNumberType": { "readOnly": true, "type": [ "string", "null" ] }, "taxRate": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0, "maximum": 100 }, "taxCodeId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the TaxCode type." }, "taxCodeName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "unitPriceNet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "amountLocal": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "unitPriceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "SupplierCreditItem_create": { "$ref": "#\/components\/schemas\/SupplierCreditItem", "type": "object", "required": [ "name", "unitPrice", "unitPriceCurrency" ] }, "SupplierProductPrice": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "supplierId": { "type": "string", "readOnly": false, "description": "An ID of the record of the Supplier type." }, "supplierName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "status": { "type": "string", "readOnly": false, "enum": [ "Active", "Inactive" ] }, "productId": { "type": "string", "readOnly": false, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "partNumber": { "readOnly": true, "type": [ "string", "null" ] }, "minQuantity": { "type": [ "number", "null" ], "readOnly": false }, "price": { "readOnly": false, "type": "number", "description": "A currency amount." }, "priceCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "dateStart": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "dateEnd": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "priceConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "SupplierProductPrice_create": { "$ref": "#\/components\/schemas\/SupplierProductPrice", "type": "object", "required": [ "supplierId", "productId", "price", "priceCurrency" ] }, "TransferOrder": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Ready", "In Progress", "Completed", "Canceled", "Failed" ] }, "dateOrdered": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "shippingDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "deliveryDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "fromWarehouseId": { "type": "string", "readOnly": false, "description": "An ID of the record of the Warehouse type." }, "fromWarehouseName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "toWarehouseId": { "type": "string", "readOnly": false, "description": "An ID of the record of the Warehouse type." }, "toWarehouseName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingProviderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the ShippingProvider type." }, "shippingProviderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "shippingCost": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "shippingCostCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "amount": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "amountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "inventoryStatus": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Available", "On Hand", "Not Available" ] }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isLocked": { "type": "boolean", "readOnly": true }, "isHardLocked": { "type": "boolean", "readOnly": true }, "productsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "productsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "inventoryNumbersIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false }, "inventoryNumbersNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "fromAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "fromAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "fromAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "fromAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "fromAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "toAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "toAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "toAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "toAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "toAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingCostConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "TransferOrder_create": { "$ref": "#\/components\/schemas\/TransferOrder", "type": "object", "required": [ "fromWarehouseId", "toWarehouseId" ] }, "TransferOrderItem": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "transferOrderId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the TransferOrder type." }, "transferOrderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "transferOrderStatus": { "readOnly": true, "type": [ "string", "null" ] }, "productId": { "type": "string", "readOnly": true, "description": "An ID of the record of the Product type." }, "productName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "productType": { "readOnly": true, "type": [ "string", "null" ] }, "quantity": { "type": "number", "readOnly": true, "minimum": 0 }, "quantityInt": { "type": [ "integer", "null" ], "readOnly": true }, "inventoryNumberId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the InventoryNumber type." }, "inventoryNumberName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "inventoryNumberType": { "readOnly": true, "type": [ "string", "null" ] }, "quantityReceived": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "quantityReceivedInt": { "type": [ "integer", "null" ], "readOnly": true }, "unitWeight": { "type": [ "number", "null" ], "readOnly": false, "minimum": 0 }, "weight": { "type": [ "number", "null" ], "readOnly": true, "minimum": 0 }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." } } }, "TransferOrderItem_create": { "$ref": "#\/components\/schemas\/TransferOrderItem", "type": "object", "required": [ "name", "productId" ] }, "WriteOffEntry": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "number": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "numberA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "numberDraftA": { "type": "string", "readOnly": true, "description": "A number. Auto-incrementing with a prefix." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Applied", "Canceled" ] }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "date": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "postingDate": { "type": [ "string", "null" ], "readOnly": true, "format": "date", "description": "A date." }, "amount": { "readOnly": false, "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$", "description": "A currency amount." }, "amountCurrency": { "type": "string", "enum": [ "USD", "EUR" ], "readOnly": false, "description": "A code." }, "isLocked": { "type": "boolean", "readOnly": true }, "isDone": { "type": "boolean", "readOnly": true }, "isNotActual": { "type": "boolean", "readOnly": true }, "isIssued": { "type": "boolean", "readOnly": true }, "wasIssued": { "type": "boolean", "readOnly": true }, "issuedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "issuedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "issuedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "unallocatedAmount": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "unallocatedAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD", "EUR" ], "readOnly": true, "description": "A code." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "WriteOffEntry_create": { "$ref": "#\/components\/schemas\/WriteOffEntry", "type": "object", "required": [ "amount", "amountCurrency" ] }, "whereItem": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "and", "or", "not", "subQueryNotIn", "subQueryIn", "expression", "in", "notIn", "equals", "notEquals", "on", "notOn", "like", "notLike", "startsWith", "endsWith", "contains", "notContains", "greaterThan", "lessThan", "greaterThanOrEquals", "lessThanOrEquals", "after", "before", "between", "ever", "any", "none", "isNull", "isNotNull", "isTrue", "isFalse", "today", "past", "future", "lastSevenDays", "lastXDays", "nextXDays", "olderThanXDays", "afterXDays", "currentMonth", "nextMonth", "lastMonth", "currentQuarter", "lastQuarter", "currentYear", "lastYear", "currentFiscalYear", "lastFiscalYear", "currentFiscalQuarter", "lastFiscalQuarter", "arrayAnyOf", "arrayNoneOf", "arrayAllOf", "arrayIsEmpty", "arrayIsNotEmpty", "linkedWith", "notLinkedWith", "linkedWithAll", "isLinked", "isNotLinked" ], "description": "An operator." }, "attribute": { "type": "string", "description": "An attribute or field." }, "value": { "oneOf": [ { "type": [ "string", "integer", "number", "boolean", "null" ] }, { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, { "type": "array", "items": { "type": "string" } } ], "description": "A value. A scalar, or an array of strings." }, "dateTime": { "type": "boolean", "description": "Set true for date-time fields." }, "timeZone": { "type": "string", "description": "A time zone. For date-time fields." } }, "required": [ "type" ], "description": "A where item." } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKeyAuth": [] } ], "servers": [ { "url": "{siteUrl}\/api\/v1", "variables": { "siteUrl": { "default": "http:\/\/localhost", "description": "An URL of you Espo instance." } } } ] }