openapi: 3.0.0 info: title: Order Entry description: > Order Entry involves the creation and management of customer orders. Activities related to order entry include managing data related to customer orders, processing order transactions, and running reports on customer orders. version: '1.0' servers: - url: https://api.intacct.com/ia/api/v1-beta2 description: Open Beta tags: - name: Price lists description: >- Order entry price lists contain the sales prices for products or services used in sales transactions. Create a price list and then create the price list entries associated with the list. See [Price lists — Order Entry](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Price_lists/price-lists-OE.htm?TocPath=Applications%7COrder%20Entry%7CSetup%7CPrice%20lists%7C_____1) for more information. x-displayName: Price lists - name: Documents description: >- An order entry document contains information about sales transactions.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Documents - name: Document lines description: >- Line items in a document that represent order entry transactions.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Document lines - name: Document line details description: >- Order Entry document line details
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Document line details - name: Document subtotals description: >- Details of Subtotals, taxes, discounts, charges etc for the transaction.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Document subtotals - name: Document histories description: >- An Order Entry document history contains one entry for each existing transaction in the workflow associated with the selected transaction.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Document histories - name: Transaction definitions description: >- An order entry transaction definition includes the accounting rules, workflow settings, security settings, and other characteristics for a transaction.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definitions - name: Transaction definition additional GL posting account details description: >- Use this for additional GL entry account mapping. When additional posting is enabled for a transaction definition, additional GL posting account mapping is available for the posting configuration of that definition.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition additional GL posting account details - name: Transaction definition account details description: >- If an order entry transaction is posting to either Accounts Receivable or the General Ledger, the the applicable account mapping is defined using this object.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition account details - name: Transaction definition COGS account details description: >- Use this object to set COGS GL account and Inventory account mapping of an order entry transaction definition.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition COGS account details - name: Transaction definition entity details description: >- Specify which entities can create transactions. Also use this object to define different settings for each desired entity; numbering sequences, document templates, and so on.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition entity details - name: Transaction definition inventory total details description: >- Use this object to specify the inventory running total that will be affected by the transaction, whether to track the quantity, value, or both, and whether that amount will increase or decrease when the user saves the transaction.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition inventory total details - name: Transaction definition document conversion details description: >- Specify the transaction definitions from which this transaction can be converted.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition document conversion details - name: Transaction definition subtotal details description: >- Specify the subtotal detail for an Order Entry transaction.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition subtotal details - name: Billing schedules description: >- This object provides order entry billing schedule information, including billing template details.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Billing schedules - name: Price schedules description: >- Price schedules are pricing groups that you can assign to one or more customers.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Price schedules - name: Renewal templates description: >- A renewal template defines a set of actions Sage Intacct will perform when a contract reaches its end date.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Renewal templates - name: Subtotal templates description: >- In a multi-entity organization, subtotal templates enable you to create different sets of subtotals and then refer to them by name within a transaction definition. They simplify setting up and managing transactions definitions.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Subtotal templates paths: /objects/order-entry/price-list: get: summary: List price lists description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each order entry price list. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Price Lists
tags: - Price lists operationId: list-order-entry-price-list responses: '200': description: OK content: application/json: schema: type: object title: List price list objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List price lists: value: ia::result: - key: '1' id: Base Price List href: /objects/order-entry/price-list/1 - key: '2' id: West Coast Price List href: /objects/order-entry/price-list/2 - key: '3' id: Midwest Price List href: /objects/order-entry/price-list/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a price list description: >+ Creates a new order entry price list.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsAdd Price Lists
tags: - Price lists operationId: create-order-entry-price-list requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-price-list' - $ref: '#/components/schemas/order-entry-price-listRequiredProperties' examples: Create a price list: value: id: Base Price List Sales startDate: '2023-01-01' endDate: '2030-12-31' status: active responses: '201': description: Created content: application/json: schema: type: object title: New price list properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New price list: value: ia::result: key: '5' id: Base Price List Sales href: /objects/order-entry/price-list/5 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/price-list/{key}: parameters: - name: key description: System-assigned key for the order entry price list. in: path required: true schema: type: string get: summary: Get a price list description: >+ Returns detailed information for a specified order entry price list.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Price Lists
tags: - Price lists operationId: get-order-entry-price-list-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the price list properties: ia::result: $ref: '#/components/schemas/order-entry-price-list' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a price list: value: ia::result: key: '5' id: Base Price List Sales startDate: '2023-01-01' endDate: '2030-12-31' status: active href: /objects/order-entry/price-list/5 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a price list description: >+ Updates an existing order entry price list by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsEdit Price Lists
tags: - Price lists operationId: update-order-entry-price-list-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-price-list' - type: object properties: id: readOnly: true examples: Update a single value: value: startDate: '2021-01-01' responses: '200': description: OK content: application/json: schema: type: object title: Updated price list properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated price list: value: ia::result: key: '5' id: Base Price List Sales href: /objects/order-entry/price-list/5 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a price list description: >+ Deletes an order entry price list. A price list can be deleted if it has not been assigned to any objects. This removes the price list and all of its associated price list entries from the system.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsDelete Price Lists
tags: - Price lists operationId: delete-order-entry-price-list-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document: get: summary: List documents description: >- Returns a collection with a key, ID, and link for each order entry document. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Documents operationId: list-order-entry-document responses: '200': description: OK content: application/json: schema: type: object title: List of order entry documents properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List documents: value: ia::result: - key: '453' id: Sales Invoice-SUBINV#0182#doc href: /objects/order-entry/document::Sales%20Invoice/453 - key: '442' id: Sales Order-SO0023 href: /objects/order-entry/document::Sales%20Order/442 - key: '446' id: Sales Order-SO0024 href: /objects/order-entry/document::Sales%20Order/446 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the order entry document. get: summary: Get a document description: Returns detailed information for a specified order entry document. tags: - Documents operationId: get-order-entry-document-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order entry document properties: ia::result: $ref: '#/components/schemas/order-entry-document' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document: value: ia::result: key: '453' documentNumber: SUBINV#0182#doc id: Sales Invoice-SUBINV#0182#doc sourceDocument: id: Sales Order-SO0026 key: '451' documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 state: pending transactionDate: '2023-03-29' audit: createdDateTime: '2023-11-10T18:36:30Z' createdBy: '1' modifiedBy: '1' modifiedDateTime: '2023-11-10T18:36:32Z' dueDate: '2024-10-28' documentType: Sales Invoice txnDefinition: id: Sales Invoice key: '188' href: '/objects/order-entry-txn-definition::Sales%20Invoice/188' contacts: primary: key: '304' id: Power Aerospace Materials(C1) shipTo: key: '304' id: Power Aerospace Materials(C1) billTo: key: '304' id: Power Aerospace Materials(C1) isPrinted: false isBackordered: false subTotal: '750.44' total: '742.54' txnCurrency: USD exchangeRate: date: '2023-03-29' rate: '1' subtotalInTxnCurrency: '750.55' totalInTxnCurrency: '742.5' baseCurrency: USD isSystemGeneratedDocument: false postingDate: '2023-03-29' paymentStatus: open customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 lines: - id: '790' key: '790' documentHeader: key: '453' id: Sales Invoice-SUBINV#0182#doc documentType: Sales Invoice href: /objects/order-entry/document::Sales%20Invoice/453 documentType: Sales Invoice lineNumber: 0 dimensions: item: key: '1' id: 1--PC Computer name: PC Computer href: /objects/inventory-control/item/1 warehouse: id: '1' key: '1' href: /objects/inventory-control/warehouse/1 location: id: '1' key: '1' href: /objects/company-config/location/1 customer: key: '1' id: 1--Power Aerospace Materials name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 item: key: '1' id: 1--PC Computer href: /objects/inventory-control/item/1 unit: Each quantity: '1' quantityConverted: '0' retailPrice: '750' price: '742.5' audit: createdDateTime: '2023-03-29T00:00:00Z' modifiedDateTime: '2023-11-10T18:36:30Z' createdBy: '1' modifiedBy: '1' status: active costMethod: standard unitQuantity: '1' multiplier: 1 unitPrice: '750' txnCurrency: USD baseCurrency: USD priceInTxnCurrency: '750' conversionType: quantity allowDropship: false allowBuyToOrder: false quantityRemaining: '1' trackingDetail: [] href: '/objects/order-entry/document-line::Sales%20Invoice/790' history: - id: '382' key: '382' convertedTo: key: '453' id: Sales Invoice-SUBINV#0182#doc documentType: Sales Invoice href: /objects/order-entry/document::Sales%20Invoice/453 convertedFrom: id: Sales Order-SO0026 key: '451' documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 orderEntryDocument: key: '451' id: Sales Order-SO0026 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 href: /objects/order-entry/document-history/382 - id: '380' key: '380' convertedTo: key: '451' id: Sales Order-SO0026 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 orderEntryDocument: key: '451' id: Sales Order-SO0026 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 href: /objects/order-entry/document-history/380 subtotals: - id: '1204' key: '1204' description: Sales Discount absoluteValue: '0' total: '0' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 customer: key: '1' id: 1--Power Aerospace Materials href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '0' txnTotal: '0' documentLine: id: '790' key: '790' documentType: Sales Invoice href: '/objects/order-entry/document-line::Sales%20Invoice/790' audit: createdDateTime: '2023-11-10T18:36:31Z' modifiedDateTime: '2023-11-10T18:36:31Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/1204 - id: '1205' key: '1205' description: Discounted Totals absoluteValue: '7.5' percentValue: '1' total: '7.5' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 customer: key: '1' id: 1--Power Aerospace Materials href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '7.5' txnTotal: '-7.5' documentLine: id: '790' key: '790' documentType: Sales Invoice href: '/objects/order-entry/document-line::Sales%20Invoice/790' audit: createdDateTime: '2023-11-10T18:36:31Z' modifiedDateTime: '2023-11-10T18:36:31Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/1205 - id: '1206' key: '1206' description: Sales Tax absoluteValue: '0' total: '0' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '0' txnTotal: '0' documentLine: id: '790' key: '790' documentType: Sales Invoice href: '/objects/order-entry/document-line::Sales%20Invoice/790' audit: createdDateTime: '2023-11-10T18:36:31Z' modifiedDateTime: '2023-11-10T18:36:31Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/1206 href: /objects/order-entry/document::Sales%20Invoice/453 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document::{documentName}: get: summary: List named documents description: >- Returns a collection with a key, ID, and link for each order entry document with the specified name. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Documents operationId: list-order-entry-named-document responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-document objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List named 'Sales Invoice' documents: value: ia::result: - key: '171' id: Sales Invoice-SUBINV#0147#doc href: /objects/order-entry/document::Sales%20Invoice/171 - key: '172' id: Sales Invoice-SUBINV#0148#doc href: /objects/order-entry/document::Sales%20Invoice/172 - key: '155' id: Sales Invoice-SUBINV#0144#doc href: /objects/order-entry/document::Sales%20Invoice/155 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a document description: Creates a new order entry document. tags: - Documents operationId: create-order-entry-named-document requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-document' - $ref: '#/components/schemas/order-entry-documentRequiredProperties' examples: Create a document: value: customer: id: '1' state: submitted transactionDate: '2023-11-01' dueDate: '2024-12-12' txnCurrency: USD baseCurrency: USD lines: - dimensions: item: id: '1' warehouse: id: '1' location: id: '1' unit: Each unitQuantity: '1' unitPrice: '650' responses: '201': description: Created content: application/json: schema: type: object title: New order entry document properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New document: value: ia::result: key: '13977' id: Sales Invoice-SUBINV#0193#doc documentType: Sales Invoice href: /objects/order-entry/document::Sales%20Invoice/469 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] parameters: - $ref: '#/components/parameters/OrderEntryDocumentName' /objects/order-entry/document::{documentName}/{key}: parameters: - name: key description: System-assigned key for the order entry document. in: path required: true schema: type: string - $ref: '#/components/parameters/OrderEntryDocumentName' get: summary: Get a named document description: Returns detailed information for a specified order entry document. tags: - Documents operationId: get-order-entry-named-document-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order entry document properties: ia::result: $ref: '#/components/schemas/order-entry-document' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a named document: value: ia::result: key: '453' documentNumber: SUBINV#0182#doc id: Sales Invoice-SUBINV#0182#doc sourceDocument: id: Sales Order-SO0026 key: '451' documentType: Sales Order href: /objects/order-entry/document::Sales Order/451 state: pending transactionDate: '2023-03-29' audit: createdDateTime: '2023-11-10T18:36:30Z' createdBy: '1' modifiedBy: '1' modifiedDateTime: '2023-11-10T18:36:32Z' dueDate: '2024-10-28' documentType: Sales Invoice txnDefinition: id: Sales Invoice key: '188' href: '/objects/order-entry-txn-definition::Sales%20Invoice/188' contacts: primary: key: '304' id: Power Aerospace Materials(C1) shipTo: key: '304' id: Power Aerospace Materials(C1) billTo: key: '304' id: Power Aerospace Materials(C1) isPrinted: false isBackordered: false subTotal: '750.66' total: '742.54' txnCurrency: USD exchangeRate: date: '2023-03-29' rate: '1' subtotalInTxnCurrency: '750.55' totalInTxnCurrency: '742.5' baseCurrency: USD isSystemGeneratedDocument: false postingDate: '2023-03-29' paymentStatus: open customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 lines: - id: '790' key: '790' documentHeader: key: '453' id: Sales Invoice-SUBINV#0182#doc documentType: Sales Invoice href: /objects/order-entry/document::Sales%20Invoice/453 documentType: Sales Invoice lineNumber: 0 dimensions: item: key: '1' id: 1--PC Computer name: PC Computer href: /objects/inventory-control/item/1 warehouse: id: '1' key: '1' href: /objects/inventory-control/warehouse/1 location: id: '1' key: '1' href: /objects/company-config/location/1 customer: key: '1' id: 1--Power Aerospace Materials name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 item: key: '1' id: 1--PC Computer href: /objects/inventory-control/item/1 unit: Each quantity: '1' quantityConverted: '0' retailPrice: '750' price: '742.5' audit: createdDateTime: '2023-03-29T00:00:00Z' modifiedDateTime: '2023-11-10T18:36:30Z' createdBy: '1' modifiedBy: '1' status: active costMethod: standard unitQuantity: '1' multiplier: 1 unitPrice: '750' txnCurrency: USD baseCurrency: USD priceInTxnCurrency: '750' conversionType: quantity allowDropship: false allowBuyToOrder: false quantityRemaining: '1' trackingDetail: [] href: '/objects/order-entry/document-line::Sales%20Invoice/790' history: - id: '382' key: '382' convertedTo: key: '453' id: Sales Invoice-SUBINV#0182#doc documentType: Sales Invoice href: /objects/order-entry/document::Sales%20Invoice/453 convertedFrom: id: Sales Order-SO0026 key: '451' documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 orderEntryDocument: key: '451' id: Sales Order-SO0026 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 href: /objects/order-entry/document-history/382 - id: '380' key: '380' convertedTo: key: '451' id: Sales Order-SO0026 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 orderEntryDocument: key: '451' id: Sales Order-SO0026 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 href: /objects/order-entry/document-history/380 subtotals: - id: '1204' key: '1204' description: Sales Discount absoluteValue: '0' total: '0' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 customer: key: '1' id: 1--Power Aerospace Materials href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '0' txnTotal: '0' documentLine: id: '790' key: '790' documentType: Sales Invoice href: '/objects/order-entry/document-line::Sales%20Invoice/790' audit: createdDateTime: '2023-11-10T18:36:31Z' modifiedDateTime: '2023-11-10T18:36:31Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/1204 - id: '1205' key: '1205' description: Discounted Totals absoluteValue: '7.5' percentValue: '1' total: '7.5' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 customer: key: '1' id: 1--Power Aerospace Materials href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '7.5' txnTotal: '7.5' documentLine: id: '790' key: '790' documentType: Sales Invoice href: '/objects/order-entry/document-line::Sales%20Invoice/790' audit: createdDateTime: '2023-11-10T18:36:31Z' modifiedDateTime: '2023-11-10T18:36:31Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/1205 - id: '1206' key: '1206' description: Sales Tax absoluteValue: '0' total: '0' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '0' txnTotal: '0' documentLine: id: '790' key: '790' documentType: Sales Invoice href: '/objects/order-entry/document-line::Sales%20Invoice/790' audit: createdDateTime: '2023-11-10T18:36:31Z' modifiedDateTime: '2023-11-10T18:36:31Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/1206 href: /objects/order-entry/document::Sales%20Invoice/453 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a document description: >- Updates an existing order entry document by setting field values. Any fields not provided remain unchanged. tags: - Documents operationId: update-order-entry-document-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-document' - type: object properties: id: readOnly: true examples: Update a document: value: referenceNumber: '1012' lines: - dimensions: item: key: '15' warehouse: key: '4' location: key: '6' item: key: '15' unit: 10 Pack - key: '22' unitQuantity: '9' price: '750' - key: '59' ia::operation: delete responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-document properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated document: value: ia::result: key: '52' id: Sales Invoice-SUBINV#0182#doc documentType: Sales Invoice href: /objects/order-entry/document::Sales%20Invoice/52 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a document description: Deletes an order entry document. tags: - Documents operationId: delete-order-entry-named-document-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-line: get: summary: List document lines description: >- Returns a collection with a key, ID, and link for each order entry document line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Document lines operationId: list-order-entry-document-line responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-document-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document lines: value: ia::result: - key: '19' id: '19' href: /objects/order-entry/document-line::Sales%20Invoice/19 - key: '24' id: '24' href: /objects/order-entry/document-line::Sales%20Invoice/24 - key: '25' id: '25' href: /objects/order-entry/document-line::Sales%20Quote/25 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-line/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the order entry document line. get: summary: Get a document line description: Returns detailed information for a specified order entry document line. tags: - Document lines operationId: get-order-entry-document-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order-entry-document properties: ia::result: $ref: '#/components/schemas/order-entry-document-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document line: value: ia::result: id: '925' key: '925' documentHeader: key: '599' id: Sales Order-SO0066 documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/599 documentType: Sales Order lineNumber: 0 dimensions: item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 warehouse: id: '1' key: '1' href: /objects/inventory-control/warehouse/1 location: id: '1' key: '1' href: /objects/company-config/location/1 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 item: key: '1' id: '1' href: /objects/inventory-control/item/1 unit: Each quantity: '10' quantityConverted: '1' retailPrice: '222' price: '333' audit: createdDateTime: '2023-12-18T00:00:00Z' modifiedDateTime: '2023-12-18T10:27:15Z' createdBy: '1' modifiedBy: '1' status: active unitQuantity: '1' multiplier: 1 unitPrice: '333' txnCurrency: USD baseCurrency: USD priceInTxnCurrency: '333' conversionType: quantity allowDropship: false allowBuyToOrder: false quantityRemaining: '0' trackingDetail: [] href: /objects/order-entry/document-line::Sales%20Order/925 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-line::{documentName}: get: summary: List named document lines description: >- Returns a collection with a key, ID, and link for each named order entry document line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Document lines operationId: list-order-entry-named-document-line responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-document-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document lines: value: ia::result: - key: '19' id: '19' href: /objects/order-entry/document-line::Sales%20Invoice/19 - key: '24' id: '24' href: /objects/order-entry/document-line::Sales%20Invoice/24 - key: '25' id: '25' href: /objects/order-entry/document-line::Sales%20Quote/25 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a document line description: Creates a new order entry document line. tags: - Document lines operationId: create-order-entry-named-document-line requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-document-line' - $ref: '#/components/schemas/order-entry-document-lineRequiredProperties' examples: Create a document line: value: documentHeader: key: '469' dimensions: item: id: '1' warehouse: id: '1' location: id: '1' unit: Each unitQuantity: '1' unitPrice: '650' responses: '201': description: Created content: application/json: schema: type: object title: New order entry document line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New document line: value: ia::result: key: '807' href: /objects/order-entry/document-line::Sales%20Invoice/807 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] parameters: - $ref: '#/components/parameters/documentName' /objects/order-entry/document-line::{documentName}/{key}: parameters: - name: key description: System-assigned key for the order entry document line. in: path required: true schema: type: string - $ref: '#/components/parameters/documentName' get: summary: Get a named document line description: Returns detailed information for a specified order entry document line. tags: - Document lines operationId: get-order-entry-named-document-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order-entry-document-line properties: ia::result: $ref: '#/components/schemas/order-entry-document-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a named document line: value: ia::result: id: '925' key: '925' documentHeader: key: '599' id: Sales Order-SO0066 documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/599 documentType: Sales Order lineNumber: 0 dimensions: item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 warehouse: id: '1' key: '1' href: /objects/inventory-control/warehouse/1 location: id: '1' key: '1' href: /objects/company-config/location/1 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 item: key: '1' id: '1' href: /objects/inventory-control/item/1 unit: Each quantity: '1' quantityConverted: '1' retailPrice: '222' price: '333' audit: createdDateTime: '2023-12-18T00:00:00Z' modifiedDateTime: '2023-12-18T10:27:15Z' createdBy: '1' modifiedBy: '1' status: active unitQuantity: '1' multiplier: 1 unitPrice: '333' txnCurrency: USD baseCurrency: USD priceInTxnCurrency: '333' conversionType: quantity allowDropship: false allowBuyToOrder: false quantityRemaining: '0' trackingDetail: [] href: /objects/order-entry/document-line::Sales%20Order/925 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a document line description: >- Updates an existing order entry document line by setting field values. Any fields not provided remain unchanged. tags: - Document lines operationId: update-order-entry-named-document-line-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-document-line' - type: object examples: Update a document line: value: unitQuantity: '10' responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-document-line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated document line: value: ia::result: key: '52' href: /objects/order-entry/document-line::Sales%20Invoice/52 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a document line description: Deletes an order entry document line. tags: - Document lines operationId: delete-order-entry-named-document-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-line-detail: get: summary: List document line details description: >- Returns a collection with a key, ID, and link for each Order Entry document line details. tags: - Document line details operationId: list-order-entry-document-line-detail responses: '200': description: OK content: application/json: schema: type: object title: List of document line details properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document line details: value: value: ia::result: - key: '1' id: '1' href: /objects/order-entry/document-line-detail/1 - key: '2' id: '2' href: /objects/order-entry/document-line-detail/2 - key: '3' id: '3' href: /objects/order-entry/document-line-detail/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-line-detail/{key}: parameters: - name: key description: System-assigned unique key for the document line details. in: path required: true schema: type: string get: summary: Get a document line detail description: >- Returns detailed information for a particular Order Entry document line detail. tags: - Document line details operationId: get-order-entry-document-line-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Get a document line detail properties: ia::result: $ref: '#/components/schemas/order-entry-document-line-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document line detail: value: ia::result: id: '11' key: '11' orderEntryDocumentLine: id: '883' key: '883' documentType: Sales Order href: /objects/order-entry-document-line::Sales%20Order/883 item: id: Battery key: '258' href: /objects/item/258 quantity: '1' serialNumber: SLX 728 lotNumber: '1981' aisle: key: '1' id: A1 href: /objects/inventory-control/aisle/1 row: key: '1' id: R1 href: /objects/inventory-control/row/1 bin: key: '1' id: B1 href: /objects/inventory-control/bin/1 expirationDate: '2023-12-31' audit: createdDateTime: '2023-12-14T04:58:04Z' modifiedDateTime: '2023-12-14T04:58:04Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-line-detail/11 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-subtotal: get: summary: List document subtotals description: >- Returns a collection with a key, ID, and link for each Order Entry document subtotals. tags: - Document subtotals operationId: list-order-entry-document-subtotal responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-document-subtotal objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document subtotals: value: ia::result: - key: '13' id: '13' href: /objects/order-entry/document-subtotal/13 - key: '14' id: '14' href: /objects/order-entry/document-subtotal/14 - key: '15' id: '15' href: /objects/order-entry/document-subtotal/15 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-subtotal/{key}: parameters: - name: key description: System-assigned unique key for the document subtotal. in: path required: true schema: type: string get: summary: Get a document subtotal description: >- Returns detailed information for a specified Order Entry document subtotal. tags: - Document subtotals operationId: get-order-entry-document-subtotal-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the Order Entry document subtotal properties: ia::result: $ref: '#/components/schemas/order-entry-document-subtotal' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document subtotal: value: ia::result: id: '307' key: '307' description: Sales Discount absoluteValue: '14.5' percentValue: '1.45' total: '-14.5' isValueEditable: false isPercentEditable: true dimensions: location: key: '36' id: YNK href: /objects/company-config/location/36 department: key: '38' id: Accounting href: /objects/company-config/department/38 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '14.5' txnTotal: '-14.5' documentLine: id: '233' key: '233' documentType: Sales Invoice href: '/objects/order-entry-document-line::Sales%20Invoice/233' documentHeader: key: '21' id: Sales Invoice-SUBINV#0100#doc documentType: Sales Invoice href: /objects/order-entry-document::Sales%20Invoice/21 audit: createdDateTime: '2023-07-11T04:58:20Z' modifiedDateTime: '2023-07-11T04:58:20Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/307 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-history: get: summary: List document histories description: >- Returns a collection with a key, ID, and link for each Order Entry document history. tags: - Document histories operationId: list-order-entry-document-history responses: '200': description: OK content: application/json: schema: type: object title: List document history objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document histories: value: ia::result: - key: '15' id: '15' href: /objects/order-entry/document-history/15 - key: '16' id: '16' href: /objects/order-entry/document-history/16 - key: '17' id: '17' href: /objects/order-entry/document-history/17 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-history/{key}: parameters: - name: key description: System-assigned unique key for the document history. in: path required: true schema: type: string get: summary: Get a document history description: >- Returns detailed information for a specified Order Entry document history. tags: - Document histories operationId: get-order-entry-document-history-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the document history properties: ia::result: $ref: '#/components/schemas/order-entry-document-history' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document history: value: ia::result: id: '411' key: '411' convertedTo: key: '483' id: Sales Invoice-SUBINV#0200#doc documentType: Sales Invoice href: /objects/order-entry-document::Sales%20Invoice/483 convertedFrom: key: '482' id: Sales Order-SO0037 documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/482 orderEntryDocument: key: '482' id: Sales Order-SO0037 documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/482 href: /objects/order-entry/document-history/411 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition: get: summary: List transaction definitions description: >- Returns a collection with a key, ID, and link for each order entry transaction definition. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Transaction definitions operationId: list-order-entry-txn-definition responses: '200': description: OK content: application/json: schema: type: object title: List of transaction definition objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction definitions: value: ia::result: - key: '35' id: Sales Return href: /objects/order-entry/txn-definition/35 - key: '37' id: Sales Invoice href: /objects/order-entry/txn-definition/37 - key: '40' id: Shipper href: /objects/order-entry/txn-definition/40 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a transaction definition description: Creates a new order entry transaction definition. tags: - Transaction definitions operationId: create-order-entry-txn-definition requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition' - $ref: '#/components/schemas/order-entry-txn-definitionRequiredProperties' examples: Create a transaction definition: value: id: Sales Invoice docClass: invoice workflowCategory: invoice description: Sales Invoice editPolicy: all deletePolicy: all enableNumberingSequence: true preserveNumberingSequence: true inheritDocumentNumber: false inventoryUpdateType: 'no' increaseOrDecreaseInventory: decrease txnPostingMethod: noPosting disableTax: false enableFulfillment: false enableReservingAndPicking: false partialConvertMethod: closeOriginalAndCreateBackOrder affectsCost: false overrideExchangeRateType: true overridePrice: true trackDiscountAndSurcharge: false allowDiscountOnExtendedPrice: false requireMemoForDiscount: false enableSubtotals: false showExpandedTaxDetails: false enableOverrideTax: false revrecEnablementType: none renewalEnablementType: generate enableLineItemConversion: true allowRenewConvertedLineOnly: false allowLocationOverride: true allowDepartmentOverride: true xslTemplate: Intacct Sales Invoice fixedMessage: Sales Transaction contactOneTitle: Bill to printBillToContact: true allowEditingBillToContact: false printShipToContact: true contactTwoTitle: Ship to allowEditingShipToContact: false enableWarnOnLowQuantity: false enableCreditLimitCheck: false warehouseSelectionMethod: useTheDefaultWarehouse responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-txn-definition properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New transaction definition: value: ia::result: key: '53' id: '53' href: /objects/order-entry/txn-definition/53 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition/{key}: parameters: - name: key description: System-assigned unique key for the transaction definition. in: path required: true schema: type: string get: summary: Get a transaction definition description: >- Returns detailed information for a specified order entry transaction definition. tags: - Transaction definitions operationId: get-order-entry-txn-definition-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the transaction definition properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition: value: ia::result: key: '63' id: Sales Invoice docClass: invoice workflowCategory: invoice description: Sales Invoice enableUserOrGroupPermmission: false editPolicy: all deletePolicy: all enableNumberingSequence: true documentSequence: id: OE-Doc printTitle: Sales Invoice preserveNumberingSequence: true inheritDocumentNumber: false inventoryUpdateType: 'no' increaseOrDecreaseInventory: decrease txnPostingMethod: noPosting disableTax: false enableFulfillment: false enableReservingAndPicking: false partialConvertMethod: closeOriginalAndCreateBackOrder affectsCost: false exchangeRateType: id: Intacct Daily Rate key: '-1' overrideExchangeRateType: true showBaseCurrency: false initialPriceList: id: Base Price List key: '1' href: /objects/order-entry-price-list/1 overridePrice: true trackDiscountAndSurcharge: false allowDiscountOnExtendedPrice: false requireMemoForDiscount: false freezeRecallValue: false enableSubtotals: false showExpandedTaxDetails: false enableOverrideTax: false revrecEnablementType: none renewalEnablementType: generate enableLineItemConversion: true allowRenewConvertedLineOnly: false allowLocationOverride: true allowDepartmentOverride: true xslTemplate: Intacct Sales Invoice fixedMessage: Sales Transaction contactOneTitle: Bill to printBillToContact: true allowEditingBillToContact: false printShipToContact: true contactTwoTitle: Ship to allowEditingShipToContact: false enableWarnOnLowQuantity: false enableCreditLimitCheck: false warehouseSelectionMethod: useTheDefaultWarehouse warehouse: id: WH02 status: active enablePayments: false postToGL: false requireSupplyOfPrices: false enableCosting: false audit: createdDateTime: '2023-06-27T14:22:49Z' modifiedDateTime: '2023-06-27T14:22:49Z' createdBy: '1' modifiedBy: '1' documentConversionPolicy: newDocumentOrConvert multiEntityRuleForTransaction: topLevelOrEntity enableProjectActualBillings: false lineLevelSimpleTax: false customerVendorEditRule: never enableRetainage: false enableAdditionalInformationScope: false enableAdditionalInformationSchedule: false enableInternalReference: false enableExternalReference: false enableBond: false documentChangeType: noChange reportingCategory: salesOrderInvoices enableContractBilling: false arPostingMethod: none href: /objects/order-entry/txn-definition/63 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition description: > Updates an existing order entry transaction definition by setting field values. Any fields not provided remain unchanged. The changes you make to a transaction definition apply to transactions that are created after the changes are made. The changes do not apply to existing transactions unless you edit and save the transaction after changes are made. tags: - Transaction definitions operationId: update-order-entry-txn-definition-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition' - type: object properties: id: readOnly: true examples: Update a transaction definition: value: showBasecurrency: false canOverridePrice: true recallDocumentDetail: - isDefault: true recallTransactionDefinition: id: Vendor Invoice - key: '57' isDefault: false - key: '59' ia::operation: delete responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated transaction definition: value: ia::result: key: '52' href: /objects/order-entry/txn-definition/52 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition description: Deletes an order entry transaction definition. tags: - Transaction definitions operationId: delete-order-entry-txn-definition-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-additional-gl-detail: get: summary: List additional GL posting account detail objects description: >- Returns a collection with a key, ID, and link for each transaction definition additional GL posting account detail. tags: - Transaction definition additional GL posting account details operationId: list-order-entry-txn-definition-additional-gl-detail responses: '200': description: OK content: application/json: schema: type: object title: List of transaction definition additional GL account details properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction definition additional GL posting account details: value: ia::result: - key: '195' id: '195' href: '/objects/order-entry/txn-definition-additional-gl-detail/195' - key: '196' id: '196' href: '/objects/order-entry/txn-definition-additional-gl-detail/196' ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-additional-gl-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the transaction definition additional GL posting account details. in: path required: true schema: type: string get: summary: Get an additional GL posting account detail object description: >- Returns detailed information for a specified transaction definition additional GL posting account detail object. tags: - Transaction definition additional GL posting account details operationId: get-order-entry-txn-definition-additional-gl-detail-key responses: '200': description: OK content: application/json: schema: type: object title: >- Get a transaction definition additional GL account detail object properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-additional-gl-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition additional GL posting account object: value: ia::result: key: '195' id: '195' order-entry-txn-definition: key: '64' id: Sales Order href: /objects/order-entry-txn-definition/64 itemGLGroup: key: '6' id: Auto GL Group href: /objects/item-gl-group/6 isOffset: false txnType: debit moduleType: additional glAccount: id: '1000' key: '3' href: /objects/gl-account/3 lineNumber: 1 href: '/objects/order-entry/txn-definition-additional-gl-detail/195' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an additional GL posting account detail object description: >- Updates an existing transaction definition additional GL posting account detail object by setting field values. Any fields not provided remain unchanged. tags: - Transaction definition additional GL posting account details operationId: update-order-entry-txn-definition-additional-gl-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-additional-gl-detail' - type: object properties: id: readOnly: true examples: Update an additional GL posting account detail object: value: glAccount: id: '1400' order-entry-txn-definition: key: '64' responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition-additional-gl-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated additional GL posting account detail object: value: ia::result: key: '195' id: '195' href: '/objects/order-entry/txn-definition-additional-gl-detail/195' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an additional GL posting account detail object description: Deletes an additional GL posting account detail object. tags: - Transaction definition additional GL posting account details operationId: delete-order-entry-txn-definition-additional-gl-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-ar-direct-gl-detail: get: summary: List transaction definition account detail objects description: >- Returns a collection with a key, ID, and link for each transaction definition Account Receivable or direct GL account detail object. tags: - Transaction definition account details operationId: list-order-entry-txn-definition-ar-direct-gl-detail responses: '200': description: OK content: application/json: schema: type: object title: List transaction definition account detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction definition account detail objects: value: ia::result: - key: '98' id: '98' href: '/objects/order-entry/txn-definition-ar-direct-gl-detail/98' - key: '163' id: '163' href: '/objects/order-entry/txn-definition-ar-direct-gl-detail/163' - key: '164' id: '164' href: '/objects/order-entry/txn-definition-ar-direct-gl-detail/164' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-ar-direct-gl-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the transaction definition account detail object. in: path required: true schema: type: string get: summary: Get a transaction definition account detail object description: >- Returns detailed information for a specified transaction definition Account Receivable or direct GL account detail object. tags: - Transaction definition account details operationId: get-order-entry-txn-definition-ar-direct-gl-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the transaction definition account detail object properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-ar-direct-gl-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition account detail object: value: ia::result: key: '167' id: '167' order-entry-txn-definition: key: '43' id: Sales Invoice href: /objects/order-entry-txn-definition/43 itemGLGroup: key: '2' id: OS GL Group href: /objects/item-gl-group/2 isOffset: false txnType: credit moduleType: subledger glAccount: id: '4030' key: '69' href: /objects/gl-account/69 lineNumber: 1 href: '/objects/order-entry/txn-definition-ar-direct-gl-detail/167' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition account detail object description: >- Updates an existing transaction definition Account Receivable or direct GL account detail object by setting field values. Any fields not provided remain unchanged. tags: - Transaction definition account details operationId: update-order-entry-txn-definition-ar-direct-gl-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-ar-direct-gl-detail' - type: object properties: id: readOnly: true examples: Update a transaction definition account detail object: value: glAccount: id: '1400' order-entry-txn-definition: key: '64' responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition-ar-direct-gl-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated transaction definition account detail object: value: ia::result: key: '193' id: '193' href: '/objects/order-entry/txn-definition-ar-direct-gl-detail/193' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition account detail object description: >- Delete a transaction definition Account Receivable or direct GL account detail object. tags: - Transaction definition account details operationId: delete-order-entry-txn-definition-ar-direct-gl-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-cogs-gl-detail: get: summary: List transaction definition COGS account detail objects description: >- Returns a collection with a key, ID, and link for each transaction definition COGS GL account and Inventory account detail object. tags: - Transaction definition COGS account details operationId: list-order-entry-txn-definition-cogs-gl-detail responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-txn-definition-cogs-gl-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of costing GL account detail for Order Entry transaction definition: value: ia::result: - key: '159' id: '159' href: /objects/order-entry/txn-definition-cogs-gl-detail/159 - key: '160' id: '160' href: /objects/order-entry/txn-definition-cogs-gl-detail/160 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-cogs-gl-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the transaction definition COGS account detail object. definition. in: path required: true schema: type: string get: summary: Get a transaction definition COGS account detail object description: >- Returns detailed information for a specified transaction definition COGS GL account and Inventory account detail object. tags: - Transaction definition COGS account details operationId: get-order-entry-txn-definition-cogs-gl-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order-entry-txn-definition-cogs-gl-detail properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-cogs-gl-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition COGS account detail object: value: ia::result: key: '160' id: '160' order-entry-txn-definition: key: '43' id: Sales Invoice href: /objects/order-entry-txn-definition/43 itemGLGroup: key: '1' id: HW GL Group href: /objects/item-gl-group/1 txnType: debit moduleType: inventory glAccount: id: '5000' key: '72' href: /objects/gl-account/72 lineNumber: 1 href: /objects/order-entry/txn-definition-cogs-gl-detail/160 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition COGS account detail object description: >- Updates an existing transaction definition COGS GL account and Inventory account detail object by setting field values. Any fields not provided remain unchanged. tags: - Transaction definition COGS account details operationId: update-order-entry-txn-definition-cogs-gl-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-cogs-gl-detail' - type: object properties: id: readOnly: true examples: Updates a transaction definition COGS account detail object: value: glAccount: id: '1400' order-entry-txn-definition: key: '64' responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition-cogs-gl-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated transaction definition COGS account detail object: value: ia::result: key: '191' id: '191' href: /objects/order-entry/txn-definition-cogs-gl-detail/191 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition COGS account detail object description: >- Deletes a transaction definition COGS GL account and Inventory account detail object. tags: - Transaction definition COGS account details operationId: delete-order-entry-txn-definition-cogs-gl-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-entity-setting-detail: get: summary: List transaction definition entity detail objects description: >- Returns a collection with a key, ID, and link for each transaction definition entity detail object. tags: - Transaction definition entity details operationId: list-order-entry-txn-definition-entity-setting-detail responses: '200': description: OK content: application/json: schema: type: object title: List transaction definition entity detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction definition entity detail objects: value: ia::result: - key: '160' id: '160' href: '/objects/order-entry/txn-definition-entity-setting-detail/160' - key: '161' id: '161' href: '/objects/order-entry/txn-definition-entity-setting-detail/161' - key: '162' id: '162' href: '/objects/order-entry/txn-definition-entity-setting-detail/162' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a transaction definition entity detail object description: Creates a new transaction definition entity detail object. tags: - Transaction definition entity details operationId: create-order-entry-txn-definition-entity-setting-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-entity-setting-detail' - $ref: '#/components/schemas/order-entry-txn-definition-entity-setting-detailRequiredProperties' examples: Create a transaction definition entity detail object: value: order-entry-txn-definition: key: '50' entity: id: Mountain Region enableNumberingSequence: false documentSequence: id: AR Inv preserveNumberingSequence: true canInheritSourceDocumentNumber: true enableCreateTransactionRule: true showExpandedTaxDetail: false enableOverrideTax: true enableLineLevelSimpleTax: false responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-txn-definition-entity-setting-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New transaction definition entity detail object: value: ia::result: key: '170' id: '170' href: '/objects/order-entry/txn-definition-entity-setting-detail/170' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-entity-setting-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the transaction definition entity detail object. in: path required: true schema: type: string get: summary: Get a transaction definition entity detail object description: >- Returns detailed information for a specified transaction definition entity detail object. tags: - Transaction definition entity details operationId: get-order-entry-txn-definition-entity-setting-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the transaction definition entity detail object properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-entity-setting-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition entity detail object: value: ia::result: key: '162' id: '162' order-entry-txn-definition: key: '50' id: Sales Return href: /objects/order-entry-txn-definition/50 entity: key: '3' id: Mountain Region href: /objects/entity/3 enableNumberingSequence: false documentSequence: key: '11' id: AR Inv href: /objects/document-sequence-number/11 preserveNumberingSequence: true canInheritSourceDocumentNumber: true enableCreateTransactionRule: true showExpandedTaxDetail: false enableOverrideTax: true enableLineLevelSimpleTax: false href: '/objects/order-entry/txn-definition-entity-setting-detail/162' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition entity detail object description: >- Updates an existing transaction definition entity detail object. Any fields not provided remain unchanged. tags: - Transaction definition entity details operationId: update-order-entry-txn-definition-entity-setting-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-entity-setting-detail' - type: object properties: id: readOnly: true examples: Update a transaction definition entity detail object: value: order-entry-txn-definition: key: '64' enableLineLevelSimpleTax: true responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition-entity-setting-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated transaction definition entity detail object: value: ia::result: key: '174' id: '174' href: '/objects/order-entry/txn-definition-entity-setting-detail/174' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition entity detail object description: Deletes a transaction definition entity detail object. tags: - Transaction definition entity details operationId: delete-order-entry-txn-definition-entity-setting-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-inventory-total-detail: get: summary: List transaction definition inventory total detail objects description: >- Returns a collection with a key, ID, and link for each transaction definition inventory total detail object. tags: - Transaction definition inventory total details operationId: list-order-entry-txn-definition-inventory-total-detail responses: '200': description: OK content: application/json: schema: type: object title: >- List of order-entry-txn-definition-inventory-total-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction definition inventory total detail objects: value: ia::result: - key: '9' id: '9' href: '/objects/order-entry/txn-definition-inventory-total-detail/9' - key: '12' id: '12' href: '/objects/order-entry/txn-definition-inventory-total-detail/12' - key: '14' id: '14' href: '/objects/order-entry/txn-definition-inventory-total-detail/14' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a transaction definition inventory total detail object description: Creates a new transaction definition inventory total detail object. tags: - Transaction definition inventory total details operationId: create-order-entry-txn-definition-inventory-total-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-inventory-total-detail' - $ref: '#/components/schemas/order-entry-txn-definition-inventory-total-detailRequiredProperties' examples: Create a transaction definition inventory total detail object: value: order-entry-txn-definition: key: '64' maintainType: quantity inventoryTotal: id: DAMAGED operation: add responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-txn-definition-inventory-total-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New transaction definition inventory total detail object: value: order-entry-txn-definition: key: '96' inventoryTotal: id: DAMAGED maintainType: quantity operation: add '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-inventory-total-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the transaction definition inventory total detail object. in: path required: true schema: type: string get: summary: Get a transaction definition inventory total detail object description: >- Returns detailed information for a specified transaction definition inventory total detail object. tags: - Transaction definition inventory total details operationId: get-order-entry-txn-definition-inventory-total-detail-key responses: '200': description: OK content: application/json: schema: type: object title: >- Details of the transaction definition inventory total detail object properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-inventory-total-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition inventory total detail object: value: ia::result: key: '125' id: '125' order-entry-txn-definition: key: '64' id: Sales Order href: /objects/order-entry-txn-definition/64 maintainType: quantity inventoryTotal: id: DAMAGED operation: add href: '/objects/order-entry/txn-definition-inventory-total-detail/125' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition inventory total detail object description: >- Updates an existing transaction definition inventory total detail object by setting field values. Any fields not provided remain unchanged. tags: - Transaction definition inventory total details operationId: update-order-entry-txn-definition-inventory-total-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-inventory-total-detail' - type: object properties: id: readOnly: true examples: Update a transaction definition inventory total detail object: value: order-entry-txn-definition: key: '64' operation: subtract responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition-inventory-total-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated transaction definition inventory total detail object: value: ia::result: key: '128' id: '128' href: '/objects/order-entry/txn-definition-inventory-total-detail/128' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition inventory total detail object description: Deletes a transaction definition inventory total detail object. tags: - Transaction definition inventory total details operationId: delete-order-entry-txn-definition-inventory-total-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-source-document-detail: get: summary: List transaction definition document conversion detail objects description: >- Returns a collection with a key, ID, and link for each document conversion detail object. tags: - Transaction definition document conversion details operationId: list-order-entry-txn-definition-source-document-detail responses: '200': description: OK content: application/json: schema: type: object title: List document conversion detail Objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document conversion detail objects: value: ia::result: - key: '23' id: '23' href: '/objects/order-entry/txn-definition-source-document-detail/23' - key: '19' id: '19' href: '/objects/order-entry/txn-definition-source-document-detail/19' - key: '61' id: '61' href: '/objects/order-entry/txn-definition-source-document-detail/61' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a transaction definition document conversion detail object description: Creates a new document conversion detail object. tags: - Transaction definition document conversion details operationId: create-order-entry-txn-definition-source-document-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-source-document-detail' - $ref: '#/components/schemas/order-entry-txn-definition-source-document-detailRequiredProperties' examples: Create a document conversion detail object: value: order-entry-txn-definition: key: '64' sourceDocument: id: Sales Invoice isDefault: false responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-txn-definition-source-document-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New document conversion detail object: value: ia::result: key: '70' id: '70' href: '/objects/order-entry/txn-definition-source-document-detail/70' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-source-document-detail/{key}: parameters: - name: key description: System-assigned unique key for the document conversion detail object. in: path required: true schema: type: string get: summary: Get a transaction definition document conversion detail object description: >- Returns detailed information for a specified document conversion detail object. tags: - Transaction definition document conversion details operationId: get-order-entry-txn-definition-source-document-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Get a transaction definition document conversion detail object properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-source-document-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document conversion detail object: value: ia::result: key: '70' id: '70' order-entry-txn-definition: key: '64' id: Sales Order href: /objects/order-entry-txn-definition/64 sourceDocument: key: '43' id: Sales Invoice href: /objects/order-entry-txn-definition/43 isDefault: true href: '/objects/order-entry/txn-definition-source-document-detail/70' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition document conversion detail object description: >- Updates an existing document conversion detail object by setting field values. Any fields not provided remain unchanged. tags: - Transaction definition document conversion details operationId: update-order-entry-txn-definition-source-document-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-source-document-detail' - type: object properties: id: readOnly: true examples: Update a document conversion detail object: value: order-entry-txn-definition: key: '64' isDefault: true responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition-source-document-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated document conversion detail object: value: ia::result: key: '70' id: '70' href: '/objects/order-entry/txn-definition-source-document-detail/70' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition document conversion detail object description: Deletes a document conversion detail object. tags: - Transaction definition document conversion details operationId: delete-order-entry-txn-definition-source-document-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-subtotal-detail: get: summary: List transaction definition subtotal detail objects description: >- Returns a collection with a key, ID, and link for each transaction definition subtotal detail object. tags: - Transaction definition subtotal details operationId: list-order-entry-txn-definition-subtotal-detail responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-txn-definition-subtotal-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction definition subtotal objects: value: ia::result: - key: '15' id: '15' href: /objects/order-entry/txn-definition-subtotal-detail/15 - key: '19' id: '19' href: /objects/order-entry/txn-definition-subtotal-detail/19 - key: '3' id: '3' href: /objects/order-entry/txn-definition-subtotal-detail/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a transaction definition subtotal detail object description: Creates a new transaction definition subtotal detail object. tags: - Transaction definition subtotal details operationId: create-order-entry-txn-definition-subtotal-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-subtotal-detail' - $ref: '#/components/schemas/order-entry-txn-definition-subtotal-detailRequiredProperties' examples: Creates a new subtotal detail for Order entry transaction definition: value: order-entry-txn-definition: key: '64' subtotalType: discount description: discount appliedToLineNumber: 1 isApportioned: false glAccount: id: '1000' offsetGLAccount: id: '1000.01' valueType: percent txnType: debit isTax: false responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-txn-definition-subtotal-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New transaction definition subtotal detail object: value: ia::result: key: '113' id: '113' href: /objects/order-entry/txn-definition-subtotal-detail/113 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-subtotal-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the transaction definition subtotal detail object. in: path required: true schema: type: string get: summary: Get a transaction definition subtotal detail object description: >- Returns detailed information for a specified transaction definition subtotal detail object. tags: - Transaction definition subtotal details operationId: get-order-entry-txn-definition-subtotal-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the transaction definition subtotal detail object properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-subtotal-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition subtotal detail object: value: ia::result: key: '98' id: '98' order-entry-txn-definition: key: '64' id: Sales Order href: /objects/order-entry-txn-definition/64 subtotalType: discount lineNumber: 0 description: Discount valueType: amount isApportioned: false txnType: debit appliedToLineNumber: 1 isTax: false glAccount: key: '3' id: '1000' href: /objects/gl-account/3 offsetGLAccount: key: '160' id: '1000.01' href: /objects/gl-account/160 enableAvalaraTax: false ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition subtotal detail object description: >- Updates an existing transaction definition subtotal detail object by setting field values. Any fields not provided remain unchanged. tags: - Transaction definition subtotal details operationId: update-order-entry-txn-definition-subtotal-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-subtotal-detail' - type: object properties: id: readOnly: true examples: Update a transaction definition subtotal detail object: value: order-entry-txn-definition: key: '64' subtotalType: discount txnType: credit responses: '200': description: OK content: application/json: schema: type: object title: Updated Order entry transaction definition subtotal details properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated transaction definition subtotal detail object: value: ia::result: key: '94' id: '94' href: /objects/order-entry/txn-definition-subtotal-detail/94 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition subtotal detail object description: Deletes a transaction definition subtotal detail object. tags: - Transaction definition subtotal details operationId: delete-order-entry-txn-definition-subtotal-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/billing-schedule: get: summary: List billing schedules description: >- Returns a collection with a key, ID, and link for each order entry billing schedule. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Billing schedules operationId: list-order-entry-billing-schedule responses: '200': description: OK content: application/json: schema: type: object title: List of billing schedules properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List billing schedules: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/billing-schedule/{key}: parameters: - name: key description: System-assigned unique key for the billing schedule. in: path required: true schema: type: string get: summary: Get a billing schedule description: >- Returns detailed information for a specified order entry billing schedule. tags: - Billing schedules operationId: get-order-entry-billing-schedule-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the billing schedule properties: ia::result: $ref: '#/components/schemas/order-entry-billing-schedule' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a billing schedule: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/price-schedule: get: summary: List price schedules description: >- Returns a collection with a key, ID, and link for each order entry price schedule. tags: - Price schedules operationId: list-order-entry-price-schedule responses: '200': description: OK content: application/json: schema: type: object title: List price-schedules properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List price schedules: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a price schedule description: Creates a new order entry price schedule. tags: - Price schedules operationId: create-order-entry-price-schedule requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-price-schedule' - $ref: '#/components/schemas/order-entry-price-scheduleRequiredProperties' examples: Create a price schedule: {} responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-price-schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New order entry price schedule: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/price-schedule/{key}: parameters: - name: key description: System-assigned unique key for the price schedule. in: path required: true schema: type: string get: summary: Get a price schedule description: Returns detailed information for a specified order entry price schedule. tags: - Price schedules operationId: get-order-entry-price-schedule-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the price schedule properties: ia::result: $ref: '#/components/schemas/order-entry-price-schedule' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a price schedule: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a price schedule description: >- Updates an existing order entry price schedule by setting field values. Any fields not provided remain unchanged. tags: - Price schedules operationId: update-order-entry-price-schedule-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-price-schedule' - type: object properties: id: readOnly: true examples: Update a price schedule: {} responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-price-schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated price schedule: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a price schedule description: Deletes an order entry price schedule. tags: - Price schedules operationId: delete-order-entry-price-schedule-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/renewal-template: get: summary: List renewal templates description: >- Returns a collection with a key, ID, and link for each order entry renewal template. tags: - Renewal templates operationId: list-order-entry-renewal-template responses: '200': description: OK content: application/json: schema: type: object title: List of renewal templates properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List renewal templates: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a renewal template description: Creates a new order entry renewal template. tags: - Renewal templates operationId: create-order-entry-renewal-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-renewal-template' - $ref: '#/components/schemas/order-entry-renewal-templateRequiredProperties' examples: Creates a renewal template: {} responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-renewal-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New renewal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/renewal-template/{key}: parameters: - name: key description: System-assigned unique key for the renewal template. in: path required: true schema: type: string get: summary: Get a renewal template description: >- Returns detailed information for a specified order entry renewal template. tags: - Renewal templates operationId: get-order-entry-renewal-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the renewal template properties: ia::result: $ref: '#/components/schemas/order-entry-renewal-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a renewal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a renewal template description: >- Updates an existing order entry renewal template by setting field values. Any fields not provided remain unchanged. tags: - Renewal templates operationId: update-order-entry-renewal-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-renewal-template' - type: object properties: id: readOnly: true examples: Updates a renewal template: {} responses: '200': description: OK content: application/json: schema: type: object title: Updated renewal template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated renewal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a renewal template description: Deletes an order entry renewal template. tags: - Renewal templates operationId: delete-order-entry-renewal-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/subtotal-template: get: summary: List subtotal templates description: >- Returns a collection with a key, ID, and link for each order entry subtotal template. tags: - Subtotal templates operationId: list-order-entry-subtotal-template responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-subtotal-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List subtotal templates: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a subtotal template description: Creates a new order entry subtotal template. tags: - Subtotal templates operationId: create-order-entry-subtotal-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-subtotal-template' - $ref: '#/components/schemas/order-entry-subtotal-templateRequiredProperties' examples: Creates a subtotal template: {} responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-subtotal-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New order entry subtotal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/subtotal-template/{key}: parameters: - name: key description: System-assigned unique key for the subtotal template. in: path required: true schema: type: string get: summary: Get a subtotal template description: >- Returns detailed information for a specified order entry subtotal template. tags: - Subtotal templates operationId: get-order-entry-subtotal-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the subtotal template properties: ia::result: $ref: '#/components/schemas/order-entry-subtotal-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a subtotal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a subtotal template description: >- Updates an existing order entry subtotal template by setting field values. Any fields not provided remain unchanged. tags: - Subtotal templates operationId: update-order-entry-subtotal-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-subtotal-template' - type: object properties: id: readOnly: true examples: Update a subtotal template: {} responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-subtotal-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated subtotal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a subtotal template description: Deletes an order entry subtotal template. tags: - Subtotal templates operationId: delete-order-entry-subtotal-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] components: schemas: order-entry-price-listRequiredProperties: type: object required: - id object-reference: type: object description: Reference to created or updated object properties: key: type: string example: '12345' id: type: string example: ID123 href: type: string readOnly: true example: /objects///12345 metadata-pages: description: Metadata for collection response type: object properties: totalCount: type: integer description: Total count readOnly: true example: 3 start: type: integer description: Start element number readOnly: true example: 1 pageSize: type: integer description: Page size readOnly: true example: 100 next: type: integer description: Next element number readOnly: true nullable: true example: 101 previous: type: integer description: Previous element number readOnly: true nullable: true example: null error-response: type: object description: Error response properties: ia::result: type: object properties: ia::error: type: object properties: code: type: string example: invalidRequest message: type: string example: Payload contains errors supportId: type: string example: sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ errorId: type: string example: REST-1064 additionalInfo: type: object properties: messageId: type: string example: IA.PAYLOAD_CONTAINS_ERRORS placeholders: type: string propertySet: type: string details: type: array items: type: object properties: code: type: string example: invalidRequest message: type: string example: /testDate is not a valid field errorId: type: string example: REST-1043 target: type: string example: /testDate additionalInfo: type: object properties: messageId: type: string example: IA.NOT_A_VALID_FIELD placeholders: type: string example: FIELD: /testDate propertySet: type: string ia::meta: $ref: '#/components/schemas/metadata' status: type: string description: >- Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. enum: - active - inactive default: active example: active order-entry-price-list: type: object description: >- Order entry price lists contain the sales prices for products or services used in sales transactions. properties: key: type: string description: System-assigned key for the order entry price list. readOnly: true example: '5' id: type: string description: >- Unique name for the price list. If the list is exclusive to a specific customer, include the customer's name in the price list name to easily identify the price list. example: Base Price List Sales href: type: string description: URL for the order entry price list. readOnly: true example: /objects/order-entry/price-list/2 startDate: type: string format: date description: Start date for the time frame in which the price list is effective. example: '2021-01-01' endDate: type: string format: date description: End date for the time frame in which the price list is effective. example: '2100-12-31' status: $ref: '#/components/schemas/status' metadata: description: Metadata for response type: object properties: totalCount: type: integer description: Total count readOnly: true example: 3 totalSuccess: type: integer description: Total success readOnly: true example: 2 totalError: type: integer description: Total errors readOnly: true example: 1 order-entry-documentRequiredProperties: type: object required: - transactionDate properties: customer: required: - id example: IBN lines: type: array items: required: - unit - unitQuantity - unitPrice properties: dimensions: required: - item - warehouse - location example: >- { "item": { "id": "1" }, "warehouse": { "id": "1" }, "location": { "id": "1" }} audit: type: object properties: createdDateTime: description: Time of the submission type: string format: date-time example: '2022-04-20T16:20:00Z' readOnly: true modifiedDateTime: description: Time of the modification type: string format: date-time example: '2022-04-20T16:20:00Z' readOnly: true createdBy: description: User who created this type: string example: '1' readOnly: true nullable: true modifiedBy: description: User who modified this type: string example: '95' readOnly: true nullable: true readOnly: true dimension-ref: type: object properties: location: type: object properties: key: type: string description: Location key example: '22' nullable: true id: type: string description: Location example: LOC-22 nullable: true name: type: string description: Location name readOnly: true example: California nullable: true href: type: string readOnly: true example: /objects/company-config/location/22 department: type: object properties: key: type: string description: Department key example: '11' nullable: true id: type: string description: Department example: DEP-11 nullable: true name: type: string description: Department name readOnly: true example: Sales and Marketing nullable: true href: type: string readOnly: true example: /objects/company-config/department/11 employee: type: object properties: key: type: string description: Employee key example: '10' nullable: true id: type: string description: Employee ID example: EMP-10 nullable: true name: type: string description: Employee name readOnly: true example: Thomas, Glenn nullable: true href: type: string example: /objects/company-config/employee/10 readOnly: true project: type: object properties: key: type: string description: Project key example: '2' nullable: true id: type: string description: Project ID example: NET-XML30-2 nullable: true name: type: string description: Project name readOnly: true example: Talcomp training nullable: true href: type: string readOnly: true example: /objects/projects/project/2 customer: type: object properties: key: type: string description: Customer key example: '13' nullable: true id: type: string description: Customer ID example: CUST-13 nullable: true name: type: string description: Customer name readOnly: true example: Jack In the Box nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/customer/13 vendor: type: object properties: key: type: string description: Vendor key example: '357' nullable: true id: type: string description: Vendor ID example: '1605212096809' nullable: true name: type: string description: Vendor name readOnly: true example: GenLab nullable: true href: type: string readOnly: true example: /objects/accounts-payable/vendor/357 item: type: object properties: key: type: string description: Item key example: '13' nullable: true id: type: string description: Item ID example: Case 13 nullable: true name: type: string description: Item name readOnly: true example: Platform pack nullable: true href: type: string readOnly: true example: /objects/inventory-control/item/13 warehouse: type: object properties: key: type: string description: Warehouse key example: '6' nullable: true id: type: string description: Warehouse ID example: WH01 nullable: true name: type: string description: Warehouse name readOnly: true example: WH01 nullable: true href: type: string readOnly: true example: /objects/inventory-control/warehouse/6 class: type: object properties: key: type: string description: Class key example: '731' nullable: true id: type: string description: Class ID example: REST_CLS_001 nullable: true name: type: string description: Class name readOnly: true example: Enterprises nullable: true href: type: string readOnly: true example: /objects/company-config/class/731 task: type: object properties: id: type: string description: Task ID example: '1' nullable: true key: type: string description: Task key example: '1' nullable: true name: type: string description: Task name readOnly: true example: Project Task nullable: true href: type: string readOnly: true example: /objects/projects/task/1 costType: type: object properties: id: type: string description: Cost Type ID example: '2' nullable: true key: type: string description: Cost Type key example: '2' nullable: true name: type: string description: Cost Type name readOnly: true example: Project Expense nullable: true href: type: string readOnly: true example: /objects/construction/cost-type/2 asset: type: object properties: id: type: string description: Asset ID example: A001 nullable: true key: type: string description: Asset key example: '1' nullable: true name: type: string description: Asset name readOnly: true example: Laptop 1 nullable: true href: type: string readOnly: true example: /objects/fixed-assets/asset/1 contract: type: object properties: id: type: string description: Contract ID example: CON-0045-1 nullable: true key: type: string description: Contract key example: '12' nullable: true name: type: string description: Contract name readOnly: true example: ACME Widgets - Service nullable: true href: type: string readOnly: true example: /objects/contracts/contract/12 order-entry-document-line-detail: type: object description: >- List of warehouse inventory details including serial number, aisle, bin, and row per item. properties: key: type: string description: System-assigned key for the Order Entry document line detail. readOnly: true example: '55' id: type: string description: Order Entry document line details ID. readOnly: true example: '55' href: type: string description: Endpoint for the Order Entry document line detail. readOnly: true example: /objects/order-entry/document-line-detail/55 quantity: type: string format: decimal-precision-10 description: >- The quantity of the units being built for the combination of the tracking attributes specified for the line. example: '10' serialNumber: type: string description: Serial number of the line item. example: S1001 lotNumber: type: string description: >- The lot numbers for the units being built and the quantity being built for each lot example: L1001 expirationDate: type: string description: >- The expiration date for the units being built and the quantity being built. format: date example: '2023-04-04' aisle: type: object description: Aisle associated with the line details. properties: href: type: string description: Endpoint for the aisle. readOnly: true example: /objects/inventory-control/aisle/10 key: type: string description: System-assigned key for the aisle. example: '10' id: type: string description: Aisle ID. example: AISLE1 bin: type: object description: The bin associated with the line details. properties: href: type: string description: Endpoint for the bin. readOnly: true example: /objects/inventory-control/bin/20 key: type: string description: System-assigned key for the bin. example: '20' id: type: string description: Bin ID. example: BIN1 row: type: object description: The row associated with the line details. properties: href: type: string description: Endpoint for the row. readOnly: true example: /objects/inventory-control/row/15 key: type: string description: System-assigned key for the row. example: '15' id: type: string description: Row ID. example: ROW1 item: type: object description: Item associated with the line details. properties: key: type: string description: System-assigned key for the item. example: '10' id: type: string description: Item ID. example: Battery href: type: string description: URL for the item. readOnly: true example: /objects/inventory-control/item/10 audit: $ref: '#/components/schemas/audit' orderEntryDocumentLine: type: object description: Order Entry document line information. readOnly: true properties: key: type: string description: System-assigned key for the Order Entry document line. readOnly: true example: '23' id: type: string description: ID for the document line item. readOnly: true example: '23' documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: URL for the Order Entry document. readOnly: true example: /objects/order-entry-document-line::Sales%20Order/23 order-entry-document-line: description: >- Line items in an Order Entry document that represent Order Entry transactions. type: object properties: key: type: string description: System-assigned key for the Order Entry document line item. readOnly: true example: '44' id: type: string description: ID for the for the Order Entry document line item. readOnly: true example: '44' href: type: string description: URL for the Order Entry document line item. readOnly: true example: /objects/order-entry/document-line::Sales%20Invoice/44 documentType: type: string description: The type of transaction document. readOnly: true example: Sales Invoice lineNumber: type: integer description: Line number for the document line. readOnly: true example: 1 item: type: object description: Item associated with the document line. properties: key: type: string description: System-assigned key for the item. example: '10' id: type: string description: ID for the item. readOnly: true example: MX001 href: type: string description: URL for the item. readOnly: true example: /objects/inventory-control/item/10 itemAlias: type: object description: Alternative name for the Item for a specific customer. properties: key: type: string description: System-assigned key for the item alias. example: '10' id: type: string description: ID for the item alias. example: IXN href: type: string description: URL for the item alias. readOnly: true example: /objects/accounts-receivable/customer-item-cross-reference/10 memo: type: string description: Memo about the document line item. example: Payment ACH priceCalculationMemo: type: string description: Memo about price calculation used for the document line item. example: Fair value price list unit: type: string description: Unit associated with this document line item. example: Each quantity: type: string format: decimal-precision-10 readOnly: true description: Quantity associated with this document line item. example: '40.10' unitQuantity: type: string format: decimal-precision-10 description: Unit quantity associated with this document line item. example: '10.10' unitPrice: type: string format: decimal-precision-10 description: Unit price associated with this line item. example: '10.50' price: type: string format: decimal-precision-10 readOnly: true description: The price is computed based on unit factor. example: '33.66' quantityConverted: type: string format: decimal-precision-10 readOnly: true description: >- Quantity of item/s converted to a downstream document from the original quantity entered. example: '5.10' retailPrice: type: string format: decimal-precision-10 readOnly: true description: Suggested price for the item. example: '10.44' audit: $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' costMethod: type: string description: Cost method associated with the document line item. readOnly: true enum: - null - standard - average - FIFO - LIFO default: null nullable: true example: average discountPercent: type: string format: decimal-precision-2 description: Discount percentage for the document line item. example: '10.50' multiplier: type: number description: Multiplier example: 1 sourceDocument: type: object description: Parent/Source document properties: key: type: string description: System-assigned key for the Order Entry document. example: '77' id: type: string description: >- The source transaction from which the Order Entry document was created. example: Sales Order-SO0022 documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: Endpoint for the Order Entry document. readOnly: true example: /objects/order-entry-document::Sales%20Order/77 sourceDocumentLine: type: object description: Parent/Source document line that needs to be converted. properties: key: type: string description: System-assigned key for the Order Entry document line item. example: '2234' id: type: string description: ID for the for the Order Entry document line item. example: '2234' documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: URL for the Order Entry document line item. readOnly: true example: /objects/order-entry/document-line::Sales%20Order/2234 isPriceProrated: type: boolean description: Indicates whether the price is prorated. example: true default: true discountMemo: type: string description: Discount memo for any discounts taken. example: Festival discount baseCurrency: type: string description: Base currency for the transaction. readOnly: true example: USD txnCurrency: type: string description: Currency used for the transaction. readOnly: true example: CAD priceInTxnCurrency: type: string format: decimal-precision-10 readOnly: true description: Transaction price. example: '10.00' isBillable: type: boolean description: Indicates whether the line is billable. example: true default: true isBilled: type: boolean description: Indicates whether the line has been billed. readOnly: true example: true default: true taxRate: type: string format: decimal-precision-2 description: Tax rate for the document line item. example: '10.05' taxInBaseCurrency: type: string format: decimal-precision-2 description: The line level tax amount in base currency. readOnly: true example: '10.50' taxInTxnCurrency: type: string format: decimal-precision-2 description: The line level tax amount in transaction currency. readOnly: true example: '40.50' discountPercentage: type: string format: decimal-precision-2 description: Discount applied to the line item. example: '10.25' enableTax: type: boolean description: Indicates whether the line item is taxable. default: false example: false quantityRemaining: type: string format: decimal-precision-10 description: Quantity of the item remaining. readOnly: true example: '10.10' conversionType: type: string description: Conversion type used for the transaction. enum: - quantity - price default: quantity example: quantity dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: title: location type: object description: Location associated with the document line. properties: key: type: string description: System-assigned key for the location. example: '22' id: type: string description: Identifier for the location. example: LOC-22 href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/22 department: type: object description: >- A dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string description: System-assigned key for the department. readOnly: true example: '9' id: type: string description: Unique identifier of the department. example: Sales href: type: string description: URL for the department. readOnly: true example: /objects/company-config/department/9 warehouse: title: warehouse description: Warehouse associated with the document line. type: object properties: key: type: string description: System-assigned key for the warehouse. example: '6' id: type: string description: Unique identifier for the warehouse. example: WH01 href: type: string description: URL for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/6 project: title: project description: Project associated with the document line. type: object properties: key: type: string description: System-assigned key for the associated project. example: '2' id: type: string description: ID for the associated project. example: NET-XML30-2 href: type: string readOnly: true description: URL for the project. example: /objects/projects/project/2 task: title: task description: Task associated with the document line. type: object properties: id: type: string description: Identifier for the associated task. example: TSK01 key: type: string description: System-assigned key for the associated task. example: '1' href: type: string description: URL for the task. readOnly: true example: /objects/projects/task/1 itemRenewalTemplate: type: object description: The template used for renewal schedules. properties: key: type: string description: The key of renewal template. example: '45' id: type: string description: The ID of renewal template. example: Sales Renewal Template href: type: string description: URL for the order-entry-renewal-template. readOnly: true example: /objects/order-entry/renewal-template/45 revenueRecognitionStartDate: type: string description: >- The date on which the either revenue recognition schedule and/or renewal schedule get started. format: date example: '2023-04-04' revenueRecognitionEndDate: type: string description: >- The date on which the either revenue recognition schedule and/or renewal schedule ends. format: date example: '2023-04-04' requestedShippingDate: type: string description: >- The date the customer requests the goods to arrive on their premises. The default is the due date. format: date example: '2023-04-04' shipByDate: type: string description: >- The date the goods should be shipped so they arrive when the customer needs them. format: date example: '2023-04-04' pickTicketPrintedDate: type: string description: The date on which the pick ticket is printed. format: date example: '2023-04-04' cancelAfterDate: type: string description: Indicates the date after which the order can be canceled. format: date example: '2023-04-04' doNotShipBeforeDate: type: string description: Do not ship before this date. format: date example: '2023-04-04' doNotShipAfterDate: type: string description: Do not ship after this date. format: date example: '2023-04-04' shippedDate: type: string description: The date that the order was shipped. format: date example: '2023-04-04' allowDropship: type: boolean description: Indicates whether dropship is allowed for the line. default: false example: true allowBuyToOrder: type: boolean description: Indicates whether buy-to-order is allowed for the line. default: false example: true buyToOrderContact: type: object description: Contacts for delivering the buy-to-order. properties: key: type: string description: System-assigned key for the contact. readOnly: true example: '13' id: type: string description: Identifier for the contact. example: contact trackingDetail: type: array description: >- List of warehouse inventory details including serial number, aisle, bin, and row per item. items: $ref: '#/components/schemas/order-entry-document-line-detail' documentHeader: type: object description: Header lever details for the document line items. properties: key: type: string description: System-assigned key for the order entry document. example: '55' id: type: string description: ID for the order entry document. example: Sales Invoice-SO0066 documentType: type: string description: Type of the order entry document. example: Sales Invoice readOnly: true href: type: string description: URL for the order entry document. readOnly: true example: /objects/order-entry-document::Sales%20Invoice/55 order-entry-document-subtotal: type: object description: Details of Subtotals, taxes, discounts, charges etc for the transaction. properties: key: type: string description: System-assigned key for the Order Entry document subtotal. readOnly: true example: '12' id: type: string description: ID for the Order Entry document subtotal. readOnly: true example: '12' href: type: string description: Endpoint for the Order Entry document subtotal. readOnly: true example: /objects/order-entry/document-subtotal/12 description: type: string description: Description about the subtotal. example: Tax percentValue: type: string format: decimal-precision-2 description: >- Percentage value that is calculated on the total of all line items of the document. example: '10.50' absoluteValue: type: string format: decimal-precision-2 description: >- Non negative base amount calculated across all other lines of the document. readOnly: true example: '40.50' txnAbsoluteValue: type: string format: decimal-precision-2 description: >- Non negative transaction amount calculated across all other lines of the document. example: '44.78' isValueEditable: type: boolean description: >- Indicates whether the percent value or the transaction absolute value is editable. readOnly: true enum: - false - true example: true default: false isPercentEditable: type: boolean description: Indicates whether the percent is editable. readOnly: true enum: - false - true example: true default: false total: type: string format: decimal-precision-2 readOnly: true description: The computed base amount for the subtotal. example: '500.10' txnTotal: type: string format: decimal-precision-2 readOnly: true description: The computed transaction amount for the subtotal. example: '400.10' documentLine: type: object description: The Order Entry document line associated with the subtotal. readOnly: true properties: key: type: string description: System-assigned key for the Order Entry document line. readOnly: true example: '10' documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true id: type: string description: System-assigned ID for the Order Entry document line. readOnly: true example: '10' href: type: string description: Endpoint for the Order Entry document line. readOnly: true example: /objects/order-entry-document-line::Sales%20Order/10 audit: $ref: '#/components/schemas/audit' dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: title: location description: Location associated with the subtotal line. type: object properties: key: type: string description: System-assigned key for the location. example: '22' id: type: string description: Identifier for the location. example: LOC-22 href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/22 department: title: department type: object description: >- A dimension that allows you to create a hierarchy of departments to reflect how your company is organized. properties: key: type: string description: System-assigned key for the department. readOnly: true example: '9' id: type: string description: Unique identifier of the department. example: Accounting href: type: string readOnly: true description: URL for the department. example: /objects/company-config/department/9 documentHeader: type: object description: Order entry document header. readOnly: true properties: key: type: string description: System-assigned key for the Order Entry document. readOnly: true example: '23' id: type: string description: ID for the Order Entry document. readOnly: true example: '23' documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: Endpoint for the Order Entry document. readOnly: true example: /objects/order-entry-document::Sales%20Order/23 order-entry-document-history: type: object description: >- History of workflow conversions associated with the Order Entry transaction. properties: key: type: string description: System-assigned key for the Order Entry document history readOnly: true example: '11' id: type: string description: System-assigned ID for the Order Entry document history readOnly: true example: '11' href: type: string description: Endpoint for the Order Entry document history. readOnly: true example: /objects/order-entry/document-history/11 convertedFrom: type: object description: >- The transaction from which the corresponding Order Entry transaction was converted readOnly: true properties: key: type: string description: System-assigned key for the Order Entry document. readOnly: true example: '22' id: type: string description: System-assigned ID for the Order Entry document. readOnly: true example: Sales Order-ORINV#0182#doc documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: URL for the Order Entry document. readOnly: true example: /objects/order-entry-document::Sales%20Order/22 convertedTo: type: object description: The associated transaction in a workflow history readOnly: true properties: key: type: string description: System-assigned key for the Order Entry document. readOnly: true example: '14' id: type: string description: System-assigned ID for the Order Entry document. readOnly: true example: Sales Invoice-SUBINV#0182#doc documentType: type: string description: Type of the order entry document. example: Sales Invoice readOnly: true href: type: string description: URL for the Order Entry document. readOnly: true example: /objects/order-entry-document::Sales%20Invoice/14 orderEntryDocument: type: object description: >- The Order Entry document with which the history information is associated with readOnly: true properties: key: type: string description: System-assigned key for the Order Entry document. readOnly: true example: '23' id: type: string description: Name or other unique identifier for the Order Entry document. readOnly: true example: Sales Order-ORINV#0182#doc documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: Endpoint for the document. readOnly: true example: /objects/order-entry-document::Sales%20Order/22 order-entry-document: type: object description: An Order Entry document contains information about sales transactions. properties: key: type: string description: System-assigned key for the Order Entry document. readOnly: true example: '55' id: type: string description: Name or other unique identifier for the Order Entry document. readOnly: true example: Sales Invoice-SI-O122 href: type: string description: URL for the Order Entry document. readOnly: true example: /objects/order-entry/document::Sales%20Invoice/55 documentNumber: type: string description: >- Document number for the Order Entry document. If the transaction definition does not have a numbering sequence configured, provide a number to identify the transaction. example: SI-O122 documentType: type: string readOnly: true description: The type of transaction document. example: Sales Invoice state: type: string description: | State of the Order Entry document. enum: - submitted - approved - partiallyApproved - declined - draft - pending - closed - inProgress - converted - partiallyConverted - convertedByLine - partiallyConvertedByLine - exception example: draft default: draft isPrinted: type: boolean description: Indicates whether the document has been printed. readOnly: true enum: - true - false default: false example: true isBackordered: type: boolean description: Indicates whether the transaction is a back order. readOnly: true enum: - true - false default: false example: false subTotal: type: string format: decimal-precision-2 readOnly: true description: Subtotal of the document in base currency. example: '50.10' subtotalInTxnCurrency: type: string format: decimal-precision-2 readOnly: true description: Subtotal of the document in transaction currency. example: '51.10' total: type: string format: decimal-precision-2 readOnly: true description: The sum of values across all lines in the document. example: '100.10' totalInTxnCurrency: type: string format: decimal-precision-2 readOnly: true description: Total in the transaction currency. example: '100.11' baseCurrency: type: string description: Base currency for the transaction. example: USD txnCurrency: type: string description: Currency used for the transaction. example: USD exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: string format: decimal-precision-10 description: >- Exchange rate used to calculate the base amount from the transaction amount. example: '1.0789' typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: '1' typeName: type: string description: The name of exchange rate type. example: Intacct Daily Rate transactionDate: type: string description: Date on the Order Entry document. format: date example: '2023-04-04' dueDate: type: string description: Due date for the Order Entry document. format: date example: '2023-04-04' isSystemGeneratedDocument: type: boolean description: Indicates whether the Order Entry document is system generated. readOnly: true example: true default: false postingDate: type: string format: date description: The date on which Order Entry document posts to the General Ledger. example: '2023-04-04' referenceNumber: type: string description: Reference number for the Order Entry document. example: SALES-100 notes: type: string description: Notes about the Order Entry document. example: Fast order memo: type: string description: Text printed on the Order Entry document. example: Lowry solutions contractID: type: string description: Sales contract ID associated with the transaction. example: CN100123 contractDescription: type: string description: Sales contract description. example: Sales & Service paymentStatus: type: string description: Payment status for the transaction. readOnly: true enum: - paid - partiallyPaid - open default: open example: paid invoiceDate: type: string description: Original invoice date. format: date example: '2023-04-04' customerPONumber: type: string description: Customer PO number associated with the transaction. example: ABOTT-1001 trackingNumber: type: string description: User-provided tracking reference number. example: TK-1002 shipByDate: type: string description: The ship-by date for the order. format: date example: '2023-04-04' shippedDate: type: string description: The date that the order was shipped. format: date example: '2023-04-04' serviceDeliveryDate: type: string description: The date on which the service is delivered. format: date example: '2023-04-04' cancelAfterDate: type: string description: Indicates the date after which the order can be canceled. format: date example: '2023-04-04' doNotShipBeforeDate: type: string description: Do not ship before this date. format: date example: '2023-04-04' doNotShipAfterDate: type: string description: Do not ship after this date. format: date example: '2023-04-04' requestedShippingDate: type: string description: >- The date the customer requests the goods to arrive on their premises. The default is the due date. format: date example: '2023-04-04' contacts: type: object description: Contacts associated with the Order Entry document. properties: primary: type: object description: Primary contact properties: key: type: string description: System-assigned key for the primary contact. readOnly: true example: '13' id: type: string description: Identifier for the primary contact. example: contact shipTo: type: object description: Ship-to contact. properties: key: type: string description: System-assigned key for the ship-to contact. readOnly: true example: '33' id: type: string description: Identifier for the ship-to contact. example: contact billTo: type: object description: Bill-to contact. properties: key: type: string description: System-assigned key for the bill-to contact. readOnly: true example: '44' id: type: string description: Identifier for the bill-to contact. example: contact shippingMethod: type: object description: Shipping method for the order. properties: key: type: string description: System-assigned key for the shipping method. example: '77' id: type: string description: Identifier for the shipping method. example: Air href: type: string description: URL for the shipping method. example: /objects/accounts-receivable/shipping-method/77 printedByUser: type: object description: User who printed the document. readOnly: true properties: key: type: string description: User name. readOnly: true example: '21' id: type: string description: Identifier for the user. readOnly: true example: John href: type: string readOnly: true description: URL for the user. example: /objects/company-config/user/21 txnDefinition: type: object description: Transaction definition that is associated with this transaction. properties: key: type: string description: System-assigned key for the transaction definition. example: '11' id: type: string description: Name for the Order Entry transaction definition. example: Sales Invoice href: type: string description: Endpoint for the Order Entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/11 sourceDocument: type: object description: Parent/Source document properties: key: type: string description: System-assigned key for the Order Entry document. example: '44' id: type: string description: >- The source transaction from which the Order Entry document was created. example: Sales Order-SO0022 documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: Endpoint for the source. readOnly: true example: /objects/order-entry/document::Sales%20Order/44 customer: type: object description: Customer associated with the Order Entry document. properties: key: type: string description: System-assigned key for the customer. example: '15' id: type: string description: Customer ID example: customer href: readOnly: true description: URL for the customer. type: string example: /objects/accounts-receivable/customer/15 contract: type: object description: Contract associated with the Order Entry document. properties: key: type: string description: System-assigned key for the contract. example: '46' id: type: string description: ID of the contract. example: CNRT1001 href: type: string description: Endpoint for the contract. readOnly: true example: /objects/contracts/contract/46 paymentTerm: type: object description: >- Accounts Receivable (AR) term, which determines the expiration date for quotes and the due date for invoices. properties: href: type: string description: Endpoint for the term. readOnly: true example: /objects/term/75 key: type: string description: System-assigned key for the AR term. example: '75' id: type: string description: The name of AR term. example: 10 Days audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Date and time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true taxSolution: type: object description: >- The associated tax solution for the transaction. Tax solutions are available for different countries, for example Australia GST or South Africa VAT. properties: key: type: string description: System-assigned key for the tax solution. example: '44' id: type: string description: ID for the tax solution. example: Avalara href: type: string description: URL for the tax solution. readOnly: true example: /objects/taxsolution/44 taxCalculationMethod: type: string description: Calculation method used for the tax solution. nullable: true default: null example: noTax enum: - null - noTax - simpleTax - advancedTax - avaTax - VAT showMultilineTax: type: boolean description: Indicates whether to show multiple taxes per line. readOnly: true example: true default: true lines: type: array description: Lines of the Order Entry document. items: $ref: '#/components/schemas/order-entry-document-line' subtotals: type: array description: Lines of the Order Entry document subtotal. items: $ref: '#/components/schemas/order-entry-document-subtotal' history: type: array description: Lines of the Order Entry document history. items: $ref: '#/components/schemas/order-entry-document-history' order-entry-document-lineRequiredProperties: type: object required: - unit - unitQuantity - unitPrice properties: dimensions: required: - item - warehouse - location example: >- { "item": { "id": "1" }, "warehouse": { "id": "1" }, "location": { "id": "1" }} documentHeader: required: - key example: '22' order-entry-txn-definitionRequiredProperties: type: object required: - id order-entry-txn-definition-cogs-gl-detail: type: object description: GL account mappings for costing for Order Entry transaction definitions. properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-cogs-gl-detail. readOnly: true example: '23' id: type: string description: Order Entry transaction definition COGS accounts ID. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-cogs-gl-detail. readOnly: true example: /objects/order-entry/txn-definition-cogs-gl-detail/23 isOffset: type: boolean description: If true, then the line will be marked as offset. example: true default: false txnType: type: string description: Debit or credit type. enum: - debit - credit example: debit moduleType: type: string description: Module type. example: subledger enum: - subledger - inventory - additional lineNumber: type: integer description: Line no. example: 1 maxLength: 8 glAccount: type: object properties: key: type: string description: System-assigned key for the account. example: '384' id: type: string description: User-assigned number for the account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/384 location: type: object properties: href: type: string description: Endpoint for the location. readOnly: true example: /objects/company-config/location/23 key: type: string description: >- System-assigned unique key for the location. Used to identify the location in URLs or JSON bodies for all operations on the location. example: '3345' id: type: string description: Location. example: Arizona department: type: object properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/23 key: type: string description: Department key example: '28' id: type: string description: Department. example: Sales itemGLGroup: type: object properties: href: type: string description: Endpoint for the itemglgroup. readOnly: true example: /objects/itemglgroup/23 key: type: string description: System-assigned key for the item GL group. example: '13' id: type: string description: Name or other unique identifier for the item GL group. example: Stockable Kit warehouse: type: object properties: href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 key: type: string description: Default warehouse key. example: '23' id: type: string description: Unique identifier for the warehouse. example: Warehouse-001 customerGLGroup: type: object description: Customer GL Group properties: id: type: string description: Customer GL group name. example: Group 1 status: $ref: '#/components/schemas/status' order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-ar-direct-gl-detail: type: object description: >- Account Receivable or direct GL account detail for Order Entry transaction. properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-ar-direct-gl-detail. readOnly: true example: '23' id: type: string description: Order Entry transaction definition GL mapping ID. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-ar-direct-gl-detail. readOnly: true example: /objects/order-entry/txn-definition-ar-direct-gl-detail/23 isOffset: type: boolean description: If true then the line is marked as Offset. example: true default: false txnType: type: string description: Debit or credit type. enum: - debit - credit example: debit moduleType: type: string description: Module type. example: subledger enum: - subledger - inventory - additional lineNumber: type: integer description: Line no. example: 1 maxLength: 8 glAccount: type: object properties: key: type: string description: System-assigned key for the account. example: '384' id: type: string description: User-assigned number for the account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/384 location: type: object properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/23 key: type: string description: >- System-assigned unique key for the location. Used to identify the location in URLs or JSON bodies for all operations on the location. example: '3345' id: type: string description: Location. example: Arizona department: type: object properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/23 key: type: string description: Department key example: '28' id: type: string description: Department. example: Sales itemGLGroup: type: object properties: href: type: string description: Endpoint for the itemglgroup. readOnly: true example: /objects/itemglgroup/23 key: type: string description: System-assigned key for the item GL group. example: '13' id: type: string description: Name or other unique identifier for the item GL group. example: Stockable Kit warehouse: type: object properties: href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 key: type: string description: Default warehouse key. example: '23' id: type: string description: Unique identifier for the warehouse. example: Warehouse-001 customerGLGroup: type: object description: Customer GL Group properties: id: type: string description: Customer GL group name. example: Group 1 status: $ref: '#/components/schemas/status' order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-additional-gl-detail: type: object description: >- Additional GL posting account detail for Order Entry transaction transaction properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-additional-gl-detail. readOnly: true example: '23' id: type: string description: Order Entry transaction definition GL mapping ID. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-additional-gl-detail. readOnly: true example: >- /objects/order-entry/order-entry-txn-definition-additional-gl-detail/23 isOffset: type: boolean description: If true then the line is marked as offset. example: true default: false txnType: type: string description: Debit or credit type. enum: - debit - credit example: debit moduleType: type: string description: Module type. example: additional enum: - additional lineNumber: type: integer description: Line no. example: 1 maxLength: 8 glAccount: type: object properties: key: type: string description: System-assigned key for the account. example: '384' id: type: string description: User-assigned number for the account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/384 location: type: object properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/23 key: type: string description: >- System-assigned unique key for the location. Used to identify the location in URLs or JSON bodies for all operations on the location. example: '3345' id: type: string description: Location. example: Arizona department: type: object properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/23 key: type: string description: Department key example: '28' id: type: string description: Department. example: Sales itemGLGroup: type: object properties: href: type: string description: Endpoint for the itemglgroup. readOnly: true example: /objects/itemglgroup/23 key: type: string description: System-assigned key for the item GL group. example: '13' id: type: string description: Name or other unique identifier for the item GL group. example: Stockable Kit warehouse: type: object properties: href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 key: type: string description: Default warehouse key. example: '23' id: type: string description: Unique identifier for the warehouse. example: Warehouse-001 customerGLGroup: type: object description: Customer GL Group properties: id: type: string description: Customer GL group name. example: Group 1 status: $ref: '#/components/schemas/status' order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-inventory-total-detail: type: object description: Inventory total detail for Order Entry transaction properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-inventory-total-detail. readOnly: true example: '23' id: type: string description: Document parameters total ID. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-inventory-total-detail. readOnly: true example: /objects/order-entry/txn-definition-inventory-total-detail/23 maintainType: type: string description: Maintain type. enum: - quantity - value - quantityAndValue example: value operation: type: string description: Add or subtract. enum: - add - subtract example: add inventoryTotal: type: object description: Inventory total properties: id: type: string description: Inventory total. example: eg order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-subtotal-detail: type: object description: Sub-total detail for Order Entry transaction properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-subtotal-detail. readOnly: true example: '23' id: type: string description: >- System-assigned ID for the order-entry-txn-definition-subtotal-detail. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-subtotal-detail. readOnly: true example: /objects/order-entry/txn-definition-subtotal-detail/23 subtotalType: type: string description: Subtotal type. example: discount enum: - null - discount - charge nullable: true default: null lineNumber: type: integer description: Line number. example: 1 maxLength: 8 description: type: string description: Description. example: Discount valueType: type: string description: Value type. example: amount enum: - null - amount - percent nullable: true default: null subtotalValue: type: string format: decimal-precision-2 description: >- Provide a default value for the subtotal. If Value type is Amount, enter the amount of the subtotal. For example, enter 250. If Value type is Percent, enter a percentage as a whole number. For example, enter 10 for 10%. Users can override the default subtotal value in the transaction. example: '10.23' maxLength: 12 isApportioned: type: boolean description: >- If true, then the discount subtotal will be apportioned across all line items in the transaction. example: true default: false glAccount: type: object description: Select the GL account to which the subtotal will post. properties: key: type: string description: System-assigned key for the general ledger account. example: '5' id: type: string description: User-assigned number for the GL account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/5 offsetGLAccount: type: object description: Select the offset GL account to which the subtotal will post properties: key: type: string description: System-assigned key for the general ledger account. example: '5' id: type: string description: Unique ID for the account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/5 txnType: type: string description: Transaction type - debit or credit. example: debit enum: - null - debit - credit nullable: true default: null appliedToLineNumber: type: integer description: >- Specify the subtotal line number to which the subtotal will apply. Sage Intacct treats the initial subtotal line as line number 0. The first defined subtotal from the transaction definition is line number 1, the second defined subtotal is line number 2, and so on. The value of Applied to line is implicitly assumed to be 0. Taxes, all other charges, and discounts are computed at the line level. This fields does not apply if is set to line-level Simple Tax. example: 1 maxLength: 8 isTax: type: boolean description: >- Flags the subtotal as a tax. When the transaction posts, the tax will post separately based on the items in the transaction. example: true default: false department: type: object description: Select a default department for the subtotal properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/23 key: type: string description: Department key example: '28' id: type: string description: Department. example: Sales location: type: object description: Select a default location for the subtotal properties: key: type: string description: System-assigned key for the location. readOnly: true example: '22' id: type: string description: Identifier for the location. readOnly: true example: Arizona href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/22 readOnly: true enableAvalaraTax: type: boolean description: If set to true then the subtotal line item applies to AvaTax. example: true default: false entity: type: object description: Sets the context where the transaction definition is created properties: href: type: string description: Endpoint for the entityloc. readOnly: true example: /objects/entityloc/23 key: type: string description: >- System-assigned unique key for the entity. Used to identify the entity in URLs or JSON bodies for all operations involving the entity. readOnly: true example: '3345' id: type: string description: Name of the location. readOnly: true example: Australia readOnly: true order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-source-document-detail: type: object description: Document conversion detail for an Order Entry transaction properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-recall-detail. readOnly: true example: '23' id: type: string description: ID. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-recall-detail. readOnly: true example: /objects/order-entry-txn-definition-recall-detail/23 sourceDocument: type: object description: >- Specify the transaction definitions from which this transaction can be converted. For example, a sales invoice can be converted from a sales order and a shipper. properties: href: type: string description: Endpoint for the sodocumentparams. readOnly: true example: /objects/sodocumentparams/23 key: type: string description: System-assigned key for the order entry transaction definition. example: '23' id: type: string description: Document id. example: Sales order isDefault: type: boolean description: Default for bulk conversion. example: true default: false order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-entity-setting-detail: type: object description: Entity settings for order entry transaction properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-entity-setting-detail. readOnly: true example: '23' id: type: string description: Document parameters entity property ID. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-entity-setting-detail. readOnly: true example: /objects/order-entry/txn-definition-entity-setting-detail/23 enableNumberingSequence: type: boolean description: If true then enable sequence numbering. example: false default: false preserveNumberingSequence: type: boolean description: If true then preserve sequence numbering. example: false default: false canInheritSourceDocumentNumber: type: boolean description: Inherit source document number. example: false default: false documentTemplate: type: object description: >- Provide printed document template to use as the default for printed output (PDFs) for the corresponding entity. Order entry transaction definition document template is used if you not provide this field. properties: key: type: string description: The system generated key document template. example: '65' maxLength: 8 id: type: string description: The name of document template. example: Sales Order maxLength: 100 enableCreateTransactionRule: type: boolean description: Create transactions in. example: false default: false subtotalTemplate: type: object description: >- Specifies the template for populating the transaction subtotals table. properties: href: type: string description: Endpoint for the order entry subtotal template. readOnly: true example: /objects/order-entry/subtotal-template/23 key: type: string description: Subtotal template. example: '22' id: type: string description: Name of a order entry subtotal template. example: Subtotal template showExpandedTaxDetail: type: boolean description: Show expanded tax details. example: false default: false enableOverrideTax: type: boolean description: Line-item tax. example: false default: false enableLineLevelSimpleTax: type: boolean description: Enable line-level Simple Tax. example: false default: false entity: type: object properties: href: type: string description: Endpoint for the entityloc. readOnly: true example: /objects/entityloc/23 key: type: string description: >- System-assigned unique key for the entity. Used to identify the entity in URLs or JSON bodies for all operations involving the entity. example: '23' id: type: string description: >- Unique identifier of the entity. 20 characters max. The ID cannot be changed after the entity has been created. example: Lyon documentSequence: type: object properties: key: type: string description: Document sequence Key example: '23' href: type: string description: Endpoint for the seqnum. readOnly: true example: /objects/company-config/document-sequence/23 id: type: string description: The ID of the numbering sequence. example: Adjustment Decrease audit: $ref: '#/components/schemas/audit' order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition: type: object description: >- An order entry transaction definition includes the accounting rules, workflow settings, security settings, and other characteristics for a transaction. properties: key: type: string description: System-assigned key for the order entry transaction definition. readOnly: true example: '23' id: type: string description: The name for the order entry transaction definition. example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 docClass: type: string description: Order entry transaction template type. example: quote enum: - quote - order - list - invoice - adjustment - other default: quote workflowCategory: type: string description: Workflow category example: quote enum: - quote - order - shipping - invoice - return default: quote description: type: string description: Description about order entry transaction definition. example: Sales Return RevRec Document enableUserOrGroupPermmission: type: boolean description: >- By default, all users with the appropriate application permissions have access to transactions that use this transaction definition. To restrict access to certain users or groups, set this field to 'true'. example: true readOnly: true default: false editPolicy: type: string description: >- Sets the edit permission for this transaction type. By default, the user cannot edit the transaction after it is created. example: noEdit enum: - noEdit - beforePrinting - editInDraftOnly - all default: all deletePolicy: type: string description: >- Sets the delete permission for this transaction type. By default, a user cannot delete a transaction after it is created. example: all enum: - noDelete - beforePrinting - all default: noDelete enableNumberingSequence: type: boolean description: Enable numbering scheme for order entry transaction. example: false default: false preserveNumberingSequence: type: boolean description: If true then preserve sequence numbers for order entry transaction. example: false default: false inheritDocumentNumber: type: boolean description: >- Set to `true` if transactions should inherit source document numbers. For example, a transaction could inherit a sales invoice number. example: false default: false inventoryUpdateType: type: string description: >- Specify if inventory will be affected by the transaction and, if so, whether to track the quantity, value, or both . enum: - 'no' - quantity - value - quantityAndValue example: 'no' default: 'no' increaseOrDecreaseInventory: type: string description: >- Specify whether the inventory running total is increased or decreased by the transaction. example: increase enum: - increase - decrease default: increase txnPostingMethod: type: string description: >- Specify whether the transaction post process creates a GL entry and, if so, whether it will post directly to the GL or to the AR subledger. example: toGL enum: - toAR - toGL - noPosting default: noPosting disableTax: type: boolean description: Set to `true` to disable tax capture for the transaction. example: false default: false enableFulfillment: type: boolean description: Set to `true` to enable the transaction definition for fulfillment. example: false default: false enableReservingAndPicking: type: boolean description: Set to `true` to enable inventory items for reserving and picking. example: false default: false partialConvertMethod: type: string description: >- Specify how the system processes transactions that are partially complete. example: closeTransaction enum: - leaveTransactionOpen - closeOriginalAndCreateBackOrder - closeTransaction default: closeTransaction affectsCost: type: boolean description: If true the transaction will affect the costing of order entry. example: false default: false overrideExchangeRateType: type: boolean description: >- Indicates whether users can edit the Exchange rate and/or Exchange rate type fields of the transaction. example: false default: true showBaseCurrency: type: boolean description: >- Specifies whether the transaction amounts are displayed in both base currency and transaction currency. example: false default: false overridePrice: type: boolean description: >- Set to `true` to allow users to override line item prices on the transaction. example: false default: true trackDiscountAndSurcharge: type: boolean description: Indicates whether users can discount transaction line items. example: false default: false allowDiscountOnExtendedPrice: type: boolean description: >- Indicates whether the transaction definition can be used for contract invoices. This field is only applicable if the company is subscribed to Contracts. example: false default: false requireMemoForDiscount: type: boolean description: >- Indicates whether users must provide notes for line items being discounted before saving a transaction. example: false default: false freezeRecallValue: type: boolean description: Set to `true` to freeze recalled values example: false default: false enableSubtotals: type: boolean description: >- Set to `true` to specify standard subtotals, such as tax or a discount, for the transaction. example: false default: false showExpandedTaxDetails: type: boolean description: >- Set to `true` to show expanded tax details in the transaction user interface and in printed output. This field applies only to companies that use Avalara AvaTax or Sage Intacct Advanced Tax. example: false default: false enableOverrideTax: type: boolean description: Indicates whether users can override whether a line item is taxable. example: false default: false revrecEnablementType: type: string description: >- Specifies whether revenue recognition applies to transactions created from this definition and, if so, whether to post the revenue recognition or only display it. This field applies only to companies subscribed to Revenue Management and is applicable only to Order Entry revenue recognition. example: post enum: - post - displayOnly - none default: none renewalEnablementType: type: string description: >- Specifies whether contract renewals apply to the transaction type and, if so, whether the renewal is set up to generate when the transaction posts or the renewal fields are displayed in the transaction so users can select a renewal transaction set. example: displayOnly enum: - generate - displayOnly - none default: none enableLineItemConversion: type: boolean description: >- Set to `true` to allow users to convert a sales transaction by line item into a scheduled recurring transaction. example: false default: false allowRenewConvertedLineOnly: type: boolean description: >- This field is only applicable if `enableRenewals` is set to `Generate`. Set to `true` if the system should only renew line items that were converted in the original sales transaction. Set to `false` if all indicated line items should be renewed, regardless of conversion status. example: false default: false allowLocationOverride: type: boolean description: >- Set to 'true' to allow users to override the location set for the transaction. example: false default: false allowDepartmentOverride: type: boolean description: >- Set to `true` to allow users to override the department set for the transaction. example: false default: false xslTemplate: type: string description: Document template to use for printed output (PDFs). example: sales fixedMessage: type: string description: This message is displayed in the Print/Email document. example: >- For any inquiries or assistance, please contact our customer service. contactOneTitle: type: string description: >- Use this field to change the Bill-to labels on the transaction and on the printed document. example: Bill to default: Bill to contactTwoTitle: type: string description: >- Use this field to change the Ship-to labels on the transaction and on the printed document. example: Ship to default: Ship to printBillToContact: type: boolean description: If true then show the 'Bill to' contact in printed document. example: false default: false printShipToContact: type: boolean description: If true then show the 'Ship to' contact in printed document. example: false default: false allowEditingBillToContact: type: boolean description: >- If true then allow to change the Bill-to contact during transaction entry. example: false default: false allowEditingShipToContact: type: boolean description: >- If true then allow to change the Ship-to contact during transaction entry. example: false default: false enableWarnOnLowQuantity: type: boolean description: >- Indicates whether to alert the user if the quantity needed is greater than the ONHAND total in the selected warehouse. The warning also shows the ONORDER and ONHOLD totals. example: false default: true enableCreditLimitCheck: type: boolean description: >- Specifies whether to enforce customer credit limit restrictions in transactions created from this definition. example: false default: false warehouseSelectionMethod: type: string description: >- Determines how warehouses are presented to the user in the warehouse list in the transaction. example: sortByID enum: - sortByID - sortByName - warehouseWithAvailableInventory - useTheDefaultWarehouse default: sortByID enablePayments: type: boolean description: >- Set to `true` to enable users to apply payments to an invoice in Order Entry and to set a recurring template to automatically charge a credit card when an invoice is generated (if the company is subscribed to Payment Services). example: false default: false latestVersionKey: type: string description: >- System-assigned version key for the order entry transaction definition. readOnly: true example: '23' postToGL: type: boolean description: If true then enable additional posting to General Ledger. example: false default: false requireSupplyOfPrices: type: boolean description: Set to `true` if a price must be supplied. example: false default: false enableCosting: type: boolean description: If true then enable costing for non-inventoried items. example: false default: false documentConversionPolicy: type: string description: Document conversion policy. example: convertOnly enum: - null - newDocumentOnly - newDocumentOrConvert - convertOnly nullable: true default: null multiEntityRuleForTransaction: type: string description: >- Sets the context for where users can create transactions from this transaction definition within a multi-entity, shared environment. example: topLevelOnly enum: - topLevelOrEntity - topLevelOnly - entityOnly default: topLevelOrEntity enableProjectActualBillings: type: boolean description: >- If true then enable display of actual billings on printed or emailed invoices. example: false default: false lineLevelSimpleTax: type: boolean description: If true then enable line-level Simple Tax. example: false default: false customerVendorEditRule: type: string description: >- Allow users to change the customer in Draft or Pending transactions if the transaction has not been converted to another transaction, the transaction date is in an open period, and the transaction's payment status is not `Paid` or `Partially paid`. By default, the users cannot edit the customer. example: always enum: - null - always - exceptConvertedDocuments - never nullable: true default: null enableRetainage: type: boolean description: Set to 'true' to enable retainage. example: false default: false enableAdditionalInformationScope: type: boolean description: >- Set to 'true' to enable identification of work that is included and excluded, the reason why, and the terms. example: false default: false enableAdditionalInformationSchedule: type: boolean description: Set to 'true' to enable identification of dates for work milestones. example: false default: false enableInternalReference: type: boolean description: >- Set to 'true' to enable identification of who authorized work internally and when they authorized the work. example: false default: false enableExternalReference: type: boolean description: >- Set to 'true' to enable identification of who authorized work externally and when they authorized the work. example: false default: false enableBond: type: boolean description: >- Set to 'true' to identify information about performance and payment bonds. example: false default: false documentChangeType: type: string description: >- Indicates whether to enable changes to the transaction definition and, if so, how to handle changes. example: enableChange enum: - noChange - enableChange - changeOrder default: noChange reportingCategory: type: string description: >- Establishes a reporting category that best reflects the purpose of the transaction definition so that similar documents can be grouped when building reports. This field is applicable for use with Interactive Custom Report Writer or Interactive Visual Explorer subscriptions only. example: salesQuotes enum: - null - salesQuotes - salesOrders - salesOrderChangeOrders - salesOrderInvoices - salesReturns - salesShippers - salesCredits - salesDebits - salesClearingShippers - contractBids - contracts - contractChangeOrders - contractInvoicePreview - contractInvoices - projectInvoices - revRecActivation - forecastRevenue - pledges - giftsAndDonations - pledgeAndGiftInvoices - grantApplications - grantAwardInvoices - eventReservations - eventConfirmations - conferencesAndGatherings - eventInvoices - membershipRegistrations - membershipInvoices - invoicePreview - invoices - tuitionRegistrations - tuitionInvoices - sponsorships - sponsorshipInvoices - subscriptions - subscriptionInvoices - reservations - pointOfSale nullable: true default: null enableContractBilling: type: boolean description: If true then enable project contract billing. example: false default: false arPostingMethod: type: string description: Update method for project contract totals. example: addition enum: - null - none - addition nullable: true default: null documentSequence: type: object description: >- Select the numbering sequence to use to automatically number transactions properties: key: type: string description: Document sequence Key example: '23' href: type: string description: Endpoint for the seqnum. readOnly: true example: /objects/company-config/document-sequence/23 id: type: string description: The ID of the numbering sequence. example: Adjustment Decrease initialPriceList: type: object description: >- The first price list the system will evaluate when determining a suggested transaction price. properties: href: type: string description: Endpoint for the pricelist. readOnly: true example: /objects/pricelist/23 key: type: string description: System-assigned key for the sales price list. example: '22' id: type: string description: ID for the initial price list. example: Initial Price List updatePriceList: type: object description: The price list that will be updated when a user saves a transaction. properties: href: type: string description: Endpoint for the updpricelist. readOnly: true example: /objects/updpricelist/23 key: type: string description: System-assigned key for the order entry price list. example: '22' id: type: string description: The name of order entry price list. example: OE Price List specialPriceList: type: object description: The special price list takes precedence over the Initial price list. properties: href: type: string description: Endpoint for the spclpricelist. readOnly: true example: /objects/spclpricelist/23 key: type: string description: System-assigned key for the order entry price list. example: '21' id: type: string description: Special price list. example: Special price list warehouse: type: object description: Default warehouse properties: key: type: string description: Default warehouse key. example: '23' href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 id: type: string description: Unique identifier for the warehouse. example: Warehouse-001 shippingMethod: type: object description: >- The default for how goods in the transaction are shipped to the customer. If a shipping method is specified for a customer, the customer shipping method takes precedence as the default in the transaction. properties: href: type: string description: Endpoint for the shipping method. readOnly: true example: /objects/shipmethod/23 key: type: string description: System-assigned key for the shipping method example: '11' id: type: string description: Name or description of the shipping method. example: FedEx subtotalTemplate: type: object description: >- Specifies the template for populating the transaction subtotals table. properties: href: type: string description: Endpoint for the order entry subtotal template. readOnly: true example: /objects/order-entry/subtotal-template/23 key: type: string description: Subtotal template. example: 22 id: type: string description: Name of a order entry subtotal template. example: Subtotal template arTerm: type: object description: >- Accounts Receivable (AR) term, which determines the expiration date for quotes and the due date for invoices. properties: href: type: string description: Endpoint for the term. readOnly: true example: /objects/term/23 key: type: string description: System-assigned key for the AR term. example: '21' id: type: string description: The name of AR term. example: 10 Days exchangeRateType: type: object properties: key: type: string description: The ID of the exchange rate type. example: '-1' id: type: string description: The name of exchange rate type. example: Intacct Daily Rate href: type: string description: Endpoint for the exchangeratetype. readOnly: true example: /objects/exchange-rate-type/-1 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' COGSGLDetail: type: array description: >- Specify the COGS GL accounts to debit and credit. For companies that do not use Inventory Control, these accounts are required when Enable costing for non-inventoried items is set to true and Transaction posting is set to Accounts Receivable. items: $ref: '#/components/schemas/order-entry-txn-definition-cogs-gl-detail' accountReceivableOrDirectGLDetail: type: array description: >- When Transaction posting is set to Accounts Receivable or General Ledger, specify the AR or GL accounts to debit and credit. items: $ref: '#/components/schemas/order-entry-txn-definition-ar-direct-gl-detail' additionalGLDetail: type: array description: >- When Transaction posting is set to Accounts Receivable and Enable additional posting is set to true, specify the GL account details for additional GL account posting. These accounts are used to reverse the previous transaction in the workflow. items: $ref: '#/components/schemas/order-entry-txn-definition-additional-gl-detail' inventoryTotalDetail: type: array description: Inventory total detail for Order Entry transaction items: $ref: '#/components/schemas/order-entry-txn-definition-inventory-total-detail' subtotalDetail: type: array description: sub-total detail for Order Entry transaction items: $ref: '#/components/schemas/order-entry-txn-definition-subtotal-detail' sourceDocumentDetail: type: array description: Document conversion detail for an Order Entry transaction items: $ref: '#/components/schemas/order-entry-txn-definition-source-document-detail' entitySettingDetail: type: array description: Entity detail for order entry transaction items: $ref: '#/components/schemas/order-entry-txn-definition-entity-setting-detail' order-entry-txn-definition-additional-gl-detailRequiredProperties: required: - id order-entry-txn-definition-ar-direct-gl-detailRequiredProperties: required: - id order-entry-txn-definition-cogs-gl-detailRequiredProperties: required: - id order-entry-txn-definition-entity-setting-detailRequiredProperties: required: - entity order-entry-txn-definition-inventory-total-detailRequiredProperties: required: - inventoryTotal - maintainType - operation order-entry-txn-definition-source-document-detailRequiredProperties: required: - sourceDocument order-entry-txn-definition-subtotal-detailRequiredProperties: required: - id - glAccount - offsetGLAccount - subtotalType - valueType - txnType - description order-entry-billing-scheduleRequiredProperties: type: object required: - id order-entry-billing-schedule: type: object description: >- This object provides order entry billing schedule information, including billing template details. properties: key: type: string description: System-assigned key for the order entry billing schedule. readOnly: true example: '23' id: type: string description: >- ID for the order entry billing schedule. This value is the same as key for this object and can be ignored. Use key for all references to this object. readOnly: true example: '23' href: type: string description: URL for the order entry billing schedule. readOnly: true example: /objects/order-entry/billing-schedule/23 billingTemplate: type: object description: Project billing template associated with the billing schedule. properties: key: type: string description: System-assigned key for the billing template. example: null id: type: string description: ID for the billing template. example: null templateId: type: string description: Short and descriptive identifier for the billing template. example: null href: type: string description: URL for the project billing template. readOnly: true example: /objects/projects/project-billing-template/23 description: type: string description: Description of the project billing template. example: null billingMethod: type: string description: >- Indicates whether to bill services by percent completed or by milestone. example: null enum: - percentCompleted - milestone calculateOn: type: string description: >- Indicates whether to calculate billing on a project basis or a task basis. example: null orderEntryDocument: type: object description: Order entry document associated with the billing schedule. properties: key: type: string description: Key for the document header. id: type: string description: Name or other unique identifier for the order entry document. example: null href: type: string description: URL for the order entry document. readOnly: true example: /objects/order-entry/document/23 sourceTransaction: type: string description: Source transaction. example: null sourceTransactionDate: type: string description: Source transaction date. example: null orderEntryDocumentLine: type: object description: Line item in the associated order entry document. properties: key: type: string description: System-assigned key for the document line item. example: null id: type: string description: ID for the document line item. example: null href: type: string description: URL for the document line item. readOnly: true example: /objects/order-entry/document-line/23 projectKey: type: string description: Project key example: null taskKey: type: string description: Task key example: null transactionValue: type: string description: Amount of the line item. example: null lineNumber: type: string description: Line number example: null status: type: string description: Status of the billing schedule. example: null enum: - notStarted - inProgress - completed - closed default: notStarted order-entry-price-scheduleRequiredProperties: type: object required: - id order-entry-price-schedule: type: object description: Sales Price Schedule properties: key: type: string description: Schedule Code readOnly: true id: type: string description: Schedule Code href: type: string readOnly: true description: type: string description: Price schedule description priceList: type: object properties: key: type: string description: Price List id: type: string description: Price List href: type: string readOnly: true discountPercent: type: string description: Discount % status: $ref: '#/components/schemas/status' order-entry-renewal-templateRequiredProperties: type: object required: - id order-entry-renewal-template: type: object description: Header information for Order Entry and contract renewal templates. properties: key: type: string description: System-assigned key for the order-entry-renewal-template. readOnly: true example: '23' id: type: string description: Order entry renewal template ID. example: Sales Renewal Template href: type: string description: URL for the order-entry-renewal-template. readOnly: true example: /objects/order-entry/renewal-template/23 description: type: string description: Description. example: description of an order entry renewal template salesTxnCreation: type: object properties: createSalesTxn: type: boolean description: Create sales transaction. example: false default: false transactionDefinition: type: object properties: href: type: string description: URL for the order-entry-txn-definition. readOnly: true example: /objects/order-entry/txn-definition/23 key: type: string description: Sales transaction key. example: '1' id: type: string description: Sales transaction type. example: Sales Invoice daysBeforeAfter: type: integer description: >- Amount of days before or after the Contract End Date for the SO transaction. example: 10 default: 10 beforeAfterContractEndDate: type: string description: After or before Contract End Date for SO transaction. example: before enum: - before - after default: before txnDateOnRenewedDocument: type: string description: Date on renewed document. example: calculatedDate enum: - calculatedDate - contractEndDate+1 default: contractEndDate+1 startDateOnRenewedDocument: type: string description: Start date of renewed contract. example: sameAsDocumentDate enum: - sameAsDocumentDate - withInheritedOffsetFromParent default: sameAsDocumentDate pricing: type: object properties: pricingType: type: string description: Pricing type. example: sameAsOriginal enum: - sameAsOriginal - defaultPricing - markup/markdown default: sameAsOriginal markup: type: string description: Pricing markup. example: percentageMarkup enum: - percentageMarkup - percentageDiscount - actualMarkup - actualDiscount default: percentageMarkup markupValue: type: string description: Pricing markup by value. example: '1.00' notifications: type: object properties: customer: type: object properties: sendToCustomer: type: boolean description: Customer email. example: false default: false contact: type: string description: Contact. example: customerContact enum: - customerContact - transactionBillToContact - transactionShipToContact default: customerContact daysBeforeAfter: type: integer description: When to send email alert to customer. example: 0 default: 0 beforeAfterContractRenewalDate: type: string description: After or before for customer for contract renewal alert. example: before enum: - before - after default: before customerEmailTemplate: type: object properties: key: type: string description: Customer email template Key. example: '1' id: type: string description: Customer email template Id. Same value as key. example: '1' href: type: string description: URL for the email template. readOnly: true example: /objects/company-config/email-template/23 internal: type: object properties: sendToInternal: type: boolean description: Internal email. example: false default: false daysBeforeAfter: type: integer description: When to send email notification. example: 10 default: 10 beforeAfterContractRenewalDate: type: string description: After or before for sales team notification. example: before enum: - before - after default: before internalEmailTemplate: type: object properties: key: type: string description: internal email template key. example: '1' id: type: string description: internal email template Id. Same value as key. example: '1' href: type: string description: URL for the email template. readOnly: true example: /objects/company-config/email-template/23 latestVersion: type: string description: Latest version key. example: '???' transactionType: type: string description: Transaction type. example: salesTransaction enum: - salesTransaction - contract - evergreen default: salesTransaction termLength: type: string description: Default renewal term length. example: '5' termPeriod: type: string description: Default renewal term period. example: months enum: - years - months - days default: months state: type: string description: Create renewal as. example: draft enum: - inProgress - draft default: inProgress status: $ref: '#/components/schemas/status' order-entry-subtotal-templateRequiredProperties: type: object required: - id order-entry-subtotal-template: type: object description: Order Entry Subtotal Template properties: key: type: string description: key readOnly: true id: type: string description: id href: type: string readOnly: true responses: 400error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error-response' securitySchemes: OAuth2: description: Sage Intacct OAuth 2.0 authorization code flow type: oauth2 flows: authorizationCode: authorizationUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/authorize tokenUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/token refreshUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/token scopes: {} parameters: OrderEntryDocumentName: name: documentName in: path required: true schema: type: string description: Document name documentName: name: documentName in: path required: true schema: type: string description: Document Name