openapi: 3.0.3 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 tags: - name: Document histories description: >- An Order Entry document history contains one entry for each existing transaction in the workflow associated with the selected transaction. x-displayName: Document histories - name: Document line details description: >- List of warehouse inventory details including serial number, aisle, bin, and row per line item. x-displayName: Document line details - name: Document line subtotals description: >- Details of the subtotals, taxes, discounts, charges, and more for the document line. x-displayName: Document line subtotals - name: Document lines description: Line items in an Order Entry document represent Order Entry transactions. x-displayName: Document lines - name: Document subtotals description: >- Details of subtotals, taxes, discounts, charges, and more for an Order Entry transaction. x-displayName: Document subtotals - name: Documents description: > An Order Entry document contains information about sales transactions. An order entry transaction can be a quote, order, shipper, invoice, or adjustment. When you create a new document, it represents the first transaction in a workflow, and it can only be converted to the next transaction in a workflow. See [Transactions - Order Entry](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Using_Order_Entry/Transactions/OE-transactions.htm?tocpath=Applications%7COrder%20Entry%7CTransactions%7C_____1) in the Sage Intacct Help Center for more information. x-displayName: Documents - name: Price list entries description: >- An sales order price list entry contains the pricing for a selected item within a selected price list. You can create price list entries for items whose prices are determined based on an amount, a discount or mark up percentage, the quantity sold, and more. x-displayName: Price list entries - 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: Renewal templates description: >- A renewal template defines a set of actions Sage Intacct will perform when a contract reaches its end date. x-displayName: Renewal templates - name: Subtotal template lines description: >- This object contains detailed information for Order Entry subtotal template lines. x-displayName: Subtotal template lines - 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. x-displayName: Subtotal templates - name: Transaction definition additional GL details description: > Use this object for additional General Ledger account mapping. When additional GL posting is enabled for the owning transaction definition, the `postToGL` field is set to `true`, additional GL posting account mapping is available. The item GL group and warehouse together form the criteria set for the account mapping. For more information, see [Transaction definitions - Order Entry](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Transaction_definitions/order-entry-transaction-definitions.htm) in the Sage Intacct Help Center. x-displayName: Transaction definition additional GL details - name: Accounts Receivable or direct GL account details description: > If the owning Order Entry transaction definition has transaction posting set to either Accounts Receivable or General Ledger (the `txnPostingMethod` field is set to `toAR` or `toGL`), the applicable account mapping is defined using this object. The item GL group, warehouse, and customer GL group together form the criteria set for the account mapping. For more information, see [Transaction definitions - Order Entry](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Transaction_definitions/order-entry-transaction-definitions.htm) in the Sage Intacct Help Center. x-displayName: Accounts Receivable or direct GL account details - name: Transaction definition COGS details description: > This object holds the COGS account and Inventory account mapping for the owning transaction definition. This account mapping is supported if: * Your company subscribes to Inventory Control. * Your company does not subscribe to Inventory Control, but `enableCosting` is set to `true` in the owning transaction definition. The item GL group, warehouse, and customer GL group together form the criteria set for the account mapping. For more information, see [Transaction definitions - Order Entry](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Transaction_definitions/order-entry-transaction-definitions.htm) in the Sage Intacct Help Center. x-displayName: Transaction definition COGS details - name: Transaction definition entity details description: > The fields in this object are applicable if the owning transaction definition allows transactions to be created from the top level or entity (`topLevelOrEntity`) or entity level only (`entityOnly`). You can use this object to define different settings for each entity. For more information, see [Transaction definitions - Order Entry](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Transaction_definitions/order-entry-transaction-definitions.htm) in the Sage Intacct Help Center. 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 quantity, value, or both, and whether the running total will increase or decrease when the user saves the transaction. For more information, see [Transaction definitions - Order Entry](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Transaction_definitions/order-entry-transaction-definitions.htm) in the Sage Intacct Help Center. x-displayName: Transaction definition inventory total details - name: Transaction definition source document details description: > Specifies the transaction definition from which the transaction can be converted. For more information, see [Transaction definitions - Order Entry](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Transaction_definitions/order-entry-transaction-definitions.htm) in the Sage Intacct Help Center. x-displayName: Transaction definition source document details - name: Transaction definition subtotal details description: > When `enableSubtotals` in the owning transaction definition is set to `true`, use this object to provide subtotal details for that transaction definition. For more information, see [Transaction definitions - Order Entry](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Transaction_definitions/order-entry-transaction-definitions.htm) in the Sage Intacct Help Center. x-displayName: Transaction definition subtotal details - name: Transaction definitions description: > A transaction definition is the template for a sales transaction. It contains the accounting rules, workflow settings, and other configuration settings that determine a transaction's behavior. See [About transaction definitions - Order Entry](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Transaction_definitions/about-order-entry-transaction-definitions.htm?tocpath=Applications%7COrder%20Entry%7CSetup%7CTransaction%20definitions%7C_____1) in the Sage Intacct Help Center for more information. x-displayName: Transaction definitions paths: /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 example: '183' 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/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 detail object. 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 detail object. in: path required: true schema: type: string example: '10' get: summary: Get a document line detail object description: >- Returns detailed information for a specified order entry document line detail object. 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 object: 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-line-subtotal: get: summary: List document line subtotals description: >- Returns a collection with a key, ID, and link for each document line subtotal. tags: - Document line subtotals operationId: list-order-entry-document-line-subtotal responses: '200': description: OK content: application/json: schema: type: object title: List of document-line-subtotal objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document line subtotals: value: ia::result: - key: '23' id: '23' href: /objects/order-entry/document-line-subtotal/23 - key: '22' id: '22' href: /objects/order-entry/document-line-subtotal/22 - key: '21' id: '21' href: /objects/order-entry/document-line-subtotal/21 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-line-subtotal/{key}: parameters: - name: key description: System-assigned unique key for the document line subtotal. in: path required: true schema: type: string example: '104' get: summary: Get a document line subtotal description: Returns detailed information for a specified document line subtotal. tags: - Document line subtotals operationId: get-order-entry-document-line-subtotal-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the document-line-subtotal properties: ia::result: $ref: '#/components/schemas/order-entry-document-line-subtotal' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document line subtotal: value: ia::result: id: '22' key: '22' document: id: '24' key: '24' href: /objects/order-entry/document/24 description: 1) G1 Goods and Services Tax absoluteValue: '11.00000000' percentValue: '10.00000000' total: null status: active taxDetail: key: '20' id: G1 Goods and Services Tax href: /objects/tax/tax-detail/20 dimensions: location: key: '4' id: '4' name: Australia href: /objects/company-config/location/4 department: key: null id: null name: null txnAbsoluteValue: '11.00000000' txnTotal: null documentLine: id: '10' key: '10' href: /objects/order-entry/document-line/10 enableOverrideTax: false systemTaxDetail: key: null id: null href: /objects/order-entry/document-line-subtotal/22 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
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. example: '19' get: summary: Get a document line description: >+ Returns detailed information for a specified Order Entry document line.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
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: '12' key: '12' href: /objects/inventory-control/warehouse/12 location: id: '21' key: '21' href: /objects/company-config/location/21 customer: key: '23' id: '23' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/23 item: key: '6' id: '6' href: /objects/inventory-control/item/6 unit: Each quantity: '10' quantityConverted: '1' retailPrice: '222' price: '333' audit: createdDateTime: '2024-12-18T00:00:00Z' modifiedDateTime: '2024-12-18T10:27:15Z' createdBy: '5' modifiedBy: '5' status: active unitQuantity: '1' multiplier: 1 unitPrice: '333' txnCurrency: USD baseCurrency: USD priceInTxnCurrency: '333' conversionType: quantity allowDropship: false allowBuyToOrder: false quantityRemaining: '10' trackingDetail: [] lineSubtotals: [] href: /objects/order-entry/document-line::Sales%20Order/925 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Get a document line (Construction): value: ia::result: key: '44' id: '44' href: /objects/order-entry/document-line::Sales%20Invoice/44 documentType: Sales Invoice lineNumber: 1 item: key: '10' id: MX001 href: /objects/inventory-control/item/10 itemAlias: key: '6' id: IXN href: '/objects/accounts-receivable/customer-item-cross-reference/6' memo: Payment ACH priceCalculationMemo: Fair value price list unit: Each quantity: '40.10' unitQuantity: '10.10' unitPrice: '10.50' price: '33.66' quantityConverted: '5.10' retailPrice: '10.44' audit: createdDateTime: '2024-04-20T16:20:00Z' modifiedDateTime: '2024-04-20T16:20:00Z' createdBy: '9' modifiedBy: '95' status: active costMethod: average discountPercent: '10.50' multiplier: 1 sourceDocument: key: '77' id: Sales Order-SO0022 documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/77 sourceDocumentLine: key: '2234' id: '2234' documentType: Sales Order href: /objects/order-entry/document-line::Sales%20Order/2234 isPriceProrated: true discountMemo: Festival discount baseCurrency: USD txnCurrency: CAD priceInTxnCurrency: '10.00' isBillable: true isBilled: true taxRate: '10.05' taxInBaseCurrency: '10.50' taxInTxnCurrency: '40.50' discount: '10.25' enableTax: false quantityRemaining: '10.10' conversionType: quantity dimensions: location: key: '22' id: LOC-22 name: California href: /objects/company-config/location/22 department: key: '9' id: Sales name: Sales and Marketing href: /objects/company-config/department/9 employee: key: '10' id: EMP-10 name: Thomas, Glenn href: /objects/company-config/employee/10 project: key: '2' id: NET-XML30-2 name: Talcomp training href: /objects/projects/project/2 customer: key: '13' id: CUST-13 name: Rancho Nuevo href: /objects/accounts-receivable/customer/13 vendor: key: '357' id: '1605212096809' name: GenLab href: /objects/accounts-payable/vendor/357 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 warehouse: key: '6' id: WH01 name: WH01 href: /objects/inventory-control/warehouse/6 class: key: '731' id: REST_CLS_001 name: Enterprises href: /objects/company-config/class/731 task: id: TSK01 key: '1' name: Project Task href: /objects/projects/task/1 costType: id: '2' key: '2' name: Project Expense href: /objects/construction/cost-type/2 asset: id: A001 key: '1' name: Laptop 1 contract: id: CON-0045-1 key: '12' name: ACME Widgets - Service href: /objects/contracts/contract/12 itemRenewalTemplate: key: '45' id: Sales Renewal Template href: /objects/order-entry/renewal-template/45 revenueRecognitionStartDate: '2024-04-04' revenueRecognitionEndDate: '2026-04-04' requestedShippingDate: '2024-04-04' shipByDate: '2024-04-04' pickTicketPrintedDate: '2024-04-04' cancelAfterDate: '2024-04-15' doNotShipBeforeDate: '2024-04-04' doNotShipAfterDate: '2024-04-15' shippedDate: '2024-04-04' allowDropship: true allowBuyToOrder: true revision: unitQuantity: '10' quantity: '10' unitValue: '8.00' value: '8.00' valueInTxnCurrency: '10.00' price: '10.00' unitPrice: '10.00' priceInTxnCurrency: '10.00' draft: unitQuantity: '10' quantity: '10' price: '20.00' basePrice: '20.00' posted: quantity: '10.00' price: '20.00' basePrice: '20.00' addedByChangeDocument: false projectContractBilling: externalReferenceNumber: HGS-1024 description: Construction of clubhouse and offices billingType: timeAndMaterial contractLineValue: '1000.00' priorApplicationAmount: '1000.00' completedThisPeriodAmount: '1000.00' storedMaterialsAmount: '1000.00' completedToDateAmount: '1000.00' completedToDatePercent: '10.00' balanceRemaining: '1000.00' totalConvertedAmount: '1000.00' totalRemainingAmount: '1000.00' isSummarized: false retainage: percentage: '10.00' baseAmountRetained: '10.00' txnAmountRetained: '10.00' isReleaseLine: true previousBalanceAmount: '1000.00' billAmount: '1000.00' balanceAmount: '1000.00' extendedPriceNetAmount: '1000.00' extendedBasePriceNetAmount: '1000.00' isReverseConversion: false reverseConversion: price: '100.00' quantity: '100' standardPrice: '100.00' standardQuantity: '100' relatedDocument: key: '5151' id: Sales Order-SD-SO0550 href: /objects/order-entry/document/5151 relatedDocumentLine: key: '13965' id: 1--0001 href: /objects/order-entry/document-line/13965 projectContract: key: '1' id: BTI-01 name: Berkeley Technology Inc - Contract 01 href: /objects/construction/project-contract/1 projectContractLine: key: '4' id: Project-Contract-Line-04 name: Project contract line 04 href: /objects/construction/project-contract-line/4 taxSchedule: key: '1' id: Sale Goods Standard href: /objects/tax/order-entry-tax-schedule/1 buyToOrderContact: key: '13' id: contact trackingDetail: - key: '55' id: '55' href: /objects/order-entry/document-line-detail/55 quantity: '10' serialNumber: S1001 lotNumber: L1001 expirationDate: '2023-04-04' aisle: href: /objects/inventory-control/aisle/10 key: '10' id: AISLE1 bin: href: /objects/inventory-control/bin/20 key: '20' id: BIN1 row: href: /objects/inventory-control/row/15 key: '15' id: ROW1 item: key: '10' id: Battery href: /objects/inventory-control/item/10 audit: createdDateTime: '2024-04-20T16:20:00Z' modifiedDateTime: '2024-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' orderEntryDocumentLine: key: '23' id: '23' documentType: Sales Order href: '/objects/order-entry-document-line::Sales%20Order/23' lineSubtotals: [] documentHeader: key: '55' id: Sales Invoice-SO0066 documentType: Sales Invoice href: /objects/order-entry-document::Sales%20Invoice/55 ia::meta: totalCount: 3 totalSuccess: 2 totalError: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-line::{documentName}: parameters: - name: documentName in: path required: true schema: type: string description: Document name example: Sales Invoice get: summary: List lines for named documents description: >+ Returns a collection with a key, ID, and link for each line that exists in documents with the specified name. For example, to list all lines within documents that are based on the Sales Invoice transaction definition, specify `Sales Invoice` as the `documentName` in the request URL. 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 typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
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%20Invoice/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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Add Order Entry documents
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: 42' location: id: '5' 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: Reference to 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: [] /objects/order-entry/document-line::{documentName}/{key}: parameters: - name: documentName in: path required: true schema: type: string description: Document name example: Sales Invoice - name: key description: System-assigned key for the Order Entry document line. example: '63' in: path required: true schema: type: string get: summary: Get a line in a named document description: >+ Returns detailed information for a specified document line. For example, to get a line within a document that is based on the Sales Invoice transaction definition, specify `Sales Invoice` for the `documentName` in the request URL.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
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 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: 1 dimensions: item: key: '11' id: '11' name: PC Computer href: /objects/inventory-control/item/11 warehouse: id: '6' key: '6' href: /objects/inventory-control/warehouse/6 location: id: '13' key: '13' href: /objects/company-config/location/13 customer: key: '9' id: '9' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/9 item: key: '11' id: '11' href: /objects/inventory-control/item/11 unit: Each quantity: '1' quantityConverted: '1' retailPrice: '222' price: '333' audit: createdDateTime: '2024-12-18T00:00:00Z' modifiedDateTime: '2024-12-18T10:27:15Z' createdBy: '4' modifiedBy: '4' status: active unitQuantity: '1' multiplier: 1 unitPrice: '333' txnCurrency: USD baseCurrency: USD priceInTxnCurrency: '333' conversionType: quantity allowDropship: false allowBuyToOrder: false quantityRemaining: '16' trackingDetail: [] lineSubtotals: [] href: /objects/order-entry/document-line::Sales%20Order/925 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Get a document line - Construction: value: ia::result: key: '44' id: '44' href: /objects/order-entry/document-line::Sales%20Invoice/44 documentType: Sales Invoice lineNumber: 1 item: key: '10' id: MX001 href: /objects/inventory-control/item/10 itemAlias: key: '10' id: IXN href: '/objects/accounts-receivable/customer-item-cross-reference/10' memo: Payment ACH priceCalculationMemo: Fair value price list unit: Each quantity: '40.10' unitQuantity: '10.10' unitPrice: '10.50' price: '33.66' quantityConverted: '5.10' retailPrice: '10.44' audit: createdDateTime: '2024-04-20T16:20:00Z' modifiedDateTime: '2024-04-20T16:20:00Z' createdBy: '6' modifiedBy: '95' status: active costMethod: average discountPercent: '10.50' multiplier: 1 sourceDocument: key: '77' id: Sales Order-SO0022 documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/77 sourceDocumentLine: key: '2234' id: '2234' documentType: Sales Order href: /objects/order-entry/document-line::Sales%20Order/2234 isPriceProrated: true discountMemo: Festival discount baseCurrency: USD txnCurrency: CAD priceInTxnCurrency: '10.00' isBillable: true isBilled: true taxRate: '10.05' taxInBaseCurrency: '10.50' taxInTxnCurrency: '40.50' discount: '10.25' enableTax: false quantityRemaining: '10.10' conversionType: quantity dimensions: location: key: '22' id: LOC-22 name: California href: /objects/company-config/location/22 department: key: '9' id: Sales name: Sales and Marketing href: /objects/company-config/department/9 employee: key: '10' id: EMP-10 name: Thomas, Glenn href: /objects/company-config/employee/10 project: key: '2' id: NET-XML30-2 name: Talcomp training href: /objects/projects/project/2 customer: key: '13' id: CUST-13 name: Jack In the Box href: /objects/accounts-receivable/customer/13 vendor: key: '357' id: '1605212096809' name: GenLab href: /objects/accounts-payable/vendor/357 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 warehouse: key: '6' id: WH01 name: WH01 href: /objects/inventory-control/warehouse/6 class: key: '731' id: REST_CLS_001 name: Enterprises href: /objects/company-config/class/731 task: id: TSK01 key: '1' name: Project Task href: /objects/projects/task/1 costType: id: '2' key: '2' name: Project Expense href: /objects/construction/cost-type/2 asset: id: A001 key: '1' name: Laptop 1 contract: id: CON-0045-1 key: '12' name: ACME Widgets - Service href: /objects/contracts/contract/12 itemRenewalTemplate: key: '45' id: Sales Renewal Template href: /objects/order-entry/renewal-template/45 revenueRecognitionStartDate: '2024-04-04' revenueRecognitionEndDate: '2024-04-04' requestedShippingDate: '2024-04-04' shipByDate: '2024-04-04' pickTicketPrintedDate: '2024-04-04' cancelAfterDate: '2024-04-04' doNotShipBeforeDate: '2024-04-04' doNotShipAfterDate: '2024-04-04' shippedDate: '2024-04-04' servicePeriodStartDate: null servicePeriodEndDate: null allowDropship: true allowBuyToOrder: true revision: unitQuantity: '10' quantity: '10' unitValue: '8.00' value: '8.00' valueInTxnCurrency: '10.00' price: '10.00' unitPrice: '10.00' priceInTxnCurrency: '10.00' draft: unitQuantity: '15' quantity: '15' price: '10.00' basePrice: '10.00' posted: quantity: '10.00' price: '10.00' basePrice: '10.00' addedByChangeDocument: false projectContractBilling: externalReferenceNumber: HGS-1024 description: Construction of clubhouse and offices billingType: timeAndMaterial contractLineValue: '1000.00' priorApplicationAmount: '1000.00' completedThisPeriodAmount: '1000.00' storedMaterialsAmount: '1000.00' completedToDateAmount: '1000.00' completedToDatePercent: '10.00' balanceRemaining: '1000.00' totalConvertedAmount: '1000.00' totalRemainingAmount: '1000.00' isSummarized: false retainage: percentage: '10.00' baseAmountRetained: '10.00' txnAmountRetained: '10.00' isReleaseLine: true previousBalanceAmount: '1000.00' billAmount: '1000.00' balanceAmount: '1000.00' extendedPriceNetAmount: '1000.00' extendedBasePriceNetAmount: '1000.00' isReverseConversion: false reverseConversion: price: '100.00' quantity: '100' standardPrice: '100.00' standardQuantity: '100' relatedDocument: key: '5151' id: Sales Order-SD-SO0550 href: /objects/order-entry/document/5151 relatedDocumentLine: key: '13965' id: 1--0001 href: /objects/order-entry/document-line/13965 projectContract: key: '1' id: BTI-01 name: Berkeley Technology Inc - Contract 01 href: /objects/construction/project-contract/1 projectContractLine: key: '4' id: Project-Contract-Line-04 name: Project contract line 04 href: /objects/construction/project-contract-line/4 taxSchedule: key: '1' id: Sale Goods Standard href: /objects/tax/order-entry-tax-schedule/1 buyToOrderContact: key: '13' id: contact trackingDetail: - key: '55' id: '55' href: /objects/order-entry/document-line-detail/55 quantity: '10' serialNumber: S1001 lotNumber: L1001 expirationDate: '2023-04-04' aisle: href: /objects/inventory-control/aisle/10 key: '10' id: AISLE1 bin: href: /objects/inventory-control/bin/20 key: '20' id: BIN1 row: href: /objects/inventory-control/row/15 key: '15' id: ROW1 item: key: '10' id: Battery href: /objects/inventory-control/item/10 audit: createdDateTime: '2024-04-20T16:20:00Z' modifiedDateTime: '2024-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' orderEntryDocumentLine: key: '23' id: '23' documentType: Sales Order href: '/objects/order-entry-document-line::Sales%20Order/23' lineSubtotals: [] documentHeader: key: '55' id: Sales Invoice-SO0066 documentType: Sales Invoice href: /objects/order-entry-document::Sales%20Invoice/55 ia::meta: totalCount: 3 totalSuccess: 2 totalError: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a document line description: >+ Updates an existing document line by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Edit Order Entry documents
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: Reference to 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 a document line.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Delete Order Entry documents
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-subtotal: get: summary: List document subtotals description: >+ Returns a collection with a key, ID, and link for each Order Entry document subtotal. 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 typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
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 example: '15' schema: type: string get: summary: Get a document subtotal description: >+ Returns detailed information for a specified Order Entry document subtotal.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
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' 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: '2024-07-11T04:58:20Z' modifiedDateTime: '2024-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: get: summary: List Order Entry 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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
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. example: '446' get: summary: Get an Order Entry document description: >+ Returns detailed information for a specified Order Entry document.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
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 txnDate: '2024-03-29' audit: createdDateTime: '2024-11-10T18:36:30Z' createdBy: '1' modifiedBy: '1' modifiedDateTime: '2024-11-10T18:36:32Z' entity: key: '46' id: CORP name: Corp href: /objects/company-config/entity/46 status: active 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: '2024-03-29' rate: '1' subtotalInTxnCurrency: '750.55' totalInTxnCurrency: '742.5' baseCurrency: USD isSystemGeneratedDocument: false postingDate: '2024-03-29' paymentStatus: open customer: key: '1' id: '1' name: Power Aerospace Materials 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: '2024-03-29T00:00:00Z' modifiedDateTime: '2024-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: [] lineSubtotals: [] 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' 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: '2024-11-10T18:36:31Z' modifiedDateTime: '2024-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' 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: '2024-11-10T18:36:31Z' modifiedDateTime: '2024-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' 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: '2024-11-10T18:36:31Z' modifiedDateTime: '2024-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 Get a document - Construction subscription: value: ia::result: key: '55' id: Sales Invoice-SI-O122 href: /objects/order-entry/document::Sales%20Invoice/55 documentNumber: SI-O122 documentType: Sales Invoice state: draft isPrinted: true isBackordered: false subtotal: '50.10' subtotalInTxnCurrency: '51.10' total: '100.10' totalInTxnCurrency: '100.11' baseCurrency: USD txnCurrency: USD exchangeRate: date: '2023-01-23' rate: '1.0789' typeId: '1' typeName: Intacct Daily Rate txnDate: '2024-04-04' dueDate: '2024-04-04' isSystemGeneratedDocument: true postingDate: '2024-04-04' referenceNumber: SALES-100 notes: Fast order memo: Lowry solutions contractID: CN100123 contractDescription: Sales & Service paymentStatus: paid invoiceDate: '2024-04-04' customerPONumber: ABOTT-1001 trackingNumber: TK-1002 shipByDate: '2024-04-04' shippedDate: '2024-04-04' serviceDeliveryDate: '2024-04-04' cancelAfterDate: '2024-04-15' doNotShipBeforeDate: '2024-04-03' doNotShipAfterDate: '2024-04-15' requestedShippingDate: '2024-04-04' retainagePercent: 10 scope: >- Subcontractor agrees to provide labor and materials for utility trenching for Five Oaks Storage facilities according to contract. inclusions: Includes drive through building exclusions: Excludes additional purchase terms: >- Follow all safety rules and security procedure that are in force and applicable during execution of work. schedule: scheduledStartDate: '2024-05-07' scheduledCompletionDate: '2024-10-07' actualStartDate: '2024-05-07' actualCompletionDate: '2024-10-10' revisedCompletionDate: '2024-11-01' substantialCompletionDate: '2024-10-10' noticeToProceedDate: '2024-10-10' responseDueDate: '2024-10-10' executedOnDate: '2024-10-10' scheduleImpactNotes: None internalReference: referenceNumber: INT-01 initiatedBy: key: '2' id: dhatchet name: David Hatcher href: /objects/company-config/employee/2 verbalApprovalBy: key: '2' id: sdye name: Sara Dye href: /objects/company-config/employee/2 issuedBy: key: '25' id: amarquess name: Adam Marquess href: /objects/company-config/employee/25 issuedOnDate: '2023-05-30' approvedBy: key: '1' id: treser name: Tim Reser href: /objects/company-config/employee/1 approvedOnDate: '2023-10-02' signedBy: key: '32' id: broberts name: Bob Roberts href: /objects/company-config/employee/32 signedOnDate: '2023-05-31' source: Internal sourceReferenceNumber: REF-INT-01 externalReference: referenceNumber: A23 verbalApprovalBy: key: '6' id: Johnson href: /objects/company-config/contact/6 approvedBy: key: '51' id: Jagadish href: /objects/company-config/contact/51 approvedOnDate: '2023-11-03' signedBy: key: '200' id: Modulus Industries href: /objects/company-config/contact/200 signedOnDate: '2023-12-01' performanceBond: isRequired: false isReceived: false amount: '1000.00' vendor: key: '1' id: VND-IND-0081 name: Vendor-India-0081 href: /objects/accounts-payable/vendor/1 paymentBond: isRequired: false isReceived: false amount: '1000.00' vendor: key: '1' id: VND-IND-0081 name: Vendor-India-0081 href: /objects/accounts-payable/vendor/1 revision: isDocumentChanged: false revisedTotal: '1000.00' revisedSubTotal: '1000.00' revisedTotalInTxnCurrency: '1000.00' revisedSubTotalInTxnCurrency: '1000.00' changeLogNumber: 1 relatedDocumentNumber: Sales Invoice-Sal#0140#inv postedChangesTotal: '1000.00' projectContractBilling: externalReferenceNumber: HGS-1024 description: Construction of clubhouse and offices contractDate: '2024-05-08' billingThroughDate: '2024-05-08' billingApplicationNumber: IA-89115 billingSummary: originalContractAmount: '1000.00' netChangesAmount: '1000.00' revisedContractAmount: '1000.00' balanceToFinishAmount: '1000.00' lessPriorApplicationAmount: '1000.00' currentDueAmount: '1000.00' retainage: previousBalanceAmount: '1000.00' balanceAmount: '1000.00' billedAmount: '1000.00' heldAmount: '1000.00' completedAmount: '1000.00' storedMaterialsAmount: '1000.00' billingTotals: completedToDateAmount: '1000.00' storedMaterialsAmount: '1000.00' heldAmount: '1000.00' heldToDateAmount: '1000.00' retainageOnThisInvoiceAmount: '1000.00' earnedLessRetainageAmount: '1000.00' lessRetainageHeldAmount: '1000.00' netChangesAmount: '1000.00' netChangesAdditionAmount: '1000.00' netChangesDeductionAmount: '1000.00' totalChangesApprovedPriorMonth: additionsAmount: '1000.00' deductionsAmount: '1000.00' totalChangesApprovedThisMonth: additionsAmount: '1000.00' deductionsAmount: '1000.00' architect: key: '1' id: Eberhardt href: /objects/company-config/contact/12 projectContract: key: '1' id: BTI-01 name: Berkeley Technology Inc - Contract 01 href: /objects/construction/project-contract/1 contacts: primary: key: '13' id: contact shipTo: key: '33' id: contact billTo: key: '44' id: contact shippingMethod: key: '77' id: Air href: /objects/accounts-receivable/shipping-method/77 printedByUser: key: '21' id: John href: /objects/company-config/user/21 txnDefinition: key: '11' id: Sales Invoice href: /objects/order-entry/txn-definition/11 sourceDocument: key: '44' id: Sales Order-SO0022 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/44 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/15 contract: key: '46' id: CNRT1001 href: /objects/contracts/contract/46 paymentTerm: href: /objects/term/75 key: '75' id: 10 Days audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' entity: key: '46' id: CORP name: Corp href: /objects/company-config/entity/46 status: active taxSolution: key: '44' id: Avalara href: /objects/tax/tax-solution/44 taxCalculationMethod: noTax showMultilineTax: true lines: - key: '44' id: '44' href: '/objects/order-entry/document-line::Sales%20Invoice/44' documentType: Sales Invoice lineNumber: 1 item: key: '10' id: MX001 href: /objects/inventory-control/item/10 itemAlias: key: '10' id: IXN href: '/objects/accounts-receivable/customer-item-cross-reference/10' memo: Payment ACH priceCalculationMemo: Fair value price list unit: Each quantity: '40.10' unitQuantity: '10.10' unitPrice: '10.50' price: '33.66' quantityConverted: '5.10' retailPrice: '10.44' audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' status: active costMethod: average discountPercent: '10.50' multiplier: 1 sourceDocument: key: '77' id: Sales Order-SO0022 documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/77 sourceDocumentLine: key: '2234' id: '2234' documentType: Sales Order href: '/objects/order-entry/document-line::Sales%20Order/2234' isPriceProrated: true discountMemo: Festival discount baseCurrency: USD txnCurrency: CAD priceInTxnCurrency: '10.00' isBillable: true isBilled: true taxRate: '10.05' taxInBaseCurrency: '10.50' taxInTxnCurrency: '40.50' discount: '10.25' enableTax: false quantityRemaining: '10.10' conversionType: quantity dimensions: location: key: '22' id: LOC-22 name: California href: /objects/company-config/location/22 department: key: '9' id: Sales name: Sales and Marketing href: /objects/company-config/department/9 employee: key: '10' id: EMP-10 name: Thomas, Glenn href: /objects/company-config/employee/10 project: key: '2' id: NET-XML30-2 name: Talcomp training href: /objects/projects/project/2 customer: key: '13' id: CUST-13 name: Jack In the Box href: /objects/accounts-receivable/customer/13 vendor: key: '357' id: '1605212096809' name: GenLab href: /objects/accounts-payable/vendor/357 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 warehouse: key: '6' id: WH01 name: WH01 href: /objects/inventory-control/warehouse/6 class: key: '731' id: REST_CLS_001 name: Enterprises href: /objects/company-config/class/731 task: id: TSK01 key: '1' name: Project Task href: /objects/projects/task/1 costType: id: '2' key: '2' name: Project Expense href: /objects/construction/cost-type/2 asset: id: A001 key: '1' name: Laptop 1 contract: id: CON-0045-1 key: '12' name: ACME Widgets - Service href: /objects/contracts/contract/12 itemRenewalTemplate: key: '45' id: Sales Renewal Template href: /objects/order-entry/renewal-template/45 revenueRecognitionStartDate: '2024-04-04' revenueRecognitionEndDate: '2024-04-04' requestedShippingDate: '2024-04-04' shipByDate: '2024-04-15' pickTicketPrintedDate: '2024-04-04' cancelAfterDate: '2024-04-15' doNotShipBeforeDate: '2024-04-03' doNotShipAfterDate: '2024-04-15' shippedDate: '2024-04-04' allowDropship: true allowBuyToOrder: true revision: unitQuantity: '10' quantity: '10' unitValue: '8.00' value: '8.00' valueInTxnCurrency: '10.00' price: '10.00' unitPrice: '10.00' priceInTxnCurrency: '10.00' draft: unitQuantity: '10' quantity: '10' price: '10.00' basePrice: '10.00' posted: quantity: '10.00' price: '10.00' basePrice: '10.00' addedByChangeDocument: false projectContractBilling: externalReferenceNumber: HGS-1024 description: Construction of clubhouse and offices billingType: timeAndMaterial contractLineValue: '1000.00' priorApplicationAmount: '1000.00' completedThisPeriodAmount: '1000.00' storedMaterialsAmount: '1000.00' completedToDateAmount: '1000.00' completedToDatePercent: '10.00' balanceRemaining: '1000.00' totalConvertedAmount: '1000.00' totalRemainingAmount: '1000.00' isSummarized: false retainage: percentage: '10.00' baseAmountRetained: '10.00' txnAmountRetained: '10.00' isReleaseLine: true previousBalanceAmount: '1000.00' billAmount: '1000.00' balanceAmount: '1000.00' extendedPriceNetAmount: '1000.00' extendedBasePriceNetAmount: '1000.00' reverseConversion: isReverseConversion: false price: '100.00' quantity: '100' standardPrice: '100.00' standardQuantity: '100' relatedDocument: key: '5151' id: Sales Order-SD-SO0550 href: /objects/order-entry/document/5151 relatedDocumentLine: key: '13965' id: 1--0001 href: /objects/order-entry/document-line/13965 projectContract: key: '1' id: BTI-01 name: Berkeley Technology Inc - Contract 01 href: /objects/construction/project-contract/1 projectContractLine: key: '4' id: Project-Contract-Line-04 name: Project contract line 04 href: /objects/construction/project-contract-line/4 taxSchedule: key: '1' id: Sale Goods Standard href: /objects/tax/order-entry-tax-schedule/1 buyToOrderContact: key: '13' id: contact trackingDetail: - key: '55' id: '55' href: /objects/order-entry/document-line-detail/55 quantity: '10' serialNumber: S1001 lotNumber: L1001 expirationDate: '2024-04-04' aisle: href: /objects/inventory-control/aisle/10 key: '10' id: AISLE1 bin: href: /objects/inventory-control/bin/20 key: '20' id: BIN1 row: href: /objects/inventory-control/row/15 key: '15' id: ROW1 item: key: '10' id: Battery href: /objects/inventory-control/item/10 audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' orderEntryDocumentLine: key: '23' id: '23' documentType: Sales Order href: '/objects/order-entry-document-line::Sales%20Order/23' lineSubtotals: [] documentHeader: key: '55' id: Sales Invoice-SO0066 documentType: Sales Invoice href: /objects/order-entry-document::Sales%20Invoice/55 subtotals: - key: '12' id: '12' href: /objects/order-entry/document-subtotal/12 description: Tax percentValue: '10.50' absoluteValue: '40.50' txnAbsoluteValue: '44.78' total: '500.10' txnTotal: '400.10' documentLine: key: '10' documentType: Sales Order id: '10' href: '/objects/order-entry-document-line::Sales%20Order/10' audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' dimensions: location: key: '22' id: LOC-22 name: California href: /objects/company-config/location/22 department: key: '9' id: Accounting name: Sales and Marketing href: /objects/company-config/department/9 employee: key: '10' id: EMP-10 name: Thomas, Glenn href: /objects/company-config/employee/10 project: key: '2' id: NET-XML30-2 name: Talcomp training href: /objects/projects/project/2 customer: key: '13' id: CUST-13 name: Jack In the Box href: /objects/accounts-receivable/customer/13 vendor: key: '357' id: '1605212096809' name: GenLab href: /objects/accounts-payable/vendor/357 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 warehouse: key: '6' id: WH01 name: WH01 href: /objects/inventory-control/warehouse/6 class: key: '731' id: REST_CLS_001 name: Enterprises href: /objects/company-config/class/731 task: id: '1' key: '1' name: Project Task href: /objects/projects/task/1 costType: id: '2' key: '2' name: Project Expense href: /objects/construction/cost-type/2 asset: id: A001 key: '1' name: Laptop 1 contract: id: CON-0045-1 key: '12' name: ACME Widgets - Service href: /objects/contracts/contract/12 documentHeader: key: '23' id: '23' documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/23 history: - key: '11' id: '11' href: /objects/order-entry/document-history/11 convertedFrom: key: '22' id: Sales Order-ORINV#0182#doc documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/22 convertedTo: key: '14' id: Sales Invoice-SUBINV#0182#doc documentType: Sales Invoice href: /objects/order-entry-document::Sales%20Invoice/14 orderEntryDocument: key: '23' id: Sales Order-ORINV#0182#doc documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/22 ia::meta: totalCount: 3 totalSuccess: 2 totalError: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document::{documentName}: parameters: - name: documentName in: path required: true schema: type: string description: Document name get: summary: List named Order Entry documents description: >+ Returns a collection with a key, ID, and link for each Order Entry document with the specified name. For example, to list all documents that are based on the Sales Invoice transaction definition, specify `Sales Invoice` as the `documentName` in the request URL. 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 typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
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 an Order Entry document description: >+ Creates a new Order Entry document. To create a new document, specify the transaction definition that is the template for the new document as `documentName` in the request URL. When creating a new document, the field `state` must be set to one of these values: `pending`, `draft`, or `submitted`. If no value is specified for the `state` field, it defaults to `pending`. To access a list of available transaction definitions, use the [list transaction definitions](/openapi/sales/order-entry.txn-definition/tag//#tag//operation/list-order-entry-txn-definition) operation. For example, to create a new order entry document that uses the Sales Invoice transaction definition as a template, specify `Sales Invoice` for the `documentName` in the request URL.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Add Order Entry documents
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 txnDate: '2024-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' Create a document for Construction: value: customer: id: BTI state: pending txnDate: '2024-05-21' dueDate: '2024-12-12' txnCurrency: USD baseCurrency: USD notes: additional info order 01 scope: >- Subcontractor agrees to provide labor and materials for utility trenching for Five Oaks Storage facilities according to contract inclusions: Includes drive through building exclusions: Excludes additional purchase terms: >- Follow all safety rules and security procedure that are in force and applicable during execution of work schedule: scheduledStartDate: '2024-05-01' actualStartDate: '2024-05-03' scheduledCompletionDate: '2024-05-31' revisedCompletionDate: '2024-06-01' substantialCompletionDate: '2024-05-20' actualCompletionDate: '2024-05-30' noticeToProceedDate: '2024-05-25' responseDueDate: '2024-05-30' executedOnDate: '2024-05-05' scheduleImpactNotes: NA internalReference: referenceNumber: INT-01 initiatedBy: id: '10001' verbalApprovalBy: id: '10001' issuedBy: id: '10001' issuedOnDate: '2024-05-24' approvedBy: id: '10001' approvedOnDate: '2024-05-24' signedBy: id: '10001' signedOnDate: '2024-05-30' source: BTI-089 sourceReferenceNumber: '88009890' externalReference: referenceNumber: EXT-01 verbalApprovalBy: id: Berkeley Technology Inc approvedBy: id: Berkeley Technology Inc approvedOnDate: '2024-05-24' signedBy: id: Berkeley Technology Inc signedOnDate: '2024-05-30' performanceBond: isRequired: true isReceived: true amount: '4500.00' vendor: id: CITI paymentBond: isRequired: true isReceived: true amount: '5000.00' vendor: id: CITI lines: - dimensions: item: id: 0001--Design warehouse: id: '1' location: id: '1' unit: Each unitQuantity: '1' unitPrice: '650' Create a project contract billing document: value: customer: id: HC state: pending txnDate: '2024-05-21' txnCurrency: USD baseCurrency: USD paymentTerm: id: N15 dueDate: '2024-06-06' retainagePercent: 15 projectContract: id: 04 Sep A projectContractBilling: externalReferenceNumber: EXT_01 description: Contract 04 Sep A contractDate: '2024-05-30' billingThroughDate: '2024-06-30' billingApplicationNumber: A1002 architect: id: Berkeley Technology Inc lines: - dimensions: item: id: Design--Design location: id: '1' warehouse: id: '1' conversionType: price unit: Seconds unitQuantity: '1' unitPrice: '200' projectContract: id: 04 Sep A projectContractLine: id: L1 PB projectContractBilling: completedThisPeriodAmount: '100.0000000000' storedMaterialsAmount: '100.0000000000' 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: Reference to 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 Reference to new Construction document: value: ia::result: key: '5150' id: SO-Order02-SO0549 href: /objects/order-entry/document::SO-Order02/5150 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Reference to new project contract billing document: value: ia::result: key: '5156' id: SO-AIA-Invoice01-Ord#0191#doc href: /objects/order-entry/document::SO-AIA-Invoice01/5156 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document::{documentName}/{key}: parameters: - name: documentName in: path required: true schema: type: string description: Document name example: Sales Invoice - name: key description: System-assigned key for the document. example: '41' in: path required: true schema: type: string get: summary: Get a named Order Entry document description: >+ Returns detailed information for a specified Order Entry document. For example, to return details about an order entry document that uses the Sales Invoice transaction definition as a template, specify `Sales Invoice` for the `documentName` in the request URL.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
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 txnDate: '2024-03-29' audit: createdDateTime: '2024-11-10T18:36:30Z' createdBy: '1' modifiedBy: '1' modifiedDateTime: '2024-11-10T18:36:32Z' entity: key: '46' id: CORP name: Corp href: /objects/company-config/entity/46 status: active 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: '2024-03-29' rate: '1' subtotalInTxnCurrency: '750.55' totalInTxnCurrency: '742.5' baseCurrency: USD isSystemGeneratedDocument: false postingDate: '2024-03-29' paymentStatus: open customer: key: '1' id: '1' name: Power Aerospace Materials 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: '2024-03-29T00:00:00Z' modifiedDateTime: '2024-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 servicePeriodStartDate: null servicePeriodEndDate: null allowDropship: false allowBuyToOrder: false quantityRemaining: '1' trackingDetail: [] lineSubtotals: [] 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' 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: '2024-11-10T18:36:31Z' modifiedDateTime: '2024-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' 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: '2024-11-10T18:36:31Z' modifiedDateTime: '2024-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' 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: '2024-11-10T18:36:31Z' modifiedDateTime: '2024-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 Get a named document - Construction subscription: value: ia::result: key: '55' id: Sales Invoice-SI-O122 href: /objects/order-entry/document::Sales%20Invoice/55 documentNumber: SI-O122 documentType: Sales Invoice state: draft isPrinted: true isBackordered: false subtotal: '50.10' subtotalInTxnCurrency: '51.10' total: '100.10' totalInTxnCurrency: '100.11' baseCurrency: USD txnCurrency: USD exchangeRate: date: '2023-01-23' rate: '1.0789' typeId: '1' typeName: Intacct Daily Rate txnDate: '2024-04-04' dueDate: '2024-04-04' isSystemGeneratedDocument: true postingDate: '2024-04-04' referenceNumber: SALES-100 notes: Fast order memo: Lowry solutions contractID: CN100123 contractDescription: Sales & Service paymentStatus: paid invoiceDate: '2024-04-04' customerPONumber: ABOTT-1001 trackingNumber: TK-1002 shipByDate: '2024-04-15' shippedDate: '2024-04-04' serviceDeliveryDate: '2024-04-04' cancelAfterDate: '2024-04-15' doNotShipBeforeDate: '2024-04-03' doNotShipAfterDate: '2024-04-15' requestedShippingDate: '2024-04-04' retainagePercent: 10 scope: >- Subcontractor agrees to provide labor and materials for utility trenching for Five Oaks Storage facilities according to contract. inclusions: Includes drive through building exclusions: Excludes additional purchase terms: >- Follow all safety rules and security procedure that are in force and applicable during execution of work. schedule: scheduledStartDate: '2024-05-07' scheduledCompletionDate: '2024-10-07' actualStartDate: '2024-05-07' actualCompletionDate: '2024-10-10' revisedCompletionDate: '2024-11-01' substantialCompletionDate: '2024-10-10' noticeToProceedDate: '2024-10-10' responseDueDate: '2024-10-10' executedOnDate: '2024-10-10' scheduleImpactNotes: None internalReference: referenceNumber: INT-01 initiatedBy: key: '2' id: dhatchet name: David Hatcher href: /objects/company-config/employee/2 verbalApprovalBy: key: '2' id: sdye name: Sara Dye href: /objects/company-config/employee/2 issuedBy: key: '25' id: amarquess name: Adam Marquess href: /objects/company-config/employee/25 issuedOnDate: '2023-05-30' approvedBy: key: '1' id: treser name: Tim Reser href: /objects/company-config/employee/1 approvedOnDate: '2023-10-02' signedBy: key: '32' id: broberts name: Bob Roberts href: /objects/company-config/employee/32 signedOnDate: '2023-05-31' source: Internal sourceReferenceNumber: REF-INT-01 externalReference: referenceNumber: A23 verbalApprovalBy: key: '6' id: Johnson href: /objects/company-config/contact/6 approvedBy: key: '51' id: Jagadish href: /objects/company-config/contact/51 approvedOnDate: '2023-11-03' signedBy: key: '200' id: Modulus Industries href: /objects/company-config/contact/200 signedOnDate: '2023-12-01' performanceBond: isRequired: false isReceived: false amount: '1000.00' vendor: key: '1' id: VND-IND-0081 name: Vendor-India-0081 href: /objects/accounts-payable/vendor/1 paymentBond: isRequired: false isReceived: false amount: '1000.00' vendor: key: '1' id: VND-IND-0081 name: Vendor-India-0081 href: /objects/accounts-payable/vendor/1 revision: isDocumentChanged: false revisedTotal: '1000.00' revisedSubTotal: '1000.00' revisedTotalInTxnCurrency: '1000.00' revisedSubTotalInTxnCurrency: '1000.00' changeLogNumber: 1 relatedDocumentNumber: Sales Invoice-Sal#0140#inv postedChangesTotal: '1000.00' projectContractBilling: externalReferenceNumber: HGS-1024 description: Construction of clubhouse and offices contractDate: '2024-05-08' billingThroughDate: '2024-05-08' billingApplicationNumber: IA-89115 billingSummary: originalContractAmount: '1000.00' netChangesAmount: '1000.00' revisedContractAmount: '1000.00' balanceToFinishAmount: '1000.00' lessPriorApplicationAmount: '1000.00' currentDueAmount: '1000.00' retainage: previousBalanceAmount: '1000.00' balanceAmount: '1000.00' billedAmount: '1000.00' heldAmount: '1000.00' completedAmount: '1000.00' storedMaterialsAmount: '1000.00' billingTotals: completedToDateAmount: '1000.00' storedMaterialsAmount: '1000.00' heldAmount: '1000.00' heldToDateAmount: '1000.00' retainageOnThisInvoiceAmount: '1000.00' earnedLessRetainageAmount: '1000.00' lessRetainageHeldAmount: '1000.00' netChangesAmount: '1000.00' netChangesAdditionAmount: '1000.00' netChangesDeductionAmount: '1000.00' totalChangesApprovedPriorMonth: additionsAmount: '1000.00' deductionsAmount: '1000.00' totalChangesApprovedThisMonth: additionsAmount: '1000.00' deductionsAmount: '1000.00' architect: key: '1' id: Eberhardt href: /objects/company-config/contact/12 projectContract: key: '1' id: BTI-01 name: Berkeley Technology Inc - Contract 01 href: /objects/construction/project-contract/1 contacts: primary: key: '13' id: contact shipTo: key: '33' id: contact billTo: key: '44' id: contact shippingMethod: key: '77' id: Air href: /objects/accounts-receivable/shipping-method/77 printedByUser: key: '21' id: John href: /objects/company-config/user/21 txnDefinition: key: '11' id: Sales Invoice href: /objects/order-entry/txn-definition/11 sourceDocument: key: '44' id: Sales Order-SO0022 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/44 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/15 contract: key: '46' id: CNRT1001 href: /objects/contracts/contract/46 paymentTerm: href: /objects/term/75 key: '75' id: 10 Days audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' entity: key: '46' id: CORP name: Corp href: /objects/company-config/entity/46 status: active taxSolution: key: '44' id: Avalara href: /objects/tax/tax-solution/44 taxCalculationMethod: noTax showMultilineTax: true lines: - key: '44' id: '44' href: '/objects/order-entry/document-line::Sales%20Invoice/44' documentType: Sales Invoice lineNumber: 1 item: key: '10' id: MX001 href: /objects/inventory-control/item/10 itemAlias: key: '10' id: IXN href: '/objects/accounts-receivable/customer-item-cross-reference/10' memo: Payment ACH priceCalculationMemo: Fair value price list unit: Each quantity: '40.10' unitQuantity: '10.10' unitPrice: '10.50' price: '33.66' quantityConverted: '5.10' retailPrice: '10.44' audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' status: active costMethod: average discountPercent: '10.50' multiplier: 1 sourceDocument: key: '77' id: Sales Order-SO0022 documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/77 sourceDocumentLine: key: '2234' id: '2234' documentType: Sales Order href: '/objects/order-entry/document-line::Sales%20Order/2234' isPriceProrated: true discountMemo: Festival discount baseCurrency: USD txnCurrency: CAD priceInTxnCurrency: '10.00' isBillable: true isBilled: true taxRate: '10.05' taxInBaseCurrency: '10.50' taxInTxnCurrency: '40.50' discount: '10.25' enableTax: false quantityRemaining: '10.10' conversionType: quantity dimensions: location: key: '22' id: LOC-22 name: California href: /objects/company-config/location/22 department: key: '9' id: Sales name: Sales and Marketing href: /objects/company-config/department/9 employee: key: '10' id: EMP-10 name: Thomas, Glenn href: /objects/company-config/employee/10 project: key: '2' id: NET-XML30-2 name: Talcomp training href: /objects/projects/project/2 customer: key: '13' id: CUST-13 name: Jack In the Box href: /objects/accounts-receivable/customer/13 vendor: key: '357' id: '1605212096809' name: GenLab href: /objects/accounts-payable/vendor/357 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 warehouse: key: '6' id: WH01 name: WH01 href: /objects/inventory-control/warehouse/6 class: key: '731' id: REST_CLS_001 name: Enterprises href: /objects/company-config/class/731 task: id: TSK01 key: '1' name: Project Task href: /objects/projects/task/1 costType: id: '2' key: '2' name: Project Expense href: /objects/construction/cost-type/2 asset: id: A001 key: '1' name: Laptop 1 contract: id: CON-0045-1 key: '12' name: ACME Widgets - Service href: /objects/contracts/contract/12 itemRenewalTemplate: key: '45' id: Sales Renewal Template href: /objects/order-entry/renewal-template/45 revenueRecognitionStartDate: '2024-04-04' revenueRecognitionEndDate: '2024-04-04' requestedShippingDate: '2024-04-04' shipByDate: '2024-04-15' pickTicketPrintedDate: '2024-04-04' cancelAfterDate: '2024-04-15' doNotShipBeforeDate: '2024-04-03' doNotShipAfterDate: '2024-04-15' shippedDate: '2024-04-04' servicePeriodStartDate: '2024-04-01' servicePeriodEndDate: '2024-04-30' allowDropship: true allowBuyToOrder: true revision: unitQuantity: '10' quantity: '10' unitValue: '8.00' value: '8.00' valueInTxnCurrency: '10.00' price: '10.00' unitPrice: '10.00' priceInTxnCurrency: '10.00' draft: unitQuantity: '10' quantity: '10' price: '10.00' basePrice: '10.00' posted: quantity: '10.00' price: '10.00' basePrice: '10.00' addedByChangeDocument: false projectContractBilling: externalReferenceNumber: HGS-1024 description: Construction of clubhouse and offices billingType: timeAndMaterial contractLineValue: '1000.00' priorApplicationAmount: '1000.00' completedThisPeriodAmount: '1000.00' storedMaterialsAmount: '1000.00' completedToDateAmount: '1000.00' completedToDatePercent: '10.00' balanceRemaining: '1000.00' totalConvertedAmount: '1000.00' totalRemainingAmount: '1000.00' isSummarized: false retainage: percentage: '10.00' baseAmountRetained: '10.00' txnAmountRetained: '10.00' isReleaseLine: true previousBalanceAmount: '1000.00' billAmount: '1000.00' balanceAmount: '1000.00' extendedPriceNetAmount: '1000.00' extendedBasePriceNetAmount: '1000.00' reverseConversion: isReverseConversion: false price: '100.00' quantity: '100' standardPrice: '100.00' standardQuantity: '100' relatedDocument: key: '5151' id: Sales Order-SD-SO0550 href: /objects/order-entry/document/5151 relatedDocumentLine: key: '13965' id: 1--0001 href: /objects/order-entry/document-line/13965 projectContract: key: '1' id: BTI-01 name: Berkeley Technology Inc - Contract 01 href: /objects/construction/project-contract/1 projectContractLine: key: '4' id: Project-Contract-Line-04 name: Project contract line 04 href: /objects/construction/project-contract-line/4 taxSchedule: key: '1' id: Sale Goods Standard href: /objects/tax/order-entry-tax-schedule/1 buyToOrderContact: key: '13' id: contact trackingDetail: - key: '55' id: '55' href: /objects/order-entry/document-line-detail/55 quantity: '10' serialNumber: S1001 lotNumber: L1001 expirationDate: '2024-04-04' aisle: href: /objects/inventory-control/aisle/10 key: '10' id: AISLE1 bin: href: /objects/inventory-control/bin/20 key: '20' id: BIN1 row: href: /objects/inventory-control/row/15 key: '15' id: ROW1 item: key: '10' id: Battery href: /objects/inventory-control/item/10 audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' orderEntryDocumentLine: key: '23' id: '23' documentType: Sales Order href: '/objects/order-entry-document-line::Sales%20Order/23' lineSubtotals: [] documentHeader: key: '55' id: Sales Invoice-SO0066 documentType: Sales Invoice href: /objects/order-entry-document::Sales%20Invoice/55 subtotals: - key: '12' id: '12' href: /objects/order-entry/document-subtotal/12 description: Tax percentValue: '10.50' absoluteValue: '40.50' txnAbsoluteValue: '44.78' total: '500.10' txnTotal: '400.10' documentLine: key: '10' documentType: Sales Order id: '10' href: '/objects/order-entry-document-line::Sales%20Order/10' audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' dimensions: location: key: '22' id: LOC-22 name: California href: /objects/company-config/location/22 department: key: '9' id: Accounting name: Sales and Marketing href: /objects/company-config/department/9 employee: key: '10' id: EMP-10 name: Thomas, Glenn href: /objects/company-config/employee/10 project: key: '2' id: NET-XML30-2 name: Talcomp training href: /objects/projects/project/2 customer: key: '13' id: CUST-13 name: Jack In the Box href: /objects/accounts-receivable/customer/13 vendor: key: '357' id: '1605212096809' name: GenLab href: /objects/accounts-payable/vendor/357 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 warehouse: key: '6' id: WH01 name: WH01 href: /objects/inventory-control/warehouse/6 class: key: '731' id: REST_CLS_001 name: Enterprises href: /objects/company-config/class/731 task: id: '1' key: '1' name: Project Task href: /objects/projects/task/1 costType: id: '2' key: '2' name: Project Expense href: /objects/construction/cost-type/2 asset: id: A001 key: '1' name: Laptop 1 contract: id: CON-0045-1 key: '12' name: ACME Widgets - Service href: /objects/contracts/contract/12 documentHeader: key: '23' id: '23' documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/23 history: - key: '11' id: '11' href: /objects/order-entry/document-history/11 convertedFrom: key: '22' id: Sales Order-ORINV#0182#doc documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/22 convertedTo: key: '14' id: Sales Invoice-SUBINV#0182#doc documentType: Sales Invoice href: /objects/order-entry-document::Sales%20Invoice/14 orderEntryDocument: key: '23' id: Sales Order-ORINV#0182#doc documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/22 ia::meta: totalCount: 3 totalSuccess: 2 totalError: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an Order Entry document description: >+ Updates an existing Order Entry document by setting field values. Any fields not provided remain unchanged. With Edit permissions to Order Entry transactions, most details for a transaction that has a state of Draft or Pending can be edited.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Edit Order Entry documents
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 Update a document - Construction subscription: value: exclusions: Excludes additional purchase for materials. schedule: revisedCompletionDate: '2024-08-02' DueDate: '2024-05-31' scheduleImpactNotes: Revised completion date to 2024-08-02 internalReference: sourceReferenceNumber: '7649851' Update a project contract billing document: value: retainagePercent: 16 lines: - key: '13968' projectContractBilling: completedThisPeriodAmount: '175.00' storedMaterialsAmount: '25.00' Update service period dates of a document line: value: lines: - key: '994' servicePeriodStartDate: '2024-08-01' servicePeriodEndDate: '2024-08-31' 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: Reference to 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 Reference to updated Construction document: value: ia::result: key: '5150' id: SO-Order02-SO0549 href: /objects/order-entry/document::SO-Order02/5150 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Reference to updated project contract billing document: value: ia::result: key: '5156' id: SO-AIA-Invoice01-Ord#0191#doc href: /objects/order-entry/document::SO-AIA-Invoice01/5156 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an Order Entry document description: >+ Deletes an Order Entry document. Several factors determine whether an Order Entry document can be deleted. See [Order Entry transactions](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Using_Order_Entry/Transactions/ab-TOC-oe-transactions.htm?tocpath=Applications%7COrder%20Entry%7CTransactions%7C_____0) in the Sage Intacct Help Center for more information.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Delete Order Entry documents
tags: - Documents operationId: delete-order-entry-named-document-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/price-list-entry: get: summary: List price list entries description: Returns a collection with a key, ID, and link for each price list entry. tags: - Price list entries operationId: list-order-entry-price-list-entry responses: '200': description: OK content: application/json: schema: type: object title: List of price-list-entry objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of price list entries: value: ia::result: - key: '1' id: '1' href: /objects/order-entry/price-list-entry/1 - key: '2' id: '2' href: /objects/order-entry/price-list-entry/2 ia::meta: totalCount: 2 totalSuccess: 2 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a price list entry description: Creates a new price list entry. tags: - Price list entries operationId: create-order-entry-price-list-entry requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-price-list-entry' - $ref: '#/components/schemas/order-entry-price-list-entryRequiredProperties' examples: Creates a price list entry: value: startDate: '2024-07-01' endDate: '2024-09-31' minimumQuantity: '1' maximumQuantity: '9999999' value: '1.00000000' valueType: actual isFixedPrice: 'true' status: active currency: USD responses: '201': description: Created content: application/json: schema: type: object title: New price-list-entry properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new price list entry: value: ia::result: id: '421' key: '421' href: /objects/order-entry/price-list-entry/421 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/price-list-entry/{key}: parameters: - name: key description: System-assigned unique key for the price list entry. in: path required: true schema: type: string example: '186' get: summary: Get a price list entry description: Returns detailed information for a specified price list entry. tags: - Price list entries operationId: get-order-entry-price-list-entry-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the price-list-entry properties: ia::result: $ref: '#/components/schemas/order-entry-price-list-entry' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the price list entry: value: Details of the price list entry: value: ia::result: id: '451' key: '451' priceList: id: Base Price List key: '1' href: /objects/order-entry/price-list/1 item': Key: '89' id: Car_Battery name: Battery for Car productLine: key: null id: null startDate: '2024-07-01' endDate: '2024-07-31' minimumQuantity: '1' maximumQuantity: '999999999' value: '10.00000000' valueType: actual isFixedPrice: 'true' status: active currency: USD employee: key: '25' id: '123' href: /objects/company-config/employee/25 audit: createdDateTime: '2024-12-12T04:46:56Z' modifiedDateTime: '2024-12-12T04:46:56Z' createdBy: Admin modifiedBy: Admin href: /objects/order-entry/price-list-entry/451 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a price list entry description: >- Updates an existing price list entry by setting field values. Any fields not provided remain unchanged. tags: - Price list entries operationId: update-order-entry-price-list-entry-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-price-list-entry' - type: object properties: id: readOnly: true example: '435' examples: Updates a price list entry: value: startDate: '2018-02-01' responses: '200': description: OK content: application/json: schema: type: object title: Updated price-list-entry properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated price list entry: value: ia::result: id: '435' key: '435' href: /objects/order-entry/price-list-entry/435 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a price list entry description: Deletes a price list entry. tags: - Price list entries operationId: delete-order-entry-price-list-entry-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /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 typeBusiness, 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 typeBusiness, 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 example: '6' get: summary: Get a price list description: >+ Returns detailed information for a specified order entry price list.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, 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 typeBusiness, 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 typeBusiness, 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/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: value: ia::result: - key: '15' id: '15' href: /objects/order-entry/renewal-template/19 - key: '16' id: '16' href: /objects/order-entry/renewal-template/20 - key: '17' id: '17' href: /objects/order-entry/renewal-template/21 ia::meta: totalCount: 3 start: 1 pageSize: 100 '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: value: name: Testing1212qw1 description: kk salesTxnCreation: enableTxnCreation: true transactionDefinition: id: null key: null daysBeforeAfter: 9 beforeOrAfterContractEnd: after txnDateOnRenewedDocument: contractEndDatePlusOneDay txnLineItemStartDate: sameAsDocumentDate contractPricing: pricingType: defaultPricing markup: percentageMarkup markupValue: null renewalNotifications: customerEmail: enableNotification: false from: null to: customerContact daysBeforeAfter: 0 beforeOrAfterContractRenewal: before emailTemplate: id: null key: null internalEmail: enableNotification: false from: null to: null daysBeforeAfter: 10 beforeOrAfterContractRenewal: before emailTemplate: id: null key: null salesforceOpportunity: enableSalesforceOpportunity: false daysBeforeAfter: 10 beforeOrAfterContractRenewal: before status: active transactionType: contract defaultTerm: length: 2 period: months renewalState: inProgress 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: value: ia::result: key: '30' id: '30' href: /objects/order-entry/renewal-template/30 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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 example: '49' 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: value: ia::result: id: 24 key: 24 name: Testing1212qw description: kk salesTxnCreation: enableTxnCreation: 'true' transactionDefinition: id: null key: null daysBeforeAfter: 9 beforeOrAfterContractEnd: after txnDateOnRenewedDocument: contractEndDatePlusOneDay txnLineItemStartDate: sameAsDocumentDate contractPricing: pricingType: defaultPricing markup: percentageMarkup markupValue: null renewalNotifications: customerEmail: enableNotification: 'false' from: null to: customerContact daysBeforeAfter: 0 beforeOrAfterContractRenewal: before emailTemplate: id: null key: null internalEmail: enableNotification: 'false' from: null to: null daysBeforeAfter: 10 beforeOrAfterContractRenewal: before emailTemplate: id: null key: null salesforceOpportunity: enableSalesforceOpportunity: 'false' daysBeforeAfter: 10 beforeOrAfterContractRenewal: before renewalName: null inheritProductsFromParent: 'false' stage: null latestVersion: null status: active transactionType: contract defaultTerm: length: 2 period: months renewalState: inProgress entity: key: null id: null name: null href: /objects/order-entry/renewal-template/24 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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: value: description: Subscription Invoice RevRec Creation Markup price.-New 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: value: ia::result: key: '30' id: '30' href: /objects/order-entry/renewal-template/30 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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-line: get: summary: List subtotal template lines description: >- Returns up to 100 object references from the collection with a key, ID, and link for each subtotal template details. 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: - Subtotal template lines operationId: list-order-entry-subtotal-template-line responses: '200': description: OK content: application/json: schema: type: object title: List of subtotal template line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List subtotal template lines: value: ia::result: - key: '4' id: '4' href: /objects/order-entry/subtotal-template-line/4 - key: '5' id: '5' href: /objects/order-entry/subtotal-template-line/5 - key: '6' id: '6' href: /objects/order-entry/subtotal-template-line/6 - key: '7' id: '7' href: /objects/order-entry/subtotal-template-line/7 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a subtotal template line description: Creates a new subtotal template line object. tags: - Subtotal template lines operationId: create-order-entry-subtotal-template-line requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-subtotal-template-line' - $ref: '#/components/schemas/order-entry-subtotal-template-lineRequiredProperties' examples: Create a subtotal template line: value: description: FreightCharge subtotalTemplate: key: '3' subtotalType: discount valueType: amount defaultValue: '10.00' isApportioned: false glAccount: id: '6850.03' offsetGLAccount: id: '1200' txnType: debit applyToLineNumber: 0 isTax: false isAvalaraTax: false responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-subtotal-template-line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new subtotal template line: value: ia::result: key: '4' id: '4' href: /objects/order-entry/subtotal-template-line/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/subtotal-template-line/{key}: parameters: - schema: type: string name: key in: path required: true example: '4' description: System-assigned key for the subtotal template line. get: summary: Get a subtotal template line description: >- Returns detailed information for a specified subtotal template line object. tags: - Subtotal template lines operationId: get-objects-order-entry-subtotal-template-line-key responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/order-entry-subtotal-template-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a subtotal template line: value: ia::result: key: '4' id: '4' description: FreightCharge subtotalTemplate: key: '3' id: '3' href: /objects/order-entry/subtotal-template/3 subtotalType: discount lineNumber: 0 valueType: amount defaultValue: '10.00' isApportioned: false glAccount: key: '297' id: '6850.03' href: /objects/general-ledger/account/297 offsetGLAccount: key: '36' id: '1200' href: /objects/general-ledger/account/36 txnType: debit applyToLineNumber: 0 isTax: false isAvalaraTax: false href: /objects/order-entry/subtotal-template-line/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': description: Bad Request security: - OAuth2: [] patch: summary: Update a subtotal template line description: >- Updates an existing subtotal template line object by setting field values. Any fields not provided remain unchanged. tags: - Subtotal template lines operationId: update-order-entry-subtotal-template-line-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-subtotal-template-line' - type: object examples: Update a subtotal template line: value: subtotalType: discount defaultValue: '15.00' responses: '200': description: OK content: application/json: schema: type: object title: Updated subtotal template line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated subtotal template line: value: ia::result: key: '4' id: '4' href: /objects/order-entry/subtotal-template-line/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a subtotal template line description: Deletes a subtotal template line object. tags: - Subtotal template lines operationId: delete-order-entry-subtotal-template-line-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: value: ia::result: - key: '1' id: UK VAT href: /objects/order-entry/subtotal-template/1 - key: '2' id: InvoiceTax href: /objects/order-entry/subtotal-template/2 - key: '3' id: SalesInvoiceCharges href: /objects/order-entry/subtotal-template/3 - key: '4' id: Avalara href: /objects/order-entry/subtotal-template/4 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '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: value: id: SalesInvoiceCharges lines: - description: FreightCharge subtotalType: discount lineNumber: 0 valueType: amount defaultValue: '10.00' glAccount: id: '6850.03' offsetGLAccount: id: '1200' txnType: debit - description: Discount subtotalType: discount lineNumber: 1 valueType: percent defaultValue: '5' isApportioned: false glAccount: id: '2000.00' offsetGLAccount: id: '1500.00' txnType: debit - description: CASTax subtotalType: charge lineNumber: 2 valueType: percent defaultValue: '6' isApportioned: false glAccount: id: '2000.00' offsetGLAccount: id: '1500.00' txnType: debit 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: value: ia::result: key: '3' id: SalesInvoiceCharges href: /objects/order-entry/subtotal-template/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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 example: '28' 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: value: ia::result: key: '3' id: SalesInvoiceCharges moduleKey: 8.SO lines: - id: '4' key: '4' description: FreightCharge subtotalType: discount lineNumber: 0 valueType: amount defaultValue: '10.00' isApportioned: false glAccount: key: '297' id: '6850.03' href: /objects/general-ledger/account/297 offsetGLAccount: key: '36' id: '1200' href: /objects/general-ledger/account/36 txnType: debit applyToLineNumber: 0 isTax: false isAvalaraTax: false href: /objects/order-entry/subtotal-template-line/4 - id: '5' key: '5' description: Discount subtotalType: discount lineNumber: 1 valueType: percent defaultValue: '5' isApportioned: false glAccount: key: '121' id: '2000.00' href: /objects/general-ledger/account/121 offsetGLAccount: key: '122' id: '1500.00' href: /objects/general-ledger/account/122 txnType: debit applyToLineNumber: 0 isTax: false isAvalaraTax: false href: /objects/order-entry/subtotal-template-line/5 - id: '7' key: '7' description: CASTax subtotalType: charge lineNumber: 2 valueType: percent defaultValue: '6' isApportioned: false glAccount: key: '121' id: '2000.00' href: /objects/general-ledger/account/121 offsetGLAccount: key: '122' id: '1500.00' href: /objects/general-ledger/account/122 txnType: debit applyToLineNumber: 0 isTax: false isAvalaraTax: false href: /objects/order-entry/subtotal-template-line/7 audit: createdDateTime: '2024-05-15T16:46:11Z' modifiedDateTime: '2024-05-15T16:46:11Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/subtotal-template/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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 example: SalesInvoiceCharges examples: Update a subtotal template: value: lines: - key: '4' glAccount: id: '6850.03' 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: value: ia::result: key: '3' id: SalesInvoiceCharges href: /objects/order-entry/subtotal-template/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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: [] /objects/order-entry/txn-definition-additional-gl-detail: get: summary: List additional GL detail objects description: >+ Returns a collection with a key, ID, and link for each transaction definition additional GL detail object. 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 typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
tags: - Transaction definition additional GL 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 additional GL detail objects: 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 detail object. example: '196' in: path required: true schema: type: string get: summary: Get an additional GL detail object description: >+ Returns detailed information for a specified transaction definition additional GL detail object.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
tags: - Transaction definition additional GL 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 an additional GL detail 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/inventory-control/item-gl-group/6 isOffset: false txnType: debit moduleType: additional glAccount: id: '1000' key: '3' href: /objects/general-ledger/account/3 lineNumber: 10 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 detail object description: >+ Updates an existing transaction definition additional GL detail object by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Edit transaction definitions
tags: - Transaction definition additional GL 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 account detail object: value: isOffset: true 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: Reference to updated additional GL 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 detail object description: >+ Deletes an additional GL detail object.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Delete transaction definitions
tags: - Transaction definition additional GL 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 Accounts Receivable or direct GL account detail objects description: >+ Returns a collection with a key, ID, and link for each transaction definition Accounts Receivable or direct GL account detail object. 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 typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
tags: - Accounts Receivable or direct GL 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 Accounts Receivable or direct GL 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 Accounts Receivable or direct GL account detail object. example: '164' in: path required: true schema: type: string get: summary: Get an Accounts Receivable or direct GL account detail object description: >+ Returns detailed information for a specified transaction definition Accounts Receivable or direct GL account detail object.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
tags: - Accounts Receivable or direct GL 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 an Accounts Receivable or direct GL 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/inventory-control/item-gl-group/2 isOffset: false txnType: credit moduleType: subledger glAccount: id: '4030' key: '69' href: /objects/general-ledger/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 an Accounts Receivable or direct GL account detail object description: >+ Updates an existing transaction definition Accounts Receivable or direct GL account detail object by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Edit transaction definitions
tags: - Accounts Receivable or direct GL 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 an Accounts Receivable or direct GL account detail object: value: isOffset: true 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: Reference to updated Accounts Receivable or direct GL 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 an Accounts Receivable or direct GL account detail object description: >+ Delete a transaction definition Accounts Receivable or direct GL account detail object.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Delete transaction definitions
tags: - Accounts Receivable or direct GL 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 detail objects description: >+ Returns a collection with a key, ID, and link for each transaction definition COGS detail object. 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 typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
tags: - Transaction definition COGS 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 transaction definition COGS detail objects: 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 detail object. example: '160' in: path required: true schema: type: string get: summary: Get a transaction definition COGS detail object description: >+ Returns detailed information for a specified transaction definition COGS detail object.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
tags: - Transaction definition COGS 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 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: '16' id: HW GL Group href: /objects/inventory-control/item-gl-group/16 txnType: debit moduleType: inventory glAccount: id: '5000' key: '72' href: /objects/general-ledger/account/72 lineNumber: 11 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 detail object description: >+ Updates an existing transaction definition COGS detail object by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Edit transaction definitions
tags: - Transaction definition COGS 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 detail object: value: txnType: credit isOffset: true 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: Reference to updated transaction definition COGS 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 detail object description: >+ Deletes a transaction definition COGS detail object.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Delete transaction definitions
tags: - Transaction definition COGS 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. 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 typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Add transaction definitions
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 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: Reference to 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. example: '170' 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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
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/company-config/entity/3 enableNumberingSequence: true documentSequence: key: '11' id: AR Inv href: /objects/company-config/document-sequence/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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Edit transaction definitions
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: showExpandedTaxDetail: true 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: Reference to 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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Delete transaction definitions
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. 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 typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Add transaction definitions
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: Reference to 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 example: '96' 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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Edit transaction definitions
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: maintainType: quantityAndValue 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: Reference to 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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Delete transaction definitions
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 source document detail objects description: >+ Returns a collection with a key, ID, and link for each transaction definition source document detail object. 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 typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
tags: - Transaction definition source document 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 transaction definition source document 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 source document detail object description: >+ Creates a new transaction definition source document detail object.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Add transaction definitions
tags: - Transaction definition source document 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 transaction definition source document 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: Reference to new transaction definition source document 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 transaction definition source document detail object. in: path example: '70' required: true schema: type: string get: summary: Get a transaction definition source document detail object description: >+ Returns detailed information for a specified transaction definition source document detail object.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
tags: - Transaction definition source document 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 transaction definition source document 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 source document detail object description: >+ Updates an existing transaction definition source document detail object by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Edit transaction definitions
tags: - Transaction definition source document 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 transaction definition source document detail object: value: sourceDocument: key: '55' 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: Reference to updated transaction definition source document 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 source document detail object description: >+ Deletes a transaction definition source document detail object.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Delete transaction definitions
tags: - Transaction definition source document 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. 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 typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
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 detail 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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Add transaction definitions
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: Create a new transaction definition subtotal detail object: 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: Reference to 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 example: '113' 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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
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/general-ledger/account/3 offsetGLAccount: key: '160' id: '1000.01' href: /objects/general-ledger/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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Edit transaction definitions
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: 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: Reference to 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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Delete transaction definitions
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/txn-definition: get: summary: List transaction definitions description: >+ Returns a collection with a key, ID, and link for each 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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
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. Advanced workflows must be enabled to add new transaction definitions. See [Transaction definitions - Order Entry](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Transaction_definitions/order-entry-transaction-definitions.htm) in the Sage Intacct Help Center for more information.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Add transaction definitions
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 deletePolicy: all enableNumberingSequence: true preserveNumberingSequence: true inheritDocumentNumber: false inventoryUpdateType: value increaseOrDecreaseInventory: decrease disableTax: true enableFulfillment: true enableReservingAndPicking: true partialConvertMethod: closeOriginalAndCreateBackOrder affectsCost: true overrideExchangeRateType: false overridePrice: false trackDiscountAndSurcharge: true allowDiscountOnExtendedPrice: true requireMemoForDiscount: true showExpandedTaxDetails: true enableOverrideTax: true renewalEnablementType: generate enableLineItemConversion: true allowRenewConvertedLineOnly: true allowLocationOverride: true allowDepartmentOverride: true xslTemplate: Sales Invoice fixedMessage: For assistance, please contact customer service. printBillToContact: true allowEditingBillToContact: true printShipToContact: true allowEditingShipToContact: true enableWarnOnLowQuantity: false enableCreditLimitCheck: true warehouseSelectionMethod: useTheDefaultWarehouse displayDraftsOnRevenueTxnEntriesPage: true 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: Reference to 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 example: '37' schema: type: string get: summary: Get a transaction definition description: >+ Returns detailed information for a specified transaction definition.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, transaction definitions
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: 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 displayDraftsOnRevenueTxnEntriesPage: false 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 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 transactions after changes are made to the transaction definition.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Edit transaction definitions
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: description: Sales Order RevRec Display Only overridePrice: true 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: Reference to 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.
Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View, Delete transaction definitions
tags: - Transaction definitions operationId: delete-order-entry-txn-definition-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] components: schemas: 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 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 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 example: {} propertySet: type: string example: {} details: type: array items: type: object properties: code: type: string example: invalidRequest message: type: string example: /newDate is not a valid field errorId: type: string example: REST-1043 target: type: string example: /newDate additionalInfo: type: object properties: messageId: type: string example: IA.NOT_A_VALID_FIELD placeholders: type: string example: FIELD: /newDate propertySet: type: string example: {} ia::meta: $ref: '#/components/schemas/metadata' example: ia::result: ia::error: code: invalidRequest message: A POST request requires a payload errorId: REST-1028 additionalInfo: messageId: IA.REQUEST_REQUIRES_A_PAYLOAD placeholders: OPERATION: POST propertySet: {} supportId: Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo ia::meta: totalCount: 1 totalSuccess: 0 totalError: 1 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 audit: type: object readOnly: true properties: createdDateTime: description: Date-time when this record was created. type: string format: date-time readOnly: true example: '2023-05-16T15:34:35Z' modifiedDateTime: description: Date-time when this record was modified. type: string format: date-time readOnly: true example: '2024-09-14T21:23:42Z' createdBy: description: Key for the user who created this object. type: string readOnly: true nullable: true example: '436' modifiedBy: description: Key for the user who last modified this object. type: string readOnly: true nullable: true example: '3086' order-entry-document-line-detail: type: object description: >- List of warehouse inventory details including serial number, aisle, bin, and row per line item. properties: key: type: string description: System-assigned key for the document line detail object. readOnly: true example: '55' id: type: string description: Unique ID for the document line detail object. readOnly: true example: '55' href: type: string description: URL endpoint for the document line detail object. 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: URL endpoint for the aisle. readOnly: true example: /objects/inventory-control/aisle/10 key: type: string description: Unique key for the aisle. example: '10' id: type: string description: Unique ID for the aisle. example: AISLE1 bin: type: object description: The bin associated with the line details. properties: href: type: string description: URL endpoint for the bin. readOnly: true example: /objects/inventory-control/bin/20 key: type: string description: Unique key for the bin. example: '20' id: type: string description: Unique ID for the bin. example: BIN1 row: type: object description: The row associated with the line details. properties: href: type: string description: URL endpoint for the row. readOnly: true example: /objects/inventory-control/row/15 key: type: string description: Unique key for the row. example: '15' id: type: string description: Unique ID for the row. example: ROW1 item: type: object description: Item associated with the line details. properties: key: type: string description: Unique key for the item. example: '10' id: type: string description: Unique ID for the item. example: Battery href: type: string description: URL endpoint 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: Unique key for the order entry document line. readOnly: true example: '23' id: type: string description: ID for the document line. readOnly: true example: '23' documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: URL endpoint for the order entry document. readOnly: true example: /objects/order-entry-document-line::Sales%20Order/23 dimension-ref: type: object properties: location: type: object properties: key: type: string description: Location key example: '22' nullable: true id: type: string description: Location ID 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 ID 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 affiliateEntity: type: object properties: key: type: string description: Affiliate entity key example: '23' nullable: true id: type: string description: Affiliate entity ID example: AFF-23 nullable: true href: type: string readOnly: true example: /objects/affiliate-entity/23 name: type: string readOnly: true description: Affiliate entity name example: 100-USA nullable: true 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-document-line-subtotal: type: object description: >- Details of the subtotals, taxes, discounts, charges, and more for the document line. properties: key: type: string description: System-assigned key for the document line subtotal. readOnly: true example: '23' id: type: string description: System-assigned ID for the document line subtotal. readOnly: true example: '23' href: type: string description: Endpoint for the document line subtotal. readOnly: true example: /objects/order-entry/document-line-subtotal/23 description: type: string description: Description of the document line subtotal. readOnly: true example: VAT Tax absoluteValue: type: string format: decimal-precision-8 description: A non-negative base amount for the document subtotal line. example: '100.00' percentValue: type: string format: decimal-precision-8 description: Percentage value that is calculated for subtotal line. readOnly: true example: '5.00' total: type: string format: decimal-precision-8 description: The base total amount for the line item subtotal. readOnly: true example: '105.00' txnAbsoluteValue: type: string format: decimal-precision-8 description: A non-negative amount for the subtotal line. example: '100.00' txnTotal: type: string format: decimal-precision-8 description: A non-negative total for the subtotal amount. readOnly: true example: '105.00' enableOverrideTax: type: boolean description: >- Enabling this field allows the user to override both tax detail (taxDetail) and the tax value (txnAbsoluteValue). example: false default: false taxDetail: type: object description: >- Tax details describe a specific type of tax that applies to document lines. properties: key: type: string description: System-assigned key for the tax detail. example: '1' id: type: string description: Unique identifier of the tax detail. example: VAT Tax Detail href: type: string description: URL of the tax detail object. readOnly: true example: /objects/tax/tax-detail/1 systemTaxDetail: type: object description: > When enableOverrideTax is enabled, the user can provide taxDetail. The originally allotted taxDetail will then be assigned to systemTaxDetail. readOnly: true properties: key: type: string description: System-assigned key for the tax detail. example: '10' id: type: string description: Unique identifier of the tax detail. example: VAT Tax Detail href: type: string description: URL of the tax detail object. readOnly: true example: /objects/tax/tax-detail/10 dimensions: type: object readOnly: true allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: title: location description: Location associated with the subtotal line. type: object readOnly: true properties: key: type: string description: System-assigned key for the location. example: '22' id: type: string description: Identifier for the location. example: Arizona name: type: string description: Name of the location. example: Arizona readOnly: true href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/22 department: title: department type: object description: Department associated with the subtotal line. readOnly: true 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 name: type: string description: Title of the department. example: Accounting readOnly: true href: type: string readOnly: true description: URL for the department. example: /objects/company-config/department/9 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' id: type: string description: System-assigned ID for the order-entry document line. readOnly: true example: '10' documentType: type: string description: Order entry document type mapped to the line item. example: Sales Order readOnly: true href: type: string description: Endpoint for the order-entry document line. readOnly: true example: /objects/order-entry/document-line::Sales%20Order/10 document: type: object description: Header lever details for the document. readOnly: true properties: key: type: string description: System-assigned key for the order-entry document. example: '24' id: type: string description: ID for the order-entry document. example: '24' documentType: type: string description: Order entry document type mapped to the line item. example: Sales Order readOnly: true href: type: string description: URL for the order-entry document. readOnly: true example: /objects/order-entry/document::Sales%20Order/24 status: $ref: '#/components/schemas/status' 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-document-line: description: >- Line items in an Order Entry document represent Order Entry transactions. type: object properties: key: type: string description: System-assigned unique 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. This value is the same as key for this object. readOnly: true example: '44' href: type: string description: URL endpoint 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: Unique key for the item. example: '10' id: type: string description: ID for the item. readOnly: true example: MX001 href: type: string description: URL endpoint 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: Unique key for the item alias. example: '10' id: type: string description: ID for the item alias. example: IXN href: type: string description: URL endpoint 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 items converted to a downstream document from the original quantity entered. example: '5.10' retailPrice: type: string format: decimal-precision-10 readOnly: true description: Suggested retail 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-10 description: Discount percentage for the document line item. example: '10.50' multiplier: type: number description: >- This field is only applicable if for companies subscribed to Contracts. This field displays the Multiplier value from the contract line. Defaults to 1 if no Multiplier was used on the contract line. example: 1 sourceDocument: type: object description: Source Order Entry document. properties: key: type: string description: Unique 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: URL endpoint for the Order Entry document. readOnly: true example: /objects/order-entry-document::Sales%20Order/77 sourceDocumentLine: type: object description: Source document line that needs to be converted. properties: key: type: string description: Unique 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 endpoint 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 the base currency. readOnly: true example: '10.50' taxInTxnCurrency: type: string format: decimal-precision-2 description: The line level tax amount in the transaction currency. readOnly: true example: '40.50' discount: 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: Unique key for the location. example: '22' id: type: string description: ID for the location. example: LOC-22 href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/22 department: type: object description: Department associated with the document line. title: department properties: key: type: string description: Unique key for the department. readOnly: true example: '9' id: type: string description: ID for the department. example: Sales href: type: string description: URL endpoint 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: Unique key for the warehouse. example: '6' id: type: string description: Unique ID for the warehouse. example: WH01 href: type: string description: URL endpoint 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: Unique 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 endpoint 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: ID for the associated task. example: TSK01 key: type: string description: Unique key for the associated task. example: '1' href: type: string description: URL endpoint 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 endpoint for the renewal template. readOnly: true example: /objects/order-entry/renewal-template/45 revenueRecognitionStartDate: type: string description: >- The date on which the revenue recognition schedule and/or renewal schedule get started. format: date example: '2023-04-04' revenueRecognitionEndDate: type: string description: >- The date on which the 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 drop-ship 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 revision: type: object description: >- Line-level revised details post change order. (Construction subscription) properties: unitQuantity: type: string description: Revised unit quantity. example: '10' quantity: type: string description: Revised quantity. example: '10' unitValue: type: string description: Revised unit value. format: decimal-precision-2 readOnly: true example: '80.00' value: type: string description: Revised value. format: decimal-precision-2 readOnly: true example: '80.00' valueInTxnCurrency: type: string description: Revised transaction currency. format: decimal-precision-2 readOnly: true example: '100.00' price: type: string description: Revised price. format: decimal-precision-10 readOnly: true example: '100.00' unitPrice: type: string description: Revised unit price. format: decimal-precision-10 readOnly: true example: '100.00' priceInTxnCurrency: type: string description: Revised transaction price. format: decimal-precision-10 readOnly: true example: '100.00' draft: type: object description: >- Line-level draft details post change order. (Construction subscription) properties: unitQuantity: type: string description: Draft unit quantity change. example: '10' quantity: type: string description: Draft quantity change. example: '10' price: type: string description: Draft price change. format: decimal-precision-10 example: '20.00' basePrice: type: string description: Draft base price change. format: decimal-precision-10 readOnly: true example: '20.00' posted: type: object description: >- Line-level posted details post change order. (Construction subscription) properties: quantity: type: string description: Posted quantity change. format: decimal-precision-10 readOnly: true example: '20' price: type: string description: Posted extended price change. format: decimal-precision-10 readOnly: true example: '10.00' basePrice: type: string description: Posted extended base price change. format: decimal-precision-10 readOnly: true example: '10.00' addedByChangeDocument: type: boolean description: >- Indicates whether the line has been added by change document. (Construction subscription) readOnly: true example: false default: false servicePeriodStartDate: type: string description: Service period start date. format: date example: '2024-04-01' nullable: true servicePeriodEndDate: type: string description: Service period end date. format: date example: '2026-04-30' nullable: true projectContractBilling: type: object description: >- Line-level project contract billing details. (Construction subscription) properties: externalReferenceNumber: type: string description: Project contract line external reference number. example: HGS-1024 description: type: string description: Project contract line description. maxLength: 4000 example: Construction of clubhouse and offices billingType: type: string description: Billing type used in project contract line. enum: - null - progressBill - timeAndMaterial readOnly: true default: progressBill example: timeAndMaterial contractLineValue: type: string description: Contract line value. format: decimal-precision-10 example: '1000.00' priorApplicationAmount: type: string description: Amount from prior application. format: decimal-precision-10 example: '1000.00' completedThisPeriodAmount: type: string description: Completed this period amount. format: decimal-precision-10 example: '500.00' storedMaterialsAmount: type: string description: Stored materials amount. format: decimal-precision-10 example: '300.00' completedToDateAmount: type: string description: Amount for total work completed to date. format: decimal-precision-10 readOnly: true example: '500.00' completedToDatePercent: type: string description: Percentage of work completed to date. format: decimal-precision-10 readOnly: true example: '10.00' balanceRemaining: type: string description: Balance remaining. format: decimal-precision-10 readOnly: true example: '500.00' totalConvertedAmount: type: string description: Total amount converted. format: decimal-precision-10 readOnly: true example: '1000.00' totalRemainingAmount: type: string description: Total amount remaining. format: decimal-precision-10 readOnly: true example: '500.00' isSummarized: type: boolean description: Indicates whether the entry is summarized. readOnly: true example: false default: false retainage: type: object description: Line-level retainage details. (Construction subscription) properties: percentage: type: string description: Retainage percentage. format: decimal-precision-2 example: '10.00' baseAmountRetained: type: string description: Base amount retained. format: decimal-precision-2 example: '10.00' txnAmountRetained: type: string description: Transaction amount retained. format: decimal-precision-2 example: '10.00' isReleaseLine: type: boolean description: Indicates whether the entry is a retainage release. readOnly: true example: true default: false previousBalanceAmount: type: string description: >- Sum of all the pending retainage amounts from the project contract lines matching the previous invoices for the project contract. format: decimal-precision-10 example: '1000.00' billAmount: type: string description: Retainage to bill amount. format: decimal-precision-10 readOnly: true example: '1000.00' balanceAmount: type: string description: Retainage balance amount. format: decimal-precision-10 readOnly: true example: '1000.00' extendedPriceNetAmount: type: string description: Extended price net retainage amount. format: decimal-precision-10 readOnly: true example: '1000.00' extendedBasePriceNetAmount: type: string description: Extended base price net retainage amount. format: decimal-precision-10 readOnly: true example: '1000.00' isReverseConversion: type: boolean description: Indicates whether the document line is reverse converted. example: false default: false reverseConversion: type: object description: Line-level reverse conversion details. (Construction subscription) properties: price: type: string description: Reverse converted price. format: decimal-precision-10 readOnly: true example: '100.00' quantity: type: string description: Reverse quantity converted. format: decimal-precision-10 readOnly: true example: '10' standardPrice: type: string description: Standard price converted. format: decimal-precision-10 readOnly: true example: '100.00' standardQuantity: type: string description: Standard quantity converted. format: decimal-precision-10 readOnly: true example: '10' relatedDocument: type: object description: >- Reference to the source transaction when creating a change order. (Construction subscription) properties: key: type: string description: Unique key for the Order Entry document. nullable: true example: '5151' id: type: string description: Name or other unique ID for the Order Entry document. nullable: true example: Sales Order-SD-SO0550 href: type: string description: URL endpoint for the Order Entry document. readOnly: true example: /objects/order-entry/document/5151 relatedDocumentLine: type: object description: >- Reference to the source transaction line when creating a change order. (Construction subscription) properties: key: type: string description: Unique key for the document line. nullable: true example: '13965' id: type: string description: Name or other unique ID for the for the document line. nullable: true example: '13965' href: type: string description: URL endpoint for the document line. readOnly: true example: /objects/order-entry/document-line/13965 projectContract: type: object description: Reference to the project contract. (Construction subscription) properties: key: type: string description: Unique key for the project contract. example: '1' id: type: string description: Unique ID for the project contract. example: BTI-01 name: type: string description: User-specified name of the project contract. readOnly: true example: Berkeley Technology Inc - Contract 01 href: type: string description: URL endpoint for the project contract. readOnly: true example: /objects/construction/project-contract/1 projectContractLine: type: object description: >- Reference to a specific project contract line. (Construction subscription) properties: key: type: string description: Unique key for the project contract line. example: '4' id: type: string description: Unique ID for the project contract line. example: Project-Contract-Line-04 name: type: string description: User-specified name of the project contract line. readOnly: true example: Project contract line 04 href: type: string description: URL endpoint for the project contract line. readOnly: true example: /objects/construction/project-contract-line/4 taxSchedule: type: object description: >- In tax-enabled companies, the tax schedule used to capture tax details in the sales transaction. (Construction subscription) properties: key: type: string description: Unique key for the tax schedule. example: '19' id: type: string description: Unique ID of the tax schedule. example: Sale Goods Standard href: type: string description: URL endpoint for the tax schedule. readOnly: true example: /objects/tax/order-entry-tax-schedule/19 buyToOrderContact: type: object description: Contacts for delivering the buy-to-order. properties: key: type: string description: Unique key for the contact. readOnly: true example: '13' id: type: string description: ID 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: Unique key for the document. example: '55' id: type: string description: ID for the document. example: Sales Invoice-SO0066 documentType: type: string description: The type of transaction document. example: Sales Invoice readOnly: true href: type: string description: URL endpoint for the document. readOnly: true example: /objects/order-entry-document::Sales%20Invoice/55 lineSubtotals: type: array description: Lines of the Order Entry document line subtotal. items: $ref: '#/components/schemas/order-entry-document-line-subtotal' order-entry-document-subtotal: type: object description: >- Details of subtotals, taxes, discounts, charges, and more for a transaction. properties: key: type: string description: System-assigned unique key for the Order Entry document subtotal. readOnly: true example: '12' id: type: string description: >- ID for the Order Entry document subtotal. This value is the same as the key for this object. readOnly: true example: '12' href: type: string description: URL endpoint for the Order Entry document subtotal. readOnly: true example: /objects/order-entry/document-subtotal/12 description: type: string description: Description of the document subtotal. example: Tax percentValue: type: string format: decimal-precision-10 description: >- Specify a percentage that will be applied to the transaction total. For example, for a restocking fee that's 3 percent of the total transaction, specify 3 in this field. 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' 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: Unique 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: ID for the Order Entry document line. readOnly: true example: '10' href: type: string description: URL 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 description: Dimensions associated with the document subtotal. allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: title: location description: Location associated with the document subtotal. type: object properties: key: type: string description: Unique key for the location. example: '22' id: type: string description: ID for the location. example: LOC-22 href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/22 department: title: department type: object description: Department associated with the document subtotal. properties: key: type: string description: Unique key for the department. readOnly: true example: '9' id: type: string description: Unique ID for the department. example: Accounting href: type: string readOnly: true description: URL endpoint for the department. example: /objects/company-config/department/9 documentHeader: type: object description: Header level details for the document subtotal. readOnly: true properties: key: type: string description: Unique 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 Order Entry document. example: Sales Order readOnly: true href: type: string description: URL endpoint for the Order Entry document. readOnly: true example: /objects/order-entry-document::Sales%20Order/23 order-entry-documentRequiredProperties: type: object required: - txnDate 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" }} internal-document-ref: type: object properties: referenceNumber: type: string description: Reference number example: INT-01 initiatedBy: type: object description: Initiated by properties: key: type: string description: Employee key example: '2' id: type: string description: Employee id example: dhatchet name: type: string description: Employee name example: David Hatcher readOnly: true href: type: string description: URL endpoint of the employee. example: /objects/company-config/employee/2 readOnly: true verbalApprovalBy: type: object description: Verbal approval by properties: key: type: string description: Employee key example: '2' id: type: string description: Employee id example: sdye name: type: string description: Employee name example: Sara Dye readOnly: true href: type: string description: URL endpoint of the employee example: /objects/company-config/employee/2 readOnly: true issuedBy: type: object description: Issued by properties: key: type: string description: Employee key example: '25' id: type: string description: Employee id example: amarquess name: type: string description: Employee name example: Adam Marquess readOnly: true href: type: string description: URL endpoint of the employee example: /objects/company-config/employee/25 readOnly: true issuedOnDate: type: string description: Issued on date format: date example: '2021-05-30' approvedBy: type: object description: Approved by properties: key: type: string description: Employee key example: '1' id: type: string description: Employee id example: treser name: type: string description: Employee name example: Tim Reser readOnly: true href: type: string description: URL endpoint of the employee example: /objects/company-config/employee/1 readOnly: true approvedOnDate: type: string description: Approved on date format: date example: '2021-10-02' signedBy: type: object description: Signed by properties: key: type: string description: Employee key example: '32' id: type: string description: Employee id example: broberts name: type: string description: Employee name example: Bob Roberts readOnly: true href: type: string description: URL endpoint of the employee example: /objects/company-config/employee/32 readOnly: true signedOnDate: type: string description: Signed on date format: date example: '2021-05-31' source: type: string description: Internal source example: Internal sourceReferenceNumber: type: string description: Internal source reference number example: REF-INT-01 external-document-ref: type: object properties: referenceNumber: type: string description: External reference number example: A23 verbalApprovalBy: type: object description: Verbal approval by properties: key: type: string description: Contact key example: '6' id: type: string description: Contact name example: Johnson href: type: string description: URL endpoint of the contact example: /objects/company-config/contact/6 readOnly: true approvedBy: type: object description: Approved by properties: key: type: string description: Contact key example: '51' id: type: string description: Contact name example: Jagadish href: type: string description: URL endpoint of the contact example: /objects/company-config/contact/51 readOnly: true approvedOnDate: type: string description: Approved on date format: date example: '2021-11-03' signedBy: type: object description: Signed by properties: key: type: string description: Contact key example: '200' id: type: string description: Contact name example: Modulus Industries href: type: string description: URL endpoint of the contact example: /objects/company-config/contact/200 readOnly: true signedOnDate: type: string description: Signed on date format: date example: '2021-12-01' entity-ref: type: object description: >- The entity that the object is associated with. Objects created at the top level do not have an entity reference so the `key`, `id`, and `name` properties will be `null`. readOnly: true properties: key: type: string description: Entity key. readOnly: true nullable: true example: '46' id: type: string description: Entity ID. readOnly: true nullable: true example: CORP name: type: string description: Entity name. readOnly: true nullable: true example: Corp href: type: string description: URL endpoint for the entity. readOnly: true example: /objects/company-config/entity/46 order-entry-document: type: object description: An Order Entry document contains information about sales transactions. properties: key: type: string description: System-assigned unique key for the document. readOnly: true example: '55' id: type: string description: Name or other unique ID for the document. readOnly: true example: Sales Invoice-SI-O122 href: type: string description: URL endpoint for the 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. 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: pending 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: '2023-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 txnDate: type: string description: Date on the Order Entry document. format: date example: '2024-04-04' dueDate: type: string description: Due date for the Order Entry document. format: date example: '2024-04-04' isSystemGeneratedDocument: type: boolean description: Indicates whether the document is system generated. readOnly: true example: true default: false postingDate: type: string format: date description: >- The date on which the Order Entry document posts to the General Ledger. example: '2024-04-04' referenceNumber: type: string description: Reference to another document, as needed. example: SALES-100 notes: type: string description: Notes about the document. example: Fast order memo: type: string description: Text to appear on the printed 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: '2024-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: '2024-04-04' shippedDate: type: string description: The date that the order was shipped. format: date example: '2024-04-04' serviceDeliveryDate: type: string description: The date on which the service is delivered. format: date example: '2024-04-04' cancelAfterDate: type: string description: Indicates the date after which the order can be canceled. format: date example: '2024-04-04' doNotShipBeforeDate: type: string description: Do not ship before this date. format: date example: '2024-04-04' doNotShipAfterDate: type: string description: Do not ship after this date. format: date example: '2024-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: '2024-04-04' retainagePercent: type: number description: >- Default retainage percent on the line item for a transaction. (Construction subscription) example: 10 scope: type: string description: >- Details about the expected scope of work to be performed or materials to be delivered. Use 4000 or fewer characters. (Construction subscription) maxLength: 4000 example: >- Subcontractor agrees to provide labor and materials for utility trenching for Five Oaks Storage facilities according to contract. inclusions: type: string description: >- Details related to items that are explicitly included in the terms of this document. Use 4000 or fewer characters. (Construction subscription) maxLength: 4000 example: Includes drive-through building exclusions: type: string description: >- Details related to items that are explicitly excluded in the terms of this document. Use 4000 or fewer characters. (Construction subscription) maxLength: 4000 example: Excludes additional purchase terms: type: string description: >- Additional terms or performance obligations. Use 4000 or fewer characters. (Construction subscription) maxLength: 4000 example: >- Follow all safety rules and security procedures that are in force and applicable during execution of work. schedule: type: object description: >- Additional details for Quote, Requisition, and Order type documents. (Construction Subscription) properties: scheduledStartDate: type: string description: >- Scheduled start date in the yyyy-mm-dd format. (Construction subscription) format: date example: '2024-05-07' scheduledCompletionDate: type: string description: >- Original scheduled date for completion of the work in the yyyy-mm-dd format. (Construction subscription) format: date example: '2024-10-07' actualStartDate: type: string description: >- Actual start date in the yyyy-mm-dd format. (Construction subscription) format: date example: '2024-05-07' actualCompletionDate: type: string description: >- Date the work is actually complete in the yyyy-mm-dd format. (Construction subscription) format: date example: '2024-10-10' revisedCompletionDate: type: string description: >- Revised completion date in yyyy-mm-dd format for the work (caused by changes).(Construction subscription) format: date example: '2024-11-01' substantialCompletionDate: type: string description: >- Date the work is considered substantially complete in the yyyy-mm-dd format. Typically used as a milestone to identify when payment obligations are due. (Construction subscription) format: date example: '2024-10-10' noticeToProceedDate: type: string description: >- Date when a formal notice to proceed was given in the yyyy-mm-dd format. (Construction subscription) format: date example: '2024-10-10' responseDueDate: type: string description: >- Date when a response is expected from an external party in the yyyy-mm-dd format. (Construction subscription) format: date example: '2024-10-10' executedOnDate: type: string description: >- Date the related contract document was formally executed in the yyyy-mm-dd format. (Construction subscription) format: date example: '2024-10-10' scheduleImpactNotes: type: string description: >- Details about any impacts on the current schedule. Use 100 or fewer characters. (Construction subscription) maxLength: 100 example: None internalReference: $ref: '#/components/schemas/internal-document-ref' externalReference: $ref: '#/components/schemas/external-document-ref' performanceBond: type: object description: >- Performance bond details from the vendor or a company for an order. (Construction subscription) properties: isRequired: type: boolean description: >- Set to `true` if a performance bond is required. (Construction subscription) example: false default: false isReceived: type: boolean description: >- Set to `true` if a performance bond was received. (Construction subscription) example: false default: false amount: type: string description: Amount of the performance bond. (Construction subscription) format: decimal-precision-2 example: '1000.00' vendor: type: object description: >- Vendor for the related surety company providing the performance bond. (Construction subscription) properties: key: type: string description: Unique key for the vendor. example: '11' id: type: string description: Unique ID for the vendor. example: VND-IND-0081 name: type: string description: User-specified name for the vendor. readOnly: true example: Vendor-India-0081 href: type: string description: URL endpoint for the vendor. readOnly: true example: /objects/accounts-payable/vendor/11 paymentBond: type: object description: >- Payment bond details from the vendor for an order. (Construction subscription) properties: isRequired: type: boolean description: Set to `true` if a payment bond is required. example: false default: false isReceived: type: boolean description: >- Set to `true` if a payment bond was received. (Construction subscription) example: false default: false amount: type: string description: Amount of the payment bond. (Construction subscription) format: decimal-precision-2 example: '1000.00' vendor: type: object description: >- Vendor for the related surety company providing the payment bond. (Construction subscription) properties: key: type: string description: System-assigned key for the vendor. example: '21' id: type: string description: Unique ID for the vendor. example: VND-IND-0081 name: type: string description: User-specified name for the vendor. readOnly: true example: Vendor-India-0081 href: type: string description: URL endpoint for the vendor. readOnly: true example: /objects/accounts-payable/vendor/21 revision: type: object description: Revision details post change order. (Construction subscription) properties: isDocumentChanged: type: boolean description: >- Whether the document has changes applied. (Construction subscription) readOnly: true example: false default: false revisedTotal: type: string description: Revised total. format: decimal-precision-2 readOnly: true example: '1000.00' revisedSubTotal: type: string description: Revised subtotal. (Construction subscription) format: decimal-precision-2 readOnly: true example: '1000.00' revisedTotalInTxnCurrency: type: string description: Revised total in transaction currency. format: decimal-precision-2 readOnly: true example: '1000.00' revisedSubTotalInTxnCurrency: type: string description: Revised subtotal in transaction currency. format: decimal-precision-2 readOnly: true example: '1000.00' changeLogNumber: type: number description: >- Log number for tracking the number of changes applied to a source transaction. Default 0 for a source transaction, 1 for a change transaction. example: 1 relatedDocumentNumber: type: string description: >- Document ID of the source transaction when updating a change order. Calculated when the transaction is a change order. (Construction subscription) readOnly: true example: Sales Invoice-Sal#0140#inv postedChangesTotal: type: string description: Posted changes total. (Construction subscription) format: decimal-precision-2 example: '1000.00' projectContractBilling: type: object description: >- Project contract billing details for the order or invoice. (Construction subscription) properties: externalReferenceNumber: type: string description: Project contract external reference. example: HGS-1024 description: type: string description: Project contract description. example: Construction of clubhouse and offices contractDate: type: string format: date description: Project contract date. example: '2024-05-08' billingThroughDate: type: string format: date description: Billing through date. example: '2024-05-08' billingApplicationNumber: type: string description: Billing application number. maxLength: 100 example: IA-89115 billingSummary: type: object description: >- Project contract billing summary details for the order or invoice. (Construction subscription) properties: originalContractAmount: type: string description: Original contract amount. format: decimal-precision-10 example: '1000.00' netChangesAmount: type: string description: Net changes amount. format: decimal-precision-10 readOnly: true example: '1000.00' revisedContractAmount: type: string description: Revised contract amount. format: decimal-precision-10 readOnly: true example: '1000.00' balanceToFinishAmount: type: string description: Balance to finish amount. format: decimal-precision-10 readOnly: true example: '1000.00' lessPriorApplicationAmount: type: string description: Less previous billings amount. format: decimal-precision-10 example: '1000.00' currentDueAmount: type: string description: Current amount due. format: decimal-precision-2 readOnly: true example: '1000.00' retainage: type: object description: Retainage details for the invoice. (Construction subscription) properties: previousBalanceAmount: type: string description: Previous retainage balance amount. format: decimal-precision-10 example: '1000.00' balanceAmount: type: string description: Retainage balance amount. format: decimal-precision-10 readOnly: true example: '1000.00' billedAmount: type: string description: Retainage billed amount. format: decimal-precision-10 readOnly: true example: '1000.00' heldAmount: type: string description: Retainage held amount. format: decimal-precision-10 readOnly: true example: '1000.00' completedAmount: type: string description: Retainage amount from completed work. format: decimal-precision-10 example: '1000.00' storedMaterialsAmount: type: string description: Retainage amount from stored materials. format: decimal-precision-10 example: '1000.00' billingTotals: type: object description: >- Project contract billing summary totals on the invoice. (Construction subscription) properties: completedToDateAmount: type: string description: Total completed to date amount. format: decimal-precision-10 readOnly: true example: '1000.00' storedMaterialsAmount: type: string description: Total stored materials amount. format: decimal-precision-10 readOnly: true example: '1000.00' heldAmount: type: string description: Total retainage held amount. format: decimal-precision-2 readOnly: true example: '1000.00' heldToDateAmount: type: string description: Total retainage held to date amount. format: decimal-precision-10 readOnly: true example: '1000.00' retainageOnThisInvoiceAmount: type: string description: Total retainage amount on this invoice. format: decimal-precision-2 readOnly: true example: '1000.00' earnedLessRetainageAmount: type: string description: Total earned less retainage amount. format: decimal-precision-10 readOnly: true example: '1000.00' lessRetainageHeldAmount: type: string description: Total less retainage held amount. format: decimal-precision-10 readOnly: true example: '1000.00' netChangesAmount: type: string description: Total net change amount. format: decimal-precision-10 readOnly: true example: '1000.00' netChangesAdditionAmount: type: string description: Total net change addition amount. format: decimal-precision-10 readOnly: true example: '1000.00' netChangesDeductionAmount: type: string description: Total net change deduction amount. format: decimal-precision-10 readOnly: true example: '1000.00' totalChangesApprovedPriorMonth: type: object description: >- Project contract billing totals approved for the prior month on the invoice. (Construction subscription) properties: additionsAmount: type: string description: Total additions amount approved in prior months. format: decimal-precision-10 example: '1000.00' deductionsAmount: type: string description: Total deductions amount approved in prior months. format: decimal-precision-10 example: '1000.00' totalChangesApprovedThisMonth: type: object description: >- Project contract billing totals approved for the current month on the invoice. (Construction subscription) properties: additionsAmount: type: string description: Total additions amount approved this month. format: decimal-precision-10 example: '1000.00' deductionsAmount: type: string description: Total deductions amount approved this month. format: decimal-precision-10 example: '1000.00' architect: type: object description: >- Reference to a project contract architect contact. (Construction subscription) properties: key: type: string description: Unique key for the contact. example: '1' id: type: string description: Unique ID for the contact. example: Eberhardt href: type: string description: URL endpoint for the contact. readOnly: true example: /objects/company-config/contact/12 projectContract: type: object description: Reference to the project contract. (Construction subscription) properties: key: type: string description: Unique key for the project contract. example: '1' id: type: string description: Unique ID for the project contract. example: BTI-01 name: type: string description: User-specified name of the project contract. readOnly: true example: Berkeley Technology Inc - Contract 01 href: type: string description: URL endpoint of the project contract. readOnly: true example: /objects/construction/project-contract/1 contacts: type: object description: Contacts associated with the Order Entry document. properties: primary: type: object description: Primary contact for the document. properties: key: type: string description: Unique key for the primary contact. readOnly: true example: '13' id: type: string description: ID for the primary contact. example: contact shipTo: type: object description: Ship-to contact for the document. properties: key: type: string description: Unique key for the ship-to contact. readOnly: true example: '33' id: type: string description: ID for the ship-to contact. example: contact billTo: type: object description: Bill-to contact for the document. properties: key: type: string description: Unique key for the bill-to contact. readOnly: true example: '44' id: type: string description: ID for the bill-to contact. example: contact shippingMethod: type: object description: Shipping method for the order. properties: key: type: string description: Unique key for the shipping method. example: '77' id: type: string description: ID for the shipping method. example: Air href: type: string description: URL endpoint for the shipping method. readOnly: true example: /objects/accounts-receivable/shipping-method/77 printedByUser: type: object description: User who printed the document. readOnly: true properties: key: type: string description: Unique key for the user. readOnly: true example: '21' id: type: string description: Name or other ID for the user. readOnly: true example: John href: type: string readOnly: true description: URL endpoint for the user. example: /objects/company-config/user/21 txnDefinition: type: object description: Transaction definition that is associated with the document. properties: key: type: string description: Unique key for the transaction definition. example: '11' id: type: string description: Name or other unique ID for the transaction definition. example: Sales Invoice href: type: string description: URL endpoint for the transaction definition. readOnly: true example: /objects/order-entry/txn-definition/11 sourceDocument: type: object description: >- The source transaction from which the Order Entry document was created. properties: key: type: string description: Unique key for the source document. example: '44' id: type: string description: Unique ID for the source document. example: Sales Order-SO0022 documentType: type: string description: Document type of the source document. example: Sales Order readOnly: true href: type: string description: URL endpoint for the source document. 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: Unique key for the customer. example: '15' id: type: string description: Unique ID for the customer. example: customer name: type: string description: Name of the customer. readOnly: true example: Grove Apartments href: readOnly: true description: URL endoint 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: Unique key for the contract. example: '46' id: type: string description: ID of the contract. example: CNRT1001 href: type: string description: URL 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: URL endpoint for the term. readOnly: true example: /objects/term/75 key: type: string description: Unique key for the term. example: '75' id: type: string description: Name or other unique ID for the 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 entity: $ref: '#/components/schemas/entity-ref' status: $ref: '#/components/schemas/status' 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: Unique key for the tax solution. example: '44' id: type: string description: ID for the tax solution. example: Avalara href: type: string description: URL endpoint 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 readOnly: true 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-price-list-entryRequiredProperties: type: object required: - startDate - endDate - value - valueType - priceList - item - productLine order-entry-price-list-entry: type: object description: >- An order entry price list entry contains the pricing for a selected item within a selected price list. You can create price list entries for items whose prices are determined based on an amount, a discount or mark up percentage, the quantity sold, and more. properties: key: type: string description: System assigned key for the price list entry. readOnly: true example: '38' maxLength: 8 id: type: string description: Price list entry ID. example: '38' maxLength: 8 href: type: string description: URL for the price list entry. readOnly: true example: /objects/order-entry/price-list-entry/38 productLine: type: object description: Provide product line to which this item belongs. properties: key: type: string description: System generated product line key example: '25' maxLength: 8 id: type: string description: Unique ID for the product line. example: Office_Supplies maxLength: 20 href: type: string description: URL for this product line. readOnly: true example: /objects/inventory-control/product-line/25 currency: type: string description: >- Provide the currency in which the price will be evaluated. This field is only applicable to multi-currency companies. example: USD startDate: type: string format: date description: >- Provide the date on which the price becomes effective. You can enter past or future dates. nullable: false example: '2024-01-01' endDate: type: string format: date description: >- Provide the date on which the price ends. You can enter past or future dates. nullable: false example: '2024-01-01' minimumQuantity: type: string format: decimal-precision-8 description: >- Use this option if you want to give or get price breaks according to the quantity ordered. With this type of pricing, the system multiplies the transaction quantity by the rate mapped to the quantity range in which the transaction quantity falls. example: '1' maximumQuantity: type: string format: decimal-precision-8 description: >- Use this option if you want to give or get price breaks according to the quantity ordered. With this type of pricing, the system multiplies the transaction quantity by the rate mapped to the quantity range in which the transaction quantity falls. example: '100' value: type: string format: decimal-precision-10 description: >- The value you provide depends on the type that you set in the valueType field. nullable: false example: '60.56' valueType: type: string description: Value Type example: actual enum: - actual - dollarMarkup - dollarDiscount - markupPercent - discountPercent default: actual isFixedPrice: type: boolean description: Indicates whether the price is the fixed or final price. example: 'false' enum: - 'true' - 'false' default: 'true' employee: type: object description: >- If you want to define a project billing rate, you use a combination of employee and item. Intacct will use the price associated with this item/employee combination for applicable timesheets when you generate invoices for time and materials projects. properties: key: type: string description: System assigned unique key for the employee. example: '25' maxLength: 8 id: type: string description: Unique ID of the employee. example: '123' href: type: string description: Endpoint for the employee. readOnly: true example: /objects/company-config/employee/25 item: type: object description: Price list entry for the item. properties: key: type: string description: System assigned unique item key. example: '89' id: type: string description: Unique ID of item. example: Battery name: type: string description: Name of the item. example: Battery for Car href: type: string description: Endpoint for the item. readOnly: true example: /objects/inventory-control/item/89 priceList: type: object description: Price list associated with the order entry price list/schedule. properties: key: type: string description: System assigned key for the order entry price list. example: '1' id: type: string description: Unique identifier for the order entry price list. nullable: false example: Base Price List maxLength: 20 href: type: string readOnly: true example: /objects/order-entry/price-list/1 audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdBy: type: string description: Created by. example: Admin readOnly: true nullable: true modifiedBy: type: string description: Modified by. example: Admin readOnly: true nullable: true status: $ref: '#/components/schemas/status' order-entry-price-listRequiredProperties: type: object required: - id 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 appliesTo: type: string description: Application enum: - purchasing - orderEntry 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' entity: $ref: '#/components/schemas/entity-ref' 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: System-assigned id for the order entry renewal template. readOnly: true example: '23' name: type: string description: Id for the order entry renewal template. example: Sales Renewal Template Id 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 about the renewal template. maxLength: 100 example: Template for subscription renewals. salesTxnCreation: type: object properties: enableTxnCreation: type: boolean description: >- Indicates whether Sage Intacct should create a new sales transaction as part of the renewal. example: false default: false transactionDefinition: type: object description: It is a reference for list of existing transaction definitions. properties: key: type: string description: Order entry transaction definition key. example: '1' id: type: string description: Order entry transaction definition id. example: Sales Invoice href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 daysBeforeAfter: type: integer description: >- The number of days before or after the source contract end date that Sage Intacct should create the sales transaction. maxLength: 4 example: 10 default: 10 beforeOrAfterContractEnd: type: string description: >- Indicates whether Sage Intacct should create the transaction before or after the source contract end date. example: before enum: - before - after default: before txnDateOnRenewedDocument: type: string description: > Establishes how the date on the sales transaction created by the renewal is determined. ** Valid Options: ** calculatedDate: Sage Intacct uses the transaction line item end date and adds or subtracts days based on the values of the beforeOrAfterContractEnd and daysBeforeAfter fields. contractEndDatePlusOneDay: the system adds one day to the transaction line item end date. example: calculatedDate enum: - calculatedDate - contractEndDatePlusOneDay default: contractEndDatePlusOneDay txnLineItemStartDate: type: string description: > Establishes how the line item start date on the sales transaction created by the renewal is determined: ** Valid Options: ** - sameAsDocumentDate: Sage Intacct uses the transaction date on the new sales transaction as the line item start date. - inheritOffsetFromParent - Sage Intacct keeps the number of days between the transaction date and the line item start date the same as exists in the source sales transaction. example: sameAsDocumentDate enum: - sameAsDocumentDate - withInheritedOffsetFromParent default: sameAsDocumentDate contractPricing: type: object description: Select the desired Pricing option for contract renewal. properties: pricingType: type: string description: | Contract Pricing for the sales line item type Options are, ** Valid Options: * - Same as original- the renewed contract will use the same price for the line item as in the original sales transaction. - Suggested price (Default pricing) - Intacct will use the suggested price for the renewed lines, if applicable. - Markup or markdown - Intacct will either discount or mark up the line item by the indicated percentage or actual amount. Choose one of the following for markup or markdown: -Percentage markup -Percentage markdown -Actual markup -Actual markdown example: sameAsOriginal enum: - sameAsOriginal - defaultPricing - markupOrMarkdown default: sameAsOriginal markup: type: string description: > Pricing markup. Markup or markdown: Intacct will either discount or mark up the line item by the indicated percentage or actual amount. ** Valid Options: ** Choose one of the following for markup: -Percentage markup -Percentage markdown -Actual markup -Actual markdown For percentages, indicate the percentage as a whole number (for example, 5). For amounts, indicate the amount value (for example, 500.00). example: percentageMarkup enum: - percentageMarkup - percentageDiscount - actualMarkup - actualDiscount default: percentageMarkup markupValue: type: string description: Pricing markup by value. maxLength: 6 example: '1.00' renewalNotifications: type: object description: >- renewalNotifications group specifies the properties about customer and internal Email group. More details are mentioned in properties. properties: customerEmail: type: object description: > The customerEmail group specifies whether Sage Intacct sends an email to the customer as part of the renewal process when the customer email Notifications are enabled. If yes, select an Email template, add from and to. From, to, Email text are the fields only applicable to legacy renewal templates. For new renewal templates, select an Email template. properties: enableNotification: type: boolean description: Flag to enable notification. example: false default: false from: type: string description: Enter an email address you want the recipient to reply to. maxLength: 30 example: someEmail@co.com to: type: string description: > Customer contact email id. ** Valid Options: ** - customerContact: The email id from customer contact. - customerBillToContact: The contact from the bill to email id of the customer’s bill to contact. - customerShipToContact: The contact from the ship to email id of the customer’s ship to contact.. example: customerContact enum: - customerContact - customerBillToContact - customerShipToContact default: customerContact daysBeforeAfter: type: integer description: >- The number of days before or after the source contract end date that Sage Intacct should send the customer email. maxLength: 4 example: 1 default: 0 beforeOrAfterContractRenewal: type: string description: >- Indicates whether Sage Intacct should send the customer email before or after the source contract end date. nullable: true example: before enum: - before - after - null default: before emailTemplate: type: object description: >- Intacct recommends that you use an email template for renewal templates for sending email to customer. If a pertinent email address is updated in Intacct, the email template can automatically pick up the new email address. The email template can contain the appropriate From/To email address parameters and customized text. 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 internalEmail: type: object description: > The internalEmail group specifies if the Sage Intacct sends an email to the customer as part of the renewal process when the internal email Notifications are enabled., they want to keep the draft or reply internal contact as well. If yes, select an Email template, add from and to. From, to, Email text are the fields only applicable to legacy renewal templates. For new renewal templates, select an Email template. properties: enableNotification: type: boolean description: Enable / disable Internal email. example: false default: false from: type: string description: From email id. example: sagefrom@intact.com to: type: string description: To email address. example: sageTo@intact.com beforeOrAfterContractRenewal: type: string description: >- Indicates whether Sage Intacct should send the internal email before or after the source contract end date. example: before enum: - before - after default: before daysBeforeAfter: type: integer description: >- The number of days before or after the source contract end date that Sage Intacct should send the internal email. maxLength: 4 example: 10 default: 10 emailTemplate: type: object description: >- Intacct recommends that you use an email template for renewal templates for sending email internally. If a pertinent email address is updated in Intacct, the email template can automatically pick up the new email address. The email template can contain the appropriate From/To email address parameters and customized text. properties: key: type: string description: Email template key. example: '1' id: type: string description: 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 salesforceOpportunity: type: object description: >- The salesforceOpportunity Group indicates whether a new opportunity should be created in Salesforce when the renewal occurs,specifying daysBeforeAfter,renewalName,beforeOrAfterContractRenewal,inheritProductsFromParent & stage. properties: enableSalesforceOpportunity: type: boolean description: >- Enable Salesforce opportunity in salesforce when the renewal occurs. example: false default: false beforeOrAfterContractRenewal: type: string description: >- Indicates whether Sage Intacct should create the Salesforce opportunity before or after the source contract end date. example: before enum: - before - after default: before daysBeforeAfter: type: string description: >- The number of days before or after the source contract end date that the opportunity should be created in Salesforce. maxLength: 4 example: '10' default: '10' renewalName: type: string description: >- Renewal name, If you do not want to use a naming convention but rather want a specific name for the new opportunity, enter the name in this field. example: SOrderRevRecActAlertSalesTeam inheritProductsFromParent: type: boolean description: >- Indicates whether Sage Intacct should populate the new opportunity with the same products (items) that existed in the original opportunity. example: false default: false stage: type: string description: | Set the Salesforce opportunity stage for the new opportunity. ** Valid Options: ** - Prospecting - Qualification - Needs Analysis - Value Proposition - Id. Decision Makers - Perception Analysis - Proposal/Price Quote - Negotiation/Review - Closed Won - Closed Lost - null example: prospecting enum: - prospecting - qualification - needsAnalysis - valueProposition - idDecisionMakers - proposalPriceQuote - negotiationReview - closedWon - closedLost - null default: closedLost latestVersion: type: string description: Latest version key of the template. maxLength: 10 readOnly: true example: '1' transactionType: type: string description: >- Transaction type is the module for which the renewal template transaction type can be created. Sales Transaction(order entry) or Contract or Evergreen example: salesTransaction enum: - salesTransaction - contract - evergreen default: salesTransaction renewalState: type: string description: Create renewal as. nullable: true example: inProgress enum: - inProgress - draft - null default: inProgress defaultTerm: type: object description: >- The defaultTerm group is specifically for contract module, the default term legnth & default period for which the renewal template is created. properties: period: type: string description: Default renewal term period unit, in years, months and days. example: months enum: - years - months - days default: months length: type: string description: Default renewal term length in numbers. maxLength: 2 example: '5' status: $ref: '#/components/schemas/status' entity: $ref: '#/components/schemas/entity-ref' order-entry-subtotal-template-lineRequiredProperties: type: object required: - description - subtotalType - valueType - txnType properties: glAccount: required: - id example: '6850.03' offsetGLAccount: required: - id example: '1200' subtotalTemplate: required: - key example: '4' order-entry-subtotal-template-line: type: object description: >- This object contains detailed information for Order Entry subtotal template lines. properties: key: type: string description: System-assigned key for the subtotal template line. readOnly: true maxLength: 8 example: '4' id: type: string description: >- System-assigned ID for the subtotal template line. This value is the same as the key for this object. readOnly: true maxLength: 8 example: '4' description: type: string description: >- Description of the subtotal. Each subtotal description must be unique. maxLength: 100 example: FreightCharge subtotalType: type: string description: Indicates whether the subtotal is a discount or charge. enum: - discount - charge example: discount lineNumber: type: integer description: Line number for the subtotal template line. maxLength: 8 example: 1 valueType: type: string description: The subtotal can be either the `amount` type or the `percent` type. enum: - amount - percent example: amount defaultValue: type: string format: decimal-precision-10 description: > Default value for the subtotal. If `valueType` is `amount`, specify the amount of the subtotal. For example, enter 250. If `valueType` is `percent`, specify a percentage as a whole number. For example, 10 for 10%. End Users can override the default subtotal value in the transaction. It can have up to 10 decimals and should be a positive numeric field maxLength: 12 example: '10.00' isApportioned: type: boolean description: >- Indicates whether the discount subtotal will be apportioned across all line items in the transaction. Cannot be enabled if `isTax` is set to `true`. default: false example: false glAccount: type: object description: Specify the GL account to which the subtotal will post. properties: key: type: string description: Unique key for the account. example: '297' id: type: string description: Unique number for the account. example: '6850.03' href: type: string readOnly: true description: URL endpoint for the account. example: /objects/general-ledger/account/297 offsetGLAccount: type: object description: Specify the offset GL account to which the subtotal will post. properties: key: type: string description: Unique key for the account. example: '36' id: type: string description: Unique ID for the account. example: '1200' href: type: string readOnly: true description: URL endpoint for the account. example: /objects/general-ledger/account/36 txnType: type: string description: >- Indicates whether the subtotal will debit or credit the corresponding GL account and GL offset account. enum: - null - debit - credit nullable: true example: debit applyToLineNumber: 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. maxLength: 8 example: 1 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. Set to `true` if the subtotal line is for tax. example: false default: false isAvalaraTax: type: boolean description: >- Set to `true` if the subtotal line item applies to AvaTax. This field only applies if your company uses the Avalara AvaTax integration. default: false example: false href: type: string description: URL endpoint for the subtotal template line. readOnly: true example: /objects/order-entry/subtotal-template-line/4 subtotalTemplate: type: object description: Order entry subtotal template that includes this line detail. readOnly: true properties: key: type: string description: Unique key for the parent order entry subtotal template. maxLength: 8 example: '3' id: type: string description: >- Unique ID for the parent purchasing subtotal template, same as the key. maxLength: 8 example: '3' href: type: string description: URL endpoint for the subtotal template. readOnly: true example: /objects/order-entry/subtotal-template/3 order-entry-subtotal-templateRequiredProperties: type: object required: - id properties: lines: type: array items: required: - description - subtotalType - valueType - txnType properties: glAccount: type: object required: - id offsetGLAccount: type: object required: - id order-entry-subtotal-template: type: object 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. properties: key: type: string description: System-assigned key for the order entry subtotal template. readOnly: true maxLength: 8 example: '3' id: type: string description: The name of the order entry subtotal template. maxLength: 100 example: SalesInvoiceCharges moduleKey: type: string description: Module key. readOnly: true default: 8.SO example: 8.SO href: type: string description: Endpoint for the order entry subtotal template. readOnly: true example: /objects/order-entry/subtotal-template/3 lines: type: array description: Details of the order entry subtotal template. items: $ref: '#/components/schemas/order-entry-subtotal-template-line' audit: $ref: '#/components/schemas/audit' order-entry-txn-definition-additional-gl-detailRequiredProperties: required: - id order-entry-txn-definition-additional-gl-detail: type: object description: >- Additional GL entry account mapping for an Order Entry transaction definition. properties: key: type: string description: System-assigned unique key for the additional GL detail object. readOnly: true example: '25' id: type: string description: >- Unique ID for the additional GL detail object. This value is the same as the key for this object. readOnly: true example: '25' href: type: string description: URL endpoint for the additional GL detail object. readOnly: true example: >- /objects/order-entry/order-entry-txn-definition-additional-gl-detail/25 isOffset: type: boolean description: >- Set to `true` if the GL account specified in the `glAccount` field is an offset account. Each `itemGLGroup` and `warehouse` set must have one offset account. example: true default: false txnType: type: string description: Specify whether to debit or credit the account. enum: - debit - credit example: debit moduleType: type: string description: Module type. example: additional enum: - additional lineNumber: type: integer description: Line number of the transaction. example: 1 maxLength: 8 glAccount: type: object description: >- The GL account to which the transaction posts for the mapped criteria set. properties: key: type: string description: Unique key for the GL account. example: '384' id: type: string description: User-assigned ID for the account. example: '1501.04' href: type: string description: URL endpoint for the account. readOnly: true example: /objects/general-ledger/account/384 location: type: object description: Location associated with the transaction definition. properties: href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/3345 key: type: string description: Unique key for the location. example: '3345' id: type: string description: Unique ID for the location. example: Arizona department: type: object description: Department associated with the transaction definition. properties: href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/28 key: type: string description: Unique key for the department. example: '28' id: type: string description: Unique ID for the department. example: Sales itemGLGroup: type: object description: >- The `itemGLgroup` and `warehouse` together form the criteria set for the account mapping. properties: href: type: string description: URL endpoint for the item GL group. readOnly: true example: /objects/inventory-control/item-gl-group/13 key: type: string description: Unique key for the item GL group. example: '13' id: type: string description: Name or other unique ID for the item GL group. example: Stockable Kit warehouse: type: object description: >- The `itemGLgroup` and `warehouse` together form the criteria set for the account mapping. properties: href: type: string description: URL endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 key: type: string description: Unique key for the warehouse. example: '23' id: type: string description: Unique ID for the warehouse. example: Warehouse-001 customerGLGroup: type: object description: >- Customer GL groups are categories of customers grouped together so that transactions can be posted to specific GL accounts. 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 for the owning transaction definition object. properties: key: type: string description: Unique key for the transaction definition. readOnly: true example: '23' id: type: string description: Unique ID for the transaction definition. readOnly: true example: Sales Quote href: type: string description: URL endpoint for the transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-ar-direct-gl-detailRequiredProperties: required: - id order-entry-txn-definition-ar-direct-gl-detail: type: object description: >- Accounts Receivable or direct GL account mapping for an Order Entry transaction definition. The item GL group, warehouse, and customer GL group together form the criteria set for the account mapping. properties: key: type: string description: >- System-assigned unique key for the Accounts Receivable or direct GL account detail object. readOnly: true example: '29' id: type: string description: >- Unique ID for the Accounts Receivable or direct GL account detail object. This value is the same as the key for this object. readOnly: true example: '29' href: type: string description: >- URL endpoint for the Accounts Receivable or direct GL account detail object. readOnly: true example: /objects/order-entry/txn-definition-ar-direct-gl-detail/29 isOffset: type: boolean description: >- Set to `true` if the GL account specified in the `glAccount` field is an offset account. Each `itemGLGroup`, `warehouse`, and `customerGLGroup` criteria set must have one offset account. example: true default: false txnType: type: string description: Specify whether to debit or credit the account. enum: - debit - credit example: debit moduleType: type: string description: Module type. example: subledger enum: - subledger - inventory - additional lineNumber: type: integer description: Line number of the transaction. example: 1 maxLength: 8 glAccount: type: object description: >- The GL account to which the transaction posts for the mapped criteria set. properties: key: type: string description: Unique key for the GL account. example: '384' id: type: string description: User-assigned ID for the account. example: '1501.04' href: type: string description: URL endpoint for the account. readOnly: true example: /objects/general-ledger/account/384 location: type: object description: Location associated with the transaction definition. properties: href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/3345 key: type: string description: Unique key for the location. example: '3345' id: type: string description: Unique ID for the location. example: Arizona department: type: object description: Department associated with the transaction definition. properties: href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/28 key: type: string description: Unique key for the department. example: '28' id: type: string description: Unique ID for the department. example: Sales itemGLGroup: type: object description: >- The `itemGLgroup`, `warehouse`, and `customerGLGroup` together form the criteria set for the account mapping. properties: href: type: string description: URL endpoint for the item GL group. readOnly: true example: /objects/inventory-control/item-gl-group/13 key: type: string description: Unique key for the item GL group. example: '13' id: type: string description: Name or other unique ID for the item GL group. example: Stockable Kit warehouse: type: object description: >- The `itemGLgroup`, `warehouse`, and `customerGLGroup` together form the criteria set for the account mapping. properties: href: type: string description: URL endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 key: type: string description: Unique key for the warehouse. example: '23' id: type: string description: Unique ID for the warehouse. example: Warehouse-001 customerGLGroup: type: object description: >- The `itemGLgroup`, `warehouse`, and `customerGLGroup` together form the criteria set for the account mapping. 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 for the owning transaction definition object. properties: key: type: string description: Unique key for the transaction definition. readOnly: true example: '23' id: type: string description: Unique ID for for the transaction definition. readOnly: true example: Sales Quote href: type: string description: URL endpoint for the transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-cogs-gl-detailRequiredProperties: required: - id order-entry-txn-definition-cogs-gl-detail: type: object description: >- GL account mappings for Cost of Goods Sold (COGS) for Order Entry transaction definitions. The item GL group, warehouse, and customer GL group together form the criteria set for the account mapping. properties: key: type: string description: System-assigned unique key for the COGS GL account detail object. readOnly: true example: '14' id: type: string description: >- Unique ID for the COGS GL account detail object. This value is the same as the key for this object. readOnly: true example: '14' href: type: string description: URL endpoint for the COGS GL account detail object. readOnly: true example: /objects/order-entry/txn-definition-cogs-gl-detail/14 isOffset: type: boolean description: >- Set to `true` if the GL account specified in the `glAccount` field is an offset account. Each `itemGLGroup`, `warehouse`, and `customerGLGroup` criteria set must have one offset account. example: true default: false txnType: type: string description: Specify whether to debit or credit the account. enum: - debit - credit example: debit moduleType: type: string description: Module type. example: subledger enum: - subledger - inventory - additional lineNumber: type: integer description: Line number of the transaction. example: 1 maxLength: 8 glAccount: type: object description: >- The GL account to which the transaction posts for the mapped criteria set. properties: key: type: string description: Unique key for the GL account. example: '384' id: type: string description: User-assigned ID for the account. example: '1501.04' href: type: string description: URL endpoint for the account. readOnly: true example: /objects/general-ledger/account/384 location: type: object description: Location associated with the transaction definition. properties: href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/3345 key: type: string description: Unique key for the location. example: '3345' id: type: string description: Unique ID for the location. example: Arizona department: type: object description: Department associated with the transaction definition. properties: href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/28 key: type: string description: Unique key for the department. example: '28' id: type: string description: Unique ID for the department. example: Sales itemGLGroup: type: object description: >- The `itemGLgroup`, `warehouse`, and `customerGLGroup` together form the criteria set for the account mapping. properties: href: type: string description: URL endpoint for the item GL group. readOnly: true example: /objects/inventory-control/item-gl-group/13 key: type: string description: Unique key for the item GL group. example: '13' id: type: string description: Name or other unique ID for the item GL group. example: Stockable Kit warehouse: type: object description: >- The `itemGLgroup`, `warehouse`, and `customerGLGroup` together form the criteria set for the account mapping. properties: href: type: string description: URL endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 key: type: string description: Unique key for the warehouse. example: '23' id: type: string description: Unique ID for the warehouse. example: Warehouse-001 customerGLGroup: type: object description: >- The `itemGLgroup`, `warehouse`, and `customerGLGroup` together form the criteria set for the account mapping. 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 for the owning transaction definition object. properties: key: type: string description: Unique key for the transaction definition. readOnly: true example: '41' id: type: string description: Unique ID for for the transaction definition. readOnly: true example: Sales Quote href: type: string description: URL endpoint for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/41 readOnly: true order-entry-txn-definition-entity-setting-detailRequiredProperties: required: - entity order-entry-txn-definition-entity-setting-detail: type: object description: Entity settings for Order Entry transaction definitions. properties: key: type: string description: System-assigned unique key for the entity setting detail object. readOnly: true example: '52' id: type: string description: >- System-assigned unique ID for the entity setting detail object. This value is the same as the key for this object. readOnly: true example: '52' href: type: string description: URL endpoint for the entity setting detail object. readOnly: true example: /objects/order-entry/txn-definition-entity-setting-detail/52 enableNumberingSequence: type: boolean description: >- Set to `true` to enable numbering sequences to be set for transactions. example: false default: false preserveNumberingSequence: type: boolean description: >- Set to `true` to ensure that numbers in a sequence are never skipped. Enabling this option can affect performance when a large volume of transactions is entered at the same time. example: false default: false canInheritSourceDocumentNumber: 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 documentTemplate: type: object description: >- Specify a printed document template to use as the default for printed output (PDFs) for the corresponding entity. If you do not specify a value for this field, the Order Entry transaction definition document template is used. properties: key: type: string description: Unique key for the document template. example: '65' maxLength: 8 id: type: string description: The name or other ID for the document template. example: Sales Order maxLength: 100 enableCreateTransactionRule: type: boolean description: >- The value for this field is set by Sage Intacct and is derived from the value specified for the `multiEntityRuleForTransaction` field in the owning transaction definition. example: false default: false subtotalTemplate: type: object description: >- If `enableSubtotals` is set to `true`in the owning transaction definition, you can specify the subtotal template to use to calculate subtotals. properties: href: type: string description: URL endpoint for the subtotal template. readOnly: true example: /objects/order-entry/subtotal-template/23 key: type: string description: Unique key for the subtotal template. example: '23' id: type: string description: Name or other ID for the subtotal template. example: Subtotal template showExpandedTaxDetail: 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 enableLineLevelSimpleTax: type: boolean description: >- Set to `true` to allow the tax rate to be overridden at the line level when using Simple Tax. example: false default: false entity: type: object properties: href: type: string description: URL endpoint for the entity. readOnly: true example: /objects/company-config/entity/41 key: type: string description: Unique key for the entity. example: '41' id: type: string description: >- Unique ID for the entity. The ID cannot be changed after the entity has been created and the maximum number of characters for the ID is 20. example: Lyon documentSequence: type: object description: >- Specify the document numbering sequence to use to automatically number transactions for the corresponding entity. Omit a numbering sequence here if you want to use the numbering sequence defined for the owning transaction definition, or if you want converted transactions to inherit the source document number. properties: key: type: string description: Unique key for the document numbering sequence. example: '10' href: type: string description: URL endpoint for the document numbering sequence. readOnly: true example: /objects/company-config/document-sequence/10 id: type: string description: ID of the document numbering sequence. example: Adjustment Decrease audit: $ref: '#/components/schemas/audit' order-entry-txn-definition: type: object description: Header level details for the owning transaction definition object. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '55' 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/55 readOnly: true order-entry-txn-definition-inventory-total-detailRequiredProperties: required: - inventoryTotal - maintainType - operation order-entry-txn-definition-inventory-total-detail: type: object description: >- Provides details about the inventory running total that will be affected by the transaction and how the total will be affected. properties: key: type: string description: System-assigned unique key for the inventory total detail object. readOnly: true example: '29' id: type: string description: >- ID for the inventory total detail object. This value is the same as the key for this object. readOnly: true example: '29' href: type: string description: URL endpoint for the inventory total detail object. readOnly: true example: /objects/order-entry/txn-definition-inventory-total-detail/29 maintainType: type: string description: >- Specify whether to track the quantity, value, or both quantity and value, for the inventory running total that will be affected by the transaction. enum: - quantity - value - quantityAndValue example: value operation: type: string description: >- Specify whether the inventory running total will increase or decrease when the user saves the transaction. enum: - add - subtract example: add inventoryTotal: type: object description: >- Specify the inventory running total that will be affected by the transaction. properties: id: type: string description: ID for the inventory total. example: ONHAND order-entry-txn-definition: type: object description: Header level details for the owning transaction definition object. properties: key: type: string description: Unique key for the transaction definition. readOnly: true example: '11' id: type: string description: Unique ID for the transaction definition. readOnly: true example: Sales Quote href: type: string description: URL endpoint for the transaction definition. readOnly: true example: /objects/order-entry/txn-definition/11 readOnly: true order-entry-txn-definition-source-document-detailRequiredProperties: required: - sourceDocument order-entry-txn-definition-source-document-detail: type: object description: >- Specifies the transaction definition from which the transaction can be converted. properties: key: type: string description: System-assigned unique key for the source document detail object. readOnly: true example: '18' id: type: string description: >- ID for the source document detail object. This value is the same as the key for this object. readOnly: true example: '18' href: type: string description: URL endpoint for the source document detail object. readOnly: true example: /objects/order-entry/txn-definition-source-document-detail/18 sourceDocument: type: object description: > Specify the transaction definition from which this transaction can be converted. For example, a sales invoice can be converted from a sales order. properties: href: type: string description: URL endpoint for the transaction definition. readOnly: true example: /objects/order-entry/txn-definition/44 key: type: string description: Unique key for the transaction definition. example: '44' id: type: string description: Name or other unique ID for the transaction definition. example: Sales order isDefault: type: boolean description: >- Specify whether the `sourceDocument` is the default for bulk conversion. example: true default: false order-entry-txn-definition: type: object description: Header level details for the owning transaction definition object. properties: key: type: string description: Unique key for the transaction definition. readOnly: true example: '11' id: type: string description: Unique ID for the transaction definition. readOnly: true example: Sales Quote href: type: string description: URL endpoint for the transaction definition. readOnly: true example: /objects/order-entry/txn-definition/11 readOnly: true order-entry-txn-definition-subtotal-detailRequiredProperties: required: - id - glAccount - offsetGLAccount - subtotalType - valueType - txnType - description order-entry-txn-definition-subtotal-detail: type: object description: >- Provides details about the type of subtotals that are supported for the transaction. properties: key: type: string description: System-assigned unique key for the subtotal detail object. readOnly: true example: '41' id: type: string description: >- System-assigned ID for the subtotal detail object. This value is the same as the key for this object. readOnly: true example: '41' href: type: string description: URL endpoint for the subtotal detail object. readOnly: true example: /objects/order-entry/txn-definition-subtotal-detail/41 subtotalType: type: string description: Specify the subtotal type. example: discount enum: - null - discount - charge nullable: true default: null lineNumber: type: integer description: Line number to which the subtotal applies. example: 1 maxLength: 8 description: type: string description: Description of the subtotal. example: Discount valueType: type: string description: Specify the value type for the subtotal. 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 `valueType` is `amount`, provide the amount of the subtotal. For example, enter 250. If `valueType` is `percent`, specify a percentage as a whole number. For example, specify 10 for 10%. Users can override the default subtotal value in the transaction. example: '10' maxLength: 12 isApportioned: type: boolean description: >- Set to `true` to distribute the discount subtotal proportionally across all line items in the transaction. Set this field to `true` if you are enabling MEA allocations in Order Entry. Leave this field `false` if you are enabling MEA allocations in Contracts. example: true default: false glAccount: type: object description: Specify the GL account to which the subtotal will post. properties: key: type: string description: Unique key for the GL account. example: '5' id: type: string description: User-assigned number for the GL account. example: '1501.04' href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/5 offsetGLAccount: type: object description: Specify the offset GL account to which the subtotal will post. properties: key: type: string description: Unique key for the GL account. example: '16' id: type: string description: Unique ID for the account. example: '1501.04' href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/16 txnType: type: string description: Specify whether to debit or credit the account. 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 `appliedToLineNumber` is implicitly assumed to be 0. Taxes, all other charges, and discounts are computed at the line level. This fields does not apply if `lineLevelSimpleTax` is set to `true` in the owning transaction definition. 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. Set this field to `true` for tax subtotal lines if your organization uses Simple Tax, Advanced Tax, or Avalara AvaTax. example: true default: false department: type: object description: Specify a default department for the subtotal. properties: href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/19 key: type: string description: Unique key for the department. example: '19' id: type: string description: Name or other unique ID for the department. example: Sales location: type: object description: Specify a default location for the subtotal. properties: key: type: string description: System-assigned unique key for the location. readOnly: true example: '22' id: type: string description: Unique ID for the location. readOnly: true example: Arizona href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/22 readOnly: true enableAvalaraTax: type: boolean description: >- Set to `true` if the subtotal line item applies to AvaTax. This field applies only if your company uses Avalara AvaTax integration. example: true default: false entity: type: object description: Sets the context where the transaction is created. properties: href: type: string description: URL endpoint for the entity. readOnly: true example: /objects/company-config/entity/3345 key: type: string description: Unique key for the entity. readOnly: true example: '3345' id: type: string description: Name of the entity. readOnly: true example: Australia readOnly: true order-entry-txn-definition: type: object description: Header level details for the owning transaction definition object. properties: key: type: string description: Unique key for the transaction definition. readOnly: true example: '29' id: type: string description: Unique ID for the transaction definition. readOnly: true example: Sales Quote href: type: string description: URL endpoint for the transaction definition. readOnly: true example: /objects/order-entry/txn-definition/29 readOnly: true order-entry-txn-definitionRequiredProperties: type: object required: - id order-entry-txn-definition: type: object description: >- An Order Entry transaction definition is the template for a sales transaction. It contains the accounting rules, workflow settings, and other configuration settings that determine a transaction's behavior. properties: key: type: string description: System-assigned unique key for the transaction definition. readOnly: true example: '23' id: type: string description: The name for the transaction definition. example: Sales Quote href: type: string description: URL endpoint for the transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 docClass: type: string description: >- Order Entry transaction template type, which determines whether certain fields appear on a transaction. example: quote enum: - quote - order - list - invoice - adjustment - other default: quote workflowCategory: type: string description: >- The workflow category associates the transaction with the applicable transaction menu grouping in the Order Entry menu. example: quote enum: - quote - order - shipping - invoice - return default: quote description: type: string description: A meaningful description of the 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. * `noEdit` - The user cannot edit the transaction after it is created. * `beforePrinting` - The user can edit the transaction until it has been printed to PDF. After it has been printed, the transaction cannot be edited. * `editInDraftOnly`- The user can edit the transaction until it has been posted. After it has been posted, the transaction cannot be edited. `all` - The user can edit the transaction as allowed by the transaction's condition. See [Editing a sales transaction](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Using_Order_Entry/Transactions/OE-transaction-lists.htm) for editing restrictions. 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. * `noDelete` - The user cannot delete the transaction after it is created. * `beforePrinting` - The user can delete the transaction until it has been printed to PDF. After it has been printed, the transaction cannot be deleted. * `all` - The user can delete the transaction as allowed by the transaction's condition. See [Editing a sales transaction](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Using_Order_Entry/Transactions/OE-transaction-lists.htm) for editing restrictions. example: all enum: - noDelete - beforePrinting - all default: noDelete enableNumberingSequence: type: boolean description: >- Set to `true` to enable numbering sequences to be set for transactions. example: false default: false preserveNumberingSequence: type: boolean description: >- Set to `true` to ensure that numbers in a sequence are never skipped. Enabling this option can affect performance when a large volume of transactions is entered at the same time. 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. * `leaveTransactionOpen` - When the user converts the transaction to another transaction type, the system leaves the original transaction open until all items are completed. * `closeOriginalAndCreateBackOrder` - When the user converts the transaction to another transaction type and enters an item quantity that's less than the original transaction quantity, the system closes the original transaction and creates a new transaction for the remaining item quantity. * `closeTransaction` - When the user converts the transaction to another transaction type, the system closes the original transaction regardless of whether the transaction is complete. See [Convert part of a transaction](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Using_Order_Entry/Transactions/Convert_transactions/convert-part-of-a-sales-transaction.htm) in the Sage Intacct Help Center for more information. 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. The following fields display amounts in the currency selected as the transaction currency on a transaction: Price, Extended price, Transaction value, and Transaction total. If `showBaseCurrency` is set to `true`, the transaction currency amount fields appear and the following fields also appear: Base price, Extended base price, Base value, and Base total. These additional fields display the amounts in the company's base 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 displayDraftsOnRevenueTxnEntriesPage: type: boolean description: >- Indicates whether the transaction can be displayed on the Revenue transaction entries page when in a draft state. 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 `renewalEnablementType` is set to `generate`. Set this field 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: Set to `true` to show the Bill-to contact in the printed document. example: false default: false printShipToContact: type: boolean description: Set to `true` to show the Ship-to contact in the printed document. example: false default: false allowEditingBillToContact: type: boolean description: >- Set to `true` to allow users to change the Bill-to contact during transaction entry. example: false default: false allowEditingShipToContact: type: boolean description: >- Set to `true` to allow users to change the Ship-to contact during transaction entry. example: false default: false enableWarnOnLowQuantity: type: boolean description: >- Set to `true` to alert the user when 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: >- Specifies 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: Set to `true` to enable additional posting to the 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: Set to `true` to enable costing for non-inventoried items. example: false default: false documentConversionPolicy: type: string description: > Document conversion policy. * `newDocumentOnly` - The user can create the transaction as a standalone transaction (by selecting Add from a transaction list, or the plus icon next to the transaction definition in the Sage Intacct menu, or by copying an existing transaction, and so on). * `newDocumentOrConvert` - The user can create the transaction as a standalone transaction or the user can create the transaction by converting the previous transaction in the workflow. * `convertOnly` - The user can only create the transaction by converting the previous transaction in the workflow. For example, the user can only create a sales invoice by converting an existing sales order. 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: >- Set to `true` to enable display of actual billings on printed or emailed invoices. example: false default: false lineLevelSimpleTax: type: boolean description: >- Set to `true` to allow the tax rate to be overridden at the line level when using Simple Tax. This option appears only if `enableSubtotals` is set to `true`. 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`. This field follows any editing restrictions imposed by the `editPolicy` field and is only applicable if the edit policy is set to `all` or `beforePrinting`. * `always` - The user can edit the customer in all applicable scenarios. * `exceptConvertedDocuments` - The user can edit the customer in the first transaction in a workflow but not in transactions created by conversion. * `never` - The user cannot edit the customer. example: always enum: - null - always - exceptConvertedDocuments - never nullable: true default: null enableRetainage: type: boolean description: >- For companies subscribed to Construction, set to 'true' to enable retainage. example: false default: false enableAdditionalInformationScope: type: boolean description: >- For companies subscribed to Construction, 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: >- For companies subscribed to Construction, set to 'true' to enable identification of dates for work milestones. example: false default: false enableInternalReference: type: boolean description: >- For companies subscribed to Construction, 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: >- For companies subscribed to Construction, 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: >- For companies subscribed to Construction, 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: >- Set to `true` to display the project contract billing for transactions. This option also displays project contract billing details on Order Entry Contract invoices. 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: >- Specify the document numbering sequence to use to automatically number transactions. Omit a numbering sequence if transactions are to be numbered manually or if they will inherit the source document number (`inheritDocumentNumber` is set to `true`). properties: key: type: string description: Unique key for the document numbering sequence. example: '10' href: type: string description: URL endpoint for the document numbering sequence. readOnly: true example: /objects/company-config/document-sequence/10 id: type: string description: ID of the document 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: URL endpoint for the price list. readOnly: true example: /objects/order-entry/price-list/6 key: type: string description: Unique key for the price list. example: '6' id: type: string description: ID for the 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: URL endpoint for the price list. readOnly: true example: /objects/order-entry/price-list/35 key: type: string description: Unique key for the price list. example: '35' id: type: string description: The name of the price list. example: OE Price List specialPriceList: type: object description: >- If using layered price lists, this indicates a special price list (for example, a discounted price list or seasonal price list). The special price list takes precedence over the initial price list. properties: href: type: string description: URL endpoint for the price list. readOnly: true example: /objects/order-entry/price-list/15 key: type: string description: Unique key for the price list. example: '15' id: type: string description: ID for the price list. example: Special price list warehouse: type: object description: >- Specify the default warehouse. Applies only if the `warehouseSelectionMethod` is set to `useTheDefaultWarehouse`. properties: key: type: string description: Unique key for the warehouse. example: '21' href: type: string description: URL endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/21 id: type: string description: Unique name or other ID 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: URL endpoint for the shipping method. readOnly: true example: /objects/accounts-receivable/shipping-method/11 key: type: string description: Unique key for the shipping method. example: '11' id: type: string description: Name of the shipping method. example: FedEx subtotalTemplate: type: object description: >- Specifies the template for populating the transaction subtotals table. properties: href: type: string description: URL endpoint for subtotal template. readOnly: true example: /objects/order-entry/subtotal-template/22 key: type: string description: Unique key for the subtotal template. example: '22' id: type: string description: Name of the 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: URL endpoint for the AR term. readOnly: true example: /objects/accounts-receivable/term/41 key: type: string description: Unique key for the AR term. example: '41' id: type: string description: The name of AR term. example: 10 Days exchangeRateType: type: object description: >- Specify a custom exchange rate type if transactions should not default to the Sage Intacct Daily Rate. properties: key: type: string description: Unique key for the exchange rate type. example: '-1' id: type: string description: The name of exchange rate type. example: Intacct Daily Rate href: type: string description: URL endpoint for the exchange rate type. readOnly: true example: /objects/company-config/exchange-rate-type/-1 status: $ref: '#/components/schemas/status' entity: $ref: '#/components/schemas/entity-ref' 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 the `enableCosting` field is set to `true`. items: $ref: '#/components/schemas/order-entry-txn-definition-cogs-gl-detail' accountReceivableOrDirectGLDetail: type: array description: >- When the `txnPostingMethod` field is set to `toAR` or `toGL`, 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 the `txnPostingMethod` field is set to `toAR` and the `postToGL` field 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: >- Specifies the inventory running total that will be affected by the transaction and how the total will be affected. items: $ref: '#/components/schemas/order-entry-txn-definition-inventory-total-detail' subtotalDetail: type: array description: >- Provides details about the type of subtotals that are supported for the transaction. items: $ref: '#/components/schemas/order-entry-txn-definition-subtotal-detail' sourceDocumentDetail: type: array description: Provides document conversion details for the transaction. items: $ref: '#/components/schemas/order-entry-txn-definition-source-document-detail' entitySettingDetail: type: array description: >- Provides details about the entities that can create transactions, and also includes settings for each entity, such as numbering sequences and document templates. items: $ref: '#/components/schemas/order-entry-txn-definition-entity-setting-detail' 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/oauth2/authorize tokenUrl: https://api.intacct.com/ia/api/v1/oauth2/token refreshUrl: https://api.intacct.com/ia/api/v1/oauth2/token scopes: {}