openapi: 3.0.0 info: title: Sage Intacct REST API description: Combined schema file for all Open Beta objects. version: '1.0' servers: - url: https://api.intacct.com/ia/api/v1-beta2 description: Open Beta tags: - name: Accounts_Payable_Payment providers description: > Provides information about subscribed payment providers. For example, if an account includes a subscription to Vendor Payments powered by CSI, you can use these operations to retrieve information for that payment provider. Payment provider services, like Vendor Payments powered by CSI and Amex Credit Card, are only for US vendors accepting USD. See [Compare payment methods](https://www.intacct.com/ia/docs/en_US/help_action/Cash_Management/Payment_Methods/select-a-payment-method.htm) for more information. x-displayName: Payment providers - name: Accounts_Payable_Payment provider bank accounts description: >- Models the bank accounts associated with a payment provider for electronic payments. After the subscription status for a payment provider is Subscribed, you can add bank accounts for that payment provider. Subscribed status is set after your company's application has been received by the payment provider and all required paperwork has been signed. Payment provider services, like Vendor Payments powered by CSI and Amex Credit Card, are only for US vendors accepting USD. See [Compare payment methods](https://www.intacct.com/ia/docs/en_US/help_action/Cash_Management/Payment_Methods/select-a-payment-method.htm) for more information.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Payment provider bank accounts - name: Accounts_Payable_Provider payment methods description: >- Provides relevant information for a subscribed payment provider's supported payment methods. After confirming a payment provider's information, you can associate a vendor and a bank account with that payment provider. See [Payment provider bank accounts](/openapi/cm/payment-provider-bank-account/tag/Payment-provider-bank-accounts/#tag/Payment-provider-bank-accounts) and [Vendor payment providers](/openapi/ap/vendor-payment-provider/tag/Vendor-payment-providers/#tag/Vendor-payment-providers) to learn more. Payment provider services, like Vendor Payments powered by CSI and Amex Credit Card, are only for US vendors accepting USD. See [Compare payment methods](https://www.intacct.com/ia/docs/en_US/help_action/Cash_Management/Payment_Methods/select-a-payment-method.htm) for more information.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Provider payment methods - name: Accounts_Payable_Terms description: >- An Accounts Payable term is a rule that a vendor establishes for extending credit to your company. Terms can be associated with transactions or with specific vendors. x-displayName: Terms - name: Accounts_Payable_Vendors description: > Vendors are individuals or companies that you pay for goods and services. When you create a vendor, you provide a name and a unique identifier (unless the company is configured to auto-generate identifiers). You can also designate a credit limit, set a payment priority, establish the payment method for this vendor, and so forth. x-displayName: Vendors - name: Accounts_Payable_Vendor types description: > Vendor types organize vendors into categories that are used for reporting. To share vendor types across entities, create vendor types at the top level. Creating vendor types in an entity restricts them to that entity. For more information, see [Vendor types](https://www.intacct.com/ia/docs/en_US/help_action/Accounts_Payable/Setup/Vendor_Types/aa-TOC-vendor-types.htm?tocpath=Applications%7CAccounts%20Payable%7CVendors%7CVendors%20list%7CVendor%20types%7C_____0). x-displayName: Vendor types - name: Accounts_Payable_Vendor payment providers description: > Models a payment provider associated with a vendor. You can link a vendor with a payment provider using the create and update operations for this object. Payment provider services, like Vendor Payments powered by CSI and Amex Credit Card, are only for US vendors accepting USD. See [Compare payment methods](https://www.intacct.com/ia/docs/en_US/help_action/Cash_Management/Payment_Methods/select-a-payment-method.htm) for more information. x-displayName: Vendor payment providers - name: Accounts_Payable_Account labels description: >- Account labels give accounts more descriptive names that are displayed anywhere the accounts are referenced in the product and in reports. Account labels is an optional feature that must be enabled when configuring Accounts Payable. x-displayName: Account labels - name: Accounts_Payable_Adjustments description: >- Adjustments can be used to increase or decrease the amount you owe a vendor.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Adjustments - name: Accounts_Payable_Adjustment lines description: >- Line items in an adjustment represent transactions captured in that adjustment.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Adjustment lines - name: Accounts_Payable_Adjustment summaries description: >- Summaries are collections of the same type of transactions grouped together for processing. An adjustment summary is a collection of Accounts Payable adjustments.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Adjustment summaries - name: Accounts_Payable_Bills description: >- An AP bill is a statement of charges for money owed to a vendor for goods or services. After creating a bill, you can move it along the normal Accounts Payable (AP) workflow. For example, that might mean approving the bill, creating a payment request for the bill, and paying the bill.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Bills - name: Accounts_Payable_Bill lines description: >- Line items in a bill represent charges for purchased items or services.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Bill lines - name: Accounts_Payable_Bill summaries description: >- Accounts Payable summaries are collections of the same type of transactions, grouped together for processing.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Bill summaries - name: Accounts_Payable_Payments description: >- A payment is a transaction that records a payment against a bill or adjustment. The payment object gives you access to payment details for each payment entry. For example, you can apply line level credits/discounts to a payment entry through one or more [payment detail objects](/openapi/ap/accounts-payable-payment-detail/tag/Payment-details).
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Payments - name: Accounts_Payable_Payment lines description: >- Payment line items represent entries in a payment object. accounts-payable-payment-line is an owned object of [accounts-payable-payment](/openapi/ap/accounts-payable-payment/tag/Payments).
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Payment lines - name: Accounts_Payable_Payment details description: >- A payment detail object includes a bill or adjustment credit memo to pay and optional transactions to apply as credits. accounts-payable-payment-detail is an owned object of [accounts-payable-payment](/openapi/ap/accounts-payable-payment/tag/Payments).
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Payment details - name: Accounts_Payable_Summaries description: >- Summaries are collections of the same type of transactions, grouped together and posted to the General Ledger using the date determined by your summary frequency. The individual transactions in a summary are processed immediately. The Summaries page in Accounts payable shows bill, adjustment, and manual payment summaries that Intacct created automatically or that you created manually.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Summaries - name: Accounts_Payable_Recurring bills description: >- Recurring bills are bills that repeat at periods and durations defined in a recurrence schedule. The system respects the company's accounting periods to generate and post transactions based on the defined month end.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Recurring bills - name: Accounts_Payable_Recurring bill lines description: >- Line items in a recurring bill represent transactions captured in that recurring bill.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Recurring bill lines - name: Accounts_Payable_Vendor contacts description: >- Contact information for a vendor.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Vendor contacts - name: Accounts_Payable_Vendor email templates description: >- Vendor email templates are an efficient way to automate sending document attachments with a standard message to multiple vendors.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Vendor email templates - name: Accounts_Payable_Vendor account groups description: >- Account groups are the basis of financial reports. Every account must be part of an account group so that its data is included in balance sheets, income statements, and other financial reports.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Vendor account groups - name: Accounts_Payable_Vendor account numbers description: >- The account number a vendor assigns to you. For example, a telephone company might assign your phone number as your vendor account number. This helps the vendor to match the payment information with the bill being paid.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Vendor account numbers - name: Accounts_Payable_Vendor bank file setups description: >- A bank file enables electronic payments to be made to vendors using a local bank file format. Bank files are standard files used by banks to make multiple payments.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Vendor bank file setups - name: Accounts_Receivable_Invoices description: >- An invoice object represents an invoice sent to a customer for goods or services provided. x-displayName: Invoices - name: Accounts_Receivable_Invoice lines description: Line items in an invoice represent transactions captured in that invoice. x-displayName: Invoice lines - name: Accounts_Receivable_Account labels description: > Account labels give accounts more descriptive names that are displayed anywhere the accounts are referenced in the product and in reports. Account labels is an optional feature that must be turned on in Accounts Receivable. See [Enable functionality](https://www.intacct.com/ia/docs/en_US/help_action/Accounts_Receivable/Setup/configure-accounts-receivable-htm#Enable) for more information. x-displayName: Account labels - name: Accounts_Receivable_Terms description: >- Accounts Receivable (AR) terms are the rules a company establishes for extending credit to customers. Terms can be associated with AR transactions and with customers. x-displayName: Terms - name: Accounts_Receivable_Customers description: > A customer is any company to which you sell goods and services. Sage Intacct applications use the customer information for record-keeping purposes, printing the names and addresses on forms, such as invoices, and for determining the ship-to contact so tax can be computed. x-displayName: Customers - name: Accounts_Receivable_Customer types description: >- Customer types provide a way to group customers into categories, such as reseller and end user. Setting up meaningful customer types streamlines management and analysis of customer information. x-displayName: Customer types - name: Accounts_Receivable_Customer email templates description: >- Customer email templates can be used to standardize messages sent to multiple customers.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Customer email templates - name: Accounts_Receivable_Adjustments description: >- An adjustment is a transaction that applies a credit or debit in order to modify the amount owed by a customer. x-displayName: Adjustments - name: Accounts_Receivable_Adjustment lines description: >- Line items in an adjustment represent debits or credits to modify the amount owed by a customer. x-displayName: Adjustment lines - name: Accounts_Receivable_Advances description: >- Advances let you receive customer advance payments before creating an invoice, such as if a customer sends you a retainer
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Advances - name: Accounts_Receivable_Advance lines description: >- An advance line item is associated with a particular advance. Each advance can have any number of line items.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Advance lines - name: Accounts_Receivable_Billback templates description: >- Create a bill back template for each recurring bill back transaction. The template provides line item information needed in the bill back transaction, including invoice line items and corresponding line items in the system-generated bill.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Billback templates - name: Accounts_Receivable_Billback template lines description: >- Line items for a bill back template.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Billback template lines - name: Accounts_Receivable_Invoice summaries description: >- Invoice summaries are collections of the same type of transactions grouped together for processing. AR invoice summaries can be either open or closed. Invoices can be added to open summaries.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Invoice summaries - name: Accounts_Receivable_Payments description: >- A payment is a transaction used to record a payment against an invoice or an adjustment/debit memo. x-displayName: Payments - name: Accounts_Receivable_Payment lines description: >- Line items in a payment represent charges for items or services included in an invoice or adjustment.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Payment lines - name: Accounts_Receivable_Payment details description: >- A payment detail object can specify either an object, like an invoice or an adjustment, as a whole (header level), or it can specify a line item. A payment detail object also provides the transaction amount that was received.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Payment details - name: Accounts_Receivable_Payment summaries description: >- AR payment summaries are collections of the same type of transactions grouped together for processing. AR payment summaries can be either open or closed. Payments can be added to open summaries.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Payment summaries - name: Accounts_Receivable_Summaries description: >- Summaries are collections of the same type of transactions, grouped together for processing. Summaries can be either opened or closed. Invoices, adjustments, and deposits can be added to open summaries.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Summaries - name: Accounts_Receivable_Territories description: >- Territories are optionally included in customer records and are used with Accounts Receivable reports. They can be useful for filtering and categorizing data, assuming your company has multiple territories.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Territories - name: Accounts_Receivable_Territory groups description: >- Group territories to generate reports that contain data for that group of territories.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Territory groups - name: Accounts_Receivable_Territory group members description: >- A territory group member is an individual territory included in a territory group.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Territory group members - name: Accounts_Receivable_Customer item cross references description: >- Customer item cross references match the customer identifier for an item to the item ID your company uses, which makes transaction entry easier and more robust.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Customer item cross references - name: Accounts_Receivable_Customer contacts description: >- Contact information for a customer.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Customer contacts - name: Accounts_Receivable_Customer account groups description: >- Customer account groups
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Customer account groups - name: Accounts_Receivable_Recurring invoices description: >- Recurring invoices are invoices that repeat at periods and durations defined in a recurrence schedule. The system respects the company's accounting periods to generate and post transactions based on the defined month end.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Recurring invoices - name: Accounts_Receivable_Recurring invoice lines description: >- Line items in a recurring invoice represent transactions captured in that recurring invoice.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Recurring invoice lines - name: Accounts_Receivable_Posted overpayments description: >- Payments received that exceed the amount the customer owes are overpayments. Overpayments can be applied to future invoices or the excess can be returned to the customer.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Posted overpayments - name: Accounts_Receivable_Posted overpayment lines description: >- Line items in a posted overpayment.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Posted overpayment lines - name: Accounts_Receivable_Revenue recognition templates description: >- Revenue recognition templates define how to amortize deferred revenue. Each template is associated with an Accounts Receivable label or Order Entry Item GL group.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Revenue recognition templates - name: Accounts_Receivable_Revenue recognition template lines description: >- This object represents line entries in a revenue recognition template.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Revenue recognition template lines - name: Accounts_Receivable_Revenue recognition template milestones description: >- Milestone information for revenue recognition templates that have a recognition method of percent complete, milestone, or custom.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Revenue recognition template milestones - name: Cash_Management_Financial institutions description: >- A financial institution serves as an umbrella object for bank accounts that use the same sign-in process to connect to bank feeds.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Financial institutions - name: Cash_Management_Bank accounts description: >- This object provides information about a bank account, which can be a checking, savings, or a credit card account.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Bank accounts - name: Cash_Management_Checking accounts description: >- A checking account object models a real-world checking account at a bank and supports checking account reconciliation.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Checking accounts - name: Cash_Management_Deposits description: > Transaction record for a deposit. A deposit captures the transfer of funds from a company's undeposited funds account to a bank account when collected and held payments are moved to a bank. To record a deposit, the payment must already be received against an undeposited funds account. For more information, see [About deposits](https://www.intacct.com/ia/docs/en_US/help_action/Accounts_Receivable/Deposits/about-deposits.htm). x-displayName: Deposits - name: Cash_Management_Deposit lines description: Line items in a deposit represent payments received from customers. x-displayName: Deposit lines - name: Cash_Management_Deposit details description: >- Line items in a deposit represent payments received from customers.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Deposit details - name: Cash_Management_Other receipts description: >- Other receipts are receipts that are not associated with a customer or invoice. Other receipts can include cash, a card charge, a cash transfer, or a check payment.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Other receipts - name: Cash_Management_Other receipts lines description: >- Line items in an other receipts object represent transactions that are not associated with a customer or invoice.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Other receipts lines - name: Cash_Management_Credit card transaction templates description: >- If using a creation rule for reconciliation, the rule needs to have a transaction template. Transaction templates define how to create new transactions in Sage Intacct based on bank data from an import file or bank feed.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Credit card transaction templates - name: Cash_Management_Credit card transaction line templates description: >- Template for credit card transaction lines.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Credit card transaction line templates - name: Cash_Management_Journal entry templates description: >- If using a creation rule for reconciliation, the rule needs to have a transaction template. Transaction templates define how to create new transactions in Sage Intacct based on bank data from an import file or bank feed.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Journal entry templates - name: Cash_Management_Journal entry line templates description: >- Template for journal entry lines.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Journal entry line templates - name: Cash_Management_Bank transaction rule sets description: >- A rule set acts as a container for matching and creating rules. The rules determine how to match incoming bank transactions or create new transactions for reconciliation in Sage Intacct. x-displayName: Bank transaction rule sets - name: Cash_Management_Bank transaction rules description: >- Bank transaction rules define whether to match or create Sage Intacct transactions when processing incoming bank transactions.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Bank transaction rules - name: Cash_Management_Bank transaction rule filter attributes description: >- Filter attribute used in rules.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Bank transaction rule filter attributes - name: Cash_Management_Bank transaction rule group attributes description: >- Group attribute used in rules.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Bank transaction rule group attributes - name: Cash_Management_Bank transaction rule maps description: >- Rules to rule set map.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Bank transaction rule maps - name: Cash_Management_Bank transaction rule match attributes description: >- Match attribute used in rules.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Bank transaction rule match attributes - name: Cash_Management_Deposited funds description: >- Transaction record for deposited fund. Deposited transaction that is deposited in bank account.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Deposited funds - name: Cash_Management_Undeposited funds description: >- Transaction record for undeposited funds.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Undeposited funds - name: Company_and_Configuration_Attachments description: >- An attachment object contains an array of one more or more files that are stored in Sage Intacct. You can attach multiple files of any type to a transaction using an attachment, such as scanned images, spreadsheets, and word-processor documents. For example, you might add ten scanned images to a single attachment for a bill. It's important to note that each transaction or record can only have one attachment assigned to it. After you add an attachment, you can add or delete individual files to and from the attachment, ensuring your supporting documents are always up-to-date. All attachments are stored in attachment [folders](/openapi/co/company-config-folder/tag/Attachment-folders).
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Attachments - name: Company_and_Configuration_Attachment folders description: >- Folder are used to store [attachments](/openapi/co/company-config-attachment/tag/Attachments) for easy grouping. For example, you can create an attachment folder for a project and store every supporting document for the project in that folder. Attachment folders can be nested. The folder hierarchy can be as broad or deep as needed.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Attachment folders - name: Company_and_Configuration_Classes description: >- [Class](https://www.intacct.com/ia/docs/en_US/help_action/Reporting/Setup/Dimensions/Managing_classes/class-information.htm) is a flexible [dimension](https://www.intacct.com/ia/docs/en_US/help_action/Reporting/Setup/Dimensions/dimensions-overview-ns.htm) that can be defined in a company and used to track just about anything. You can rename the class dimension and add custom fields if needed, and then select a class and provide values for the fields in applicable transactions. You can use the data to create custom reports that provide important business insights. Note that renaming the class dimension in the UI does not change the name of this object in the API. You still use `class` in API requests. x-displayName: Classes - name: Company_and_Configuration_Contacts description: >- Contacts serve as a common, shared address book that's used across a company by many people for a variety of purposes. Contacts hold all the information needed to contact an individual or business, including name, email address, phone number, mailing address, and more. Contacts are almost always used with other Sage Intacct objects, such as vendors, customers, or locations. For example, you specify a contact in Order Entry and Purchasing transactions to set a ship-to, bill-to, pay-to, or return-to addresses, and to determine tax on transactions.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Contacts - name: Company_and_Configuration_Departments description: >- Department is an optional [dimension](https://www.intacct.com/ia/docs/en_US/help_action/Reporting/Setup/Dimensions/dimensions-overview-ns.htm) that can be used for tagging, filtering, and categorizing data in many areas of Sage Intacct. The list of departments is shared by all entities in a company. Users can be restricted to only work with and see specific departments, which might affect what data they can see in reports, transactions, and other data records. You can create a hierarchy of departments to reflect how departments are organized within a company. To set up a hierarchy, create the parent departments first and then specify a parent department when adding child departments. x-displayName: Departments - name: Company_and_Configuration_Entities description: >- In a multi-entity shared company, entities represent a separate tax identification or a separately secured, fully balancing set of books. Entities typically represent divisions, franchises, affiliates, associations, locations, chapters, self-balancing funds or subsidiaries, with a shared chart of accounts.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Entities - name: Company_and_Configuration_Locations description: > Location is a [dimension](https://www.intacct.com/ia/docs/en_US/help_action/Reporting/Setup/Dimensions/dimensions-overview-ns.htm) that is used to represent the geographic locations of offices or facilities, or to represent divisions in a company. Once you have defined some locations, you can set locations on transactions, and that information can be used to provide new insights in reports. You can create a hierarchy of locations to reflect how locations are organized within your company. x-displayName: Locations - name: Company_and_Configuration_Document sequences description: >- Use document sequencing to generate new IDs automatically for common transactions and records, such as new customers, vendors, invoices, and more. For example, you can create a document sequence for invoices. This new sequence automatically creates a new ID, such as 'INV-0100' and increments the number each time a new invoice is created. x-displayName: Document sequences - name: Company_and_Configuration_Email templates description: >- Use email templates to organize email content and add style to make emails stand out to your customers and vendors. Create a variety of email templates to use for different types of transactions, different vendors, or different customers. You can add merge fields to populate emails with dynamic data from Sage Intacct, such as the vendor name, contact information, and so on.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Email templates - name: Company_and_Configuration_Users description: >- Users are individuals who have access to some part of Sage Intacct. Most users are employees, but users might also be outside the company, such as accountants, attorneys, bankers, vendors, customers, or auditors.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Users - name: Company_and_Configuration_Roles description: >- Roles can be defined for various job functions. Permissions to perform certain tasks can be assigned to specific roles, and roles can then be assigned to users or user groups.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Roles - name: Company_and_Configuration_Permissions description: > Each specific role is associated with particular modules, and each module contain multiple permissions. When assigning a permission to a specific role there will be a validation that ensures that the specified permissions are allowed for the role. x-displayName: Permissions - name: Company_and_Configuration_Role permission assignments description: >- This object shows a permission-to-role relationship and the access rights on that specific permission. x-displayName: Role permission assignments - name: Construction_Project change orders description: >- Project change orders provide project managers or contract administrators at construction companies a mechanism to group several change requests together, for the purpose of presenting them to the customer for approval, and ultimately, for billing.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Project change orders - name: Construction_Change requests description: >- Change Requests provide construction companies a way to keep track of changes to their projects in terms of cost, price and markup. A change request may consist of one or more lines of changes that are captured using the construction work breakdown structure (Project + Task + Cost Type) along with cost and price information. Information about other dimensions may also be captured when relevant. In some instances only the cost is captured, when the change is not billed to the customer. Sometimes the cost and price on a change request are the same amount, such as when the cost of a change is simply passed on to the customer. Sometimes, in the early stages of a change request, you may not have all the information at a line item level. In such cases, you may want to create a change request without any line items, and later go back to it to add line item along with cost and/or price information. Once a change request is approved, the user would want to update the primary estimate of the project by posting the change request. When the primary estimate is posted to GL budgets, those line items generated by the posting of the change request would also be part of the posting of the project estimate to GL budgets.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Change requests - name: Construction_Change request lines description: >- Change request lines describe the specific changes in a change request. Change request lines can only be added, updated, and deleted through the owning change-request object. x-displayName: Change request lines - name: Construction_Change request types description: >- Construction companies can create their own change request types to categorize change request information for reporting purposes. For example, an Internal change request type might be used for a change request that specifies a cost to the contractor that should not be billed to the customer. x-displayName: Change request types - name: Construction_Change request statuses description: >- Construction companies can create their own user-defined statuses for change requests. A change request status is mapped to a workflow type, which controls whether change request lines post to the primary project estimate. A workflow type of none (the default) prevents change request lines from posting. Other workflow types, such as pending change, approved change, and so forth, result in posting. x-displayName: Change request statuses - name: Construction_Project contracts description: >- Associate a project contract and its corresponding project contract lines with a project to capture a mix of billable details and include those details into your construction project billing.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Project contracts - name: Construction_Project contract lines description: >- A project contract line can be added to a project contract. Multiple lines on a contract allow for different types of billing (lump sum, progress, cost plus, T&M) for each line.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Project contract lines - name: Construction_Project contract line entries description: >- Use project contract line entries to add pricing to the project contract line at the appropriate workflow type. x-displayName: Project contract line entries - name: Construction_Project contract types description: >- Use project contract types to group or categorize project contract information for reporting purposes.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Project contract types - name: Construction_project-contract-type x-displayName: project-contract-type - name: Construction_Project estimates description: >- A project estimate enables you to approximate how much a project might cost to complete. You can compare the actual costs against your estimate to determine if the project is progressing as expected.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Project estimates - name: Construction_Project estimate lines description: >- Project estimate line is an amount that can be tied to cost types (categories in the work breakdown structure), tasks, items, or other aspects of your project. Project estimate lines can only be added and updated through the owning `project-estimate` object.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Project estimate lines - name: Construction_Project estimate types description: >- Project estimate types categorize project estimates for reporting purposes and for filtering which project estimate entries post to the GL.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Project estimate types - name: Construction_Standard cost types description: >- Define standard cost types to create a catalog of definitions that can be used to create new cost types pre-populated with specific values, such as for labor, materials, and subcontracts. Note: Construction companies record expenses using the work breakdown structure (WBS). In the industry, the WBS is traditionally defined as job/cost code/category. Sage Intacct uses project/task/cost type to reflect this structure. x-displayName: Standard cost types - name: Construction_Cost types description: >- Cost type is a standard dimension used to capture and categorize project cost details in construction projects. Each project typically has different cost types related to labor, materials, subcontracts, and so forth. You use the [standard cost types](/openapi/cre/construction-standard-cost-type/tag/Standard-cost-types) as templates for creating new cost types. Each cost type is associated with a [task](/openapi/pa/projects-task/tag/Tasks), which in turn is associated with a [project](/openapi/pa/projects-project/tag/Projects). A cost type record is uniquely identified by the standard cost type used to create it as well as the combination of project/task to which it applies. Note: Cost type corresponds with category in the work breakdown structure in the construction industry.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Cost types - name: Construction_Standard tasks description: >- Use standard tasks to create a catalog (library) of definitions that customers can use to populate new project tasks with specific values, improving consistency across their organization.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Standard tasks - name: Construction_Accumulation types description: >- Accumulation types let construction companies report on transaction costs across cost types. An accumulation type is typically specified at the level of the standard cost type, but it can also be provided when creating an individual cost type.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Accumulation types - name: Construction_Employee positions description: >- You can define a set of employee positions and use those positions in timesheets and rate tables to bill employee labor out at different rates, depending on the work that an employee does at various times during the day. For example, you may want to bill a customer at one rate for the time that an employee spends unloading a truck, but then bill at a different rate when the same employee does work as an electrical apprentice. You can define a set of employee positions to use on [timesheets](/openapi/time/time-timesheet/tag/Timesheets) and in [rate table timesheet entries](/openapi/cre/construction-rate-table-timesheet-line/tag/Rate-table-timesheet-lines) to accomplish this. **NOTE**: The `employee-position` object is used for billing labor, and is different from the [position-skill](/openapi/pa/projects-position-skill/tag/Position-skills) object, which is used to track, categorize, and search for resources according to skills and expertise.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Employee positions - name: Construction_Labor classes description: >- You can define labor class objects that can be applied to timesheets and used to determine billing rates and markups for employees.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Labor classes - name: Construction_Labor shifts description: >- You can define labor shift objects that can be applied to timesheets and used to determine billing rates and markups for employees.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Labor shifts - name: Construction_Labor unions description: >- You can define labor union objects that can be applied to timesheets and used to determine billing rates and markups for employees.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Labor unions - name: Construction_Rate tables description: >- A project contract rate table provides markup and pricing information to be used for generating Project Generated Invoices. Every rate table can have lines for each transaction type that identify the criteria to use when applying markup and pricing for that transaction type. The transaction types include timesheets, purchase orders, accounts payable, general ledger, credit cards, and employee expenses.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Rate tables - name: Construction_Rate table accounts payable lines description: >- Rate table accounts payable lines contain criteria for applying a default markup % to matching accounts payable transactions during invoicing. * Each line requires only 1 value be provided. * Lines with the exact same values (excluding description and markup %) are considered duplicates and are not allowed. * If no value is given for a property then the line will match on any transaction, otherwise it will only match on transactions with that property. * Lines with the most matches will be used as the invoice default markup %. * If multiple lines have the same number of matches then the one with the most recent start date will be used. * If multiple lines have the same number of matches and the same start date (or none at all) then the line with the lowest line number will be used.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Rate table accounts payable lines - name: Construction_Rate table credit card lines description: >- Rate table credit card lines contain criteria for applying a default markup % to matching credit card transactions during invoicing. * Each line requires only 1 value be provided. * Lines with the exact same values (excluding description and markup %) are considered duplicates and are not allowed. * If no value is given for a property then the line will match on any transaction, otherwise it will only match on transactions with that property. * Lines with the most matches will be used as the invoice default markup %. * If multiple lines have the same number of matches then the one with the most recent start date will be used. * If multiple lines have the same number of matches and the same start date (or none at all) then the line with the lowest line number will be used.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Rate table credit card lines - name: Construction_Rate table employee expense lines description: >- Rate table accounts payable lines contain criteria for applying a default markup % to matching employee expense transactions during invoicing. * Each line requires only 1 value be provided. * Lines with the exact same values (excluding description and markup %) are considered duplicates and are not allowed. * If no value is given for a property then the line will match on any transaction, otherwise it will only match on transactions with that property. * Lines with the most matches will be used as the invoice default markup %. * If multiple lines have the same number of matches then the one with the most recent start date will be used. * If multiple lines have the same number of matches and the same start date (or none at all) then the line with the lowest line number will be used.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Rate table employee expense lines - name: Construction_Rate table journal lines description: >- Rate table accounts payable lines contain criteria for applying a default markup % to matching general ledger transactions during invoicing. * Each line requires only 1 value be provided. * Lines with the exact same values (excluding description and markup %) are considered duplicates and are not allowed. * If no value is given for a property then the line will match on any transaction, otherwise it will only match on transactions with that property. * Lines with the most matches will be used as the invoice default markup %. * If multiple lines have the same number of matches then the one with the most recent start date will be used. * If multiple lines have the same number of matches and the same start date (or none at all) then the line with the lowest line number will be used.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Rate table journal lines - name: Construction_Rate table purchasing lines description: >- Rate table accounts payable lines contain criteria for applying a default markup % or unit price to matching purchasing transactions during invoicing. * Each line requires only 1 value be provided. * Lines with the exact same values (excluding description and markup %) are considered duplicates and are not allowed. * If no value is given for a property then the line will match on any transaction, otherwise it will only match on transactions with that property. * Lines with the most matches will be used as the invoice default markup %. * If multiple lines have the same number of matches then the one with the most recent start date will be used. * If multiple lines have the same number of matches and the same start date (or none at all) then the line with the lowest line number will be used.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Rate table purchasing lines - name: Construction_Rate table timesheet lines description: >- Rate table accounts payable lines contain criteria for applying a default markup % or labor rate to matching timesheet transactions during invoicing. * Each line requires only 1 value be provided. * Lines with the exact same values (excluding description and markup %) are considered duplicates and are not allowed. * If no value is given for a property then the line will match on any transaction, otherwise it will only match on transactions with that property. * Lines with the most matches will be used as the invoice default markup %. * If multiple lines have the same number of matches then the one with the most recent start date will be used. * If multiple lines have the same number of matches and the same start date (or none at all) then the line with the lowest line number will be used.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Rate table timesheet lines - name: Contracts_and_Revenue_Management_Contracts description: >- The contract is the container for the products or services that are provided to a specified customer. It can control settings such as renewals and terms, capture compliance information, and record the transaction history for all contract lines and expenses.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Contracts - name: Contracts_and_Revenue_Management_Contract lines description: >- A contract line is a header containing multiple schedule lines and is tied directly to a contract.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Contract lines - name: Contracts_and_Revenue_Management_Contract types description: > Contract types let you group contracts in meaningful ways to provide additional insight into your business. After creating a contract type, you can apply it to a contract by setting the `contractType` when creating or updating the contract. x-displayName: Contract types - name: Contracts_and_Revenue_Management_Contract usage description: >- A contract usage identifies usage of a quantity-based item and is tied directly to a contract line.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Contract usage - name: Contracts_and_Revenue_Management_Billing price lists description: > Use billing price lists to create pricing strategies for items with prices that are determined based on a fixed fee, the quantity used, or the contracted quantity. Billing price lists support several pricing models, including prices per thousands, discount tiers, minimum flat fees, and more. A company can have multiple billing price lists. The `billing-price-list` object is a header for `billing-price-list-entry` objects. You create the list and then reference the list when creating the billing price list entries that you want to associate with the list. x-displayName: Billing price lists - name: Contracts_and_Revenue_Management_Billing price list entries description: >- A billing price list entry contains the pricing for a specified item within a specified billing price list. A contract specifies a billing price list, and items from contract lines are priced according to the associated price list.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Billing price list entries - name: Contracts_and_Revenue_Management_Billing price list entry lines description: >- Billing price list entry lines define pricing details for an item specified in a billing price list entry. Details include the starting date for a price, the flat amount, and usage rates. x-displayName: Billing price list entry lines - name: Contracts_and_Revenue_Management_Billing price list entry line tiers description: >- A billing price list entry line tier defines the starting quantity and price for a single tier in a billing price list entry line.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Billing price list entry line tiers - name: Contracts_and_Revenue_Management_Billing schedules description: >- A contract billing schedule is a header containing multiple schedule lines and is tied directly to a contract line.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Billing schedules - name: Contracts_and_Revenue_Management_Billing schedule lines description: >- A contract billing schedule line represents a single billing for a contract line.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Billing schedule lines - name: Contracts_and_Revenue_Management_Billing templates description: >- A billing template defines the rules to use to invoice the flat or fixed amount of a contract line item.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Billing templates - name: Contracts_and_Revenue_Management_Billing template lines description: >- Use billing template lines to specify the percentages complete at which you want to invoice.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Billing template lines - name: Contracts_and_Revenue_Management_Contract expenses description: >- A contract expense is the cost incurred to obtain or fulfill a contract with a customer. * For termed contracts, you can add expenses to the contract and/or to a contract line. * For evergreen contracts, you can only add expenses to the contract. * For kit contract lines, you can add expenses to the contract or to the kit component contract lines. You cannot add an expense to the kit item contract line.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Contract expenses - name: Contracts_and_Revenue_Management_Contract expense templates description: >- An expense template defines the schedule to recognize an expense amount for a contract or contract line over the contract term. You can create any number of expense templates and reuse them across contracts-
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Contract expense templates - name: Contracts_and_Revenue_Management_Contract expense template lines description: >- Contract expense template line.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Contract expense template lines - name: Contracts_and_Revenue_Management_Contract expense schedules description: >- A contract expense schedule is a header containing multiple schedule lines and is tied directly to a contract line.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Contract expense schedules - name: Contracts_and_Revenue_Management_Contract expense schedule lines description: >- A contract expense schedule line represents a single expense for a contract line.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Contract expense schedule lines - name: Contracts_and_Revenue_Management_MEA price lists description: >- MEA price lists contain standalone selling prices for items sold in multiple-element arrangements. A company that provides multiple products and/or services to customers as part of a single arrangement needs to create one or more MEA price lists. A contract that contains multiple-element arrangements can be linked to an MEA price list. x-displayName: MEA price lists - name: Contracts_and_Revenue_Management_MEA price list entries description: >- An MEA price list entry defines the standalone selling price for an item in a multi-element arrangement.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: MEA price list entries - name: Contracts_and_Revenue_Management_MEA price list entry lines description: >- MEA price list entry line defines the standalone selling price for an item in a multi-element arrangement.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: MEA price list entry lines - name: Contracts_and_Revenue_Management_MEA categories description: >- MEA fair value category
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: MEA categories - name: Contracts_and_Revenue_Management_Revenue templates description: >- A contract revenue template defines the revenue recognition schedule for the flat/fixed amount associated with a contract line.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Revenue templates - name: Contracts_and_Revenue_Management_Revenue schedules description: >- A contract revenue schedule is a header containing multiple schedule lines and is tied directly to a contract line.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Revenue schedules - name: Contracts_and_Revenue_Management_Revenue schedule lines description: >- A contract revenue schedule line represents a single revenue for a contract line.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Revenue schedule lines - name: Core_Intacct_REST_API_Services_Composite requests description: >- Composite request service for submitting multiple "subrequests" in a single POST request. x-displayName: Composite requests - name: Core_Intacct_REST_API_Services_Models description: >- Use the model service to find all of an object's queryable fields, their data types, valid values (for enums) and relationships to other objects. You can use any of those within the select and/or filter elements of a query. The model service works with both standard and custom objects. x-displayName: Models - name: Core_Intacct_REST_API_Services_Query description: >- The query service lets you query the data in a Sage Intacct company to return a list of objects that match given conditions. You can specify complex filter expressions and define the list of fields that you want included for each object in the results. x-displayName: Query - name: General_Ledger_Accounts description: >- General Ledger accounts are where a company posts balance sheet, income statement, and statistical transactions. Accounts make it easier to keep track of the transaction type, such as Accounts Payable, Accounts Receivable, Inventory, and their various subaccounts. The list of all of a company's General Ledger accounts is called its Chart of Accounts. x-displayName: Accounts - name: General_Ledger_Statistical accounts description: >- Statistical accounts are used to track non-financial data, such as employee headcount, number of members, or even the number of rooms in a hotel. x-displayName: Statistical accounts - name: General_Ledger_Account groups description: >- Account groups are the fundamental building blocks of financial reporting. Every account must be part of an account group if its data is to be used in a balance sheet, income statement, cash flow, or other report. The most basic types of account groups contain either individual accounts or other account groups.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Account groups - name: General_Ledger_Account group purposes description: >- Account group purposes let you filter account groups according to why you might use them, which is particularly useful in financial reporting. You create account group purposes and then assign them to account groups when you create or update the groups. x-displayName: Account group purposes - name: General_Ledger_Journals description: >- Journals serve to categorize transactions that are directly entered in the General Ledger and the transactions that are posted from subledgers such as Accounts Payable. For more information see [What journals do you need?](https://www.intacct.com/ia/docs/en_US/help_action/General_Ledger/Setup/Journals/add-edit-journals.htm#Whatjournalsdoyouneed)
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Journals - name: General_Ledger_Statistical journals description: >- Statistical journals hold all non-monetary journal entries and do not have a debit or credit as a transaction. Instead, statistical journals simply increase or decrease a value.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Statistical journals - name: General_Ledger_Journal entries description: >- Use journal entries to add, edit, or reverse transactions to a journal. When writing journal entries, be sure to balance the general ledger by posting offsetting entries. Note: If GL Outlier Detection is enabled for a company, information about outliers is included in journal entries and allocation splits when you get a journal entry object. x-displayName: Journal entries - name: General_Ledger_Journal entry lines description: >- Journal entry lines represent transactions. They can be posted right away, submitted for approval if Approvals are enabled, or saved as a draft. You create and update journal entry lines by creating or updating the [journal-entry objects](/openapi/gl/general-ledger-journal-entry/tag/Journal-entries) that contain those lines. x-displayName: Journal entry lines - name: General_Ledger_Budgets description: >- A budget is a plan to help estimate revenue and expenses for operations. The `budget` object is essentially a header that contains an array of `budget-detail` objects.\n\nBefore you can create or import a budget, [several items in Sage Intacct must be set up](https://www.intacct.com/ia/docs/en_US/help_action/General_Ledger/Budgets_and_spending/Budgets/before-creating-your-budgets.htm): * Budgetable reporting periods: Reporting periods must exist and must be marked as Budgetable. Most often, budgetable periods are monthly. * Accounts: Each account for which you want to create a budget must exist in the Chart of Accounts. * Dimensions: Although using dimensions in budgets isn't required, dimensions such as Location, Department, or Employee can be included in a budget if they've been created in Intacct.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Budgets - name: General_Ledger_Budget details description: >- A budget detail is a unique combination of account, department, location, and reporting period. (Department and location are optional.) If you want to track travel expenses for 3 locations, you would need 3 budget detail objects _per reporting period_: 1. Travel Expenses account, Location A 2. Travel Expenses account, Location B 3. Travel Expenses account, Location C A `budget-detail` object corresponds to what is seen on the Budget amount details page for a specific reporting period in Sage Intacct. Note: `budget-detail` objects can only be created and updated through the owning `budget` object.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Budget details - name: General_Ledger_Reporting periods description: >- Reporting periods are used when creating reports and budgets, and when opening and closing books. They limit the information in a report to specific time ranges.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Reporting periods - name: General_Ledger_Transaction allocation templates description: >- Transaction allocation templates (definitions) provide a way to save standard allocation combinations that are used routinely. You can define an allocation transaction to distribute amounts across multiple dimensions—such as departments, locations, projects, or classes—automatically. You can allocate a percentage, a set (absolute) value, or a fixed amount with over/under logic. Each of these methods takes the transaction line amount and allocates it across the dimensions specified in the transaction allocation template. Transaction allocations are intended for use on single line items, allowing you to distribute amounts during entry of a transaction, usually a one-time action. Transaction allocations are only available for distribution across eight of the standard dimensions and have other restrictions as well. If you want to automatically pull updated source balances and distribute them across dimensions according to defined basis calculations, you should use the Dynamic Allocations subscription. See Account Allocations for more info.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction allocation templates - name: General_Ledger_Transaction allocation template lines description: >- Transaction allocation template lines define how allocations are distributed. Allocation template lines can only be added, updated, and deleted through the owning txn-allocation-template object. x-displayName: Transaction allocation template lines - name: General_Ledger_Reports description: >- Reports from General Ledger data.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Reports - name: Inventory_Control_Aisles description: >- An aisle is one of four optional attributes (zone, aisle, row, and bin face) you can assign to a bin to make it easier to find in the warehouse. x-displayName: Aisles - name: Inventory_Control_Bin faces description: >- A bin face is one of four optional attributes (zone, aisle, row, and bin face) you can assign to a bin to make it easier to find within the warehouse. x-displayName: Bin faces - name: Inventory_Control_Bin sizes description: >- A bin size in an attribute you can assign to a bin to help determine whether the bin is suitable for storing certain items. x-displayName: Bin sizes - name: Inventory_Control_Bins description: >- A bin identifies a specific location within a warehouse where items are or can be stored. Bins make it easier to find items during transaction processing. x-displayName: Bins - name: Inventory_Control_Items description: > Items are goods, services, or kits that you purchase from vendors or sell to customers. Items are used in Inventory Control, Order Entry, and Purchasing. The type of an item (`itemType`) affects other item parameters. Possible item types are: * `inventory` - Items that will be available in inventory, sales, and purchasing transactions. * `nonInventory` - Items that will be available in both sales and purchasing transactions or contracts. * `purchaseOnlyNonInventory` - Items that will only be available in purchasing transactions or contract expenses. * `salesOnlyNonInventory` - Items that will only be available in sales transactions or contracts. * `kit` - The parent item of a (non-stockable) kit (which is assembled from other items at the time of the order). This type is only available if Kits is enabled in either Order Entry or Inventory Control. * `stockableKit` - The parent item of a stockable kit (which is assembled from other items and stored before order). This type is only available if Stockable kits is enabled in Inventory Control. x-displayName: Items - name: Inventory_Control_Item GL groups description: >- Item GL groups are used to organize transaction definitions for posting to the general ledger. x-displayName: Item GL groups - name: Inventory_Control_Item warehouse inventory information description: >- Warehouse inventory information is used with Inventory and Stockable Kit items. Sage Intacct uses the information from these records in the Inventory Reorders report. x-displayName: Item warehouse inventory information - name: Inventory_Control_Rows description: >- A row is one of four optional attributes (zone, aisle, row, and bin face) you can assign to a bin to make it easier to find in the warehouse. x-displayName: Rows - name: Inventory_Control_Unit of measure groups description: > Unit of measure group are provided for items handled under Inventory Control, Order Entry, and Purchasing. Intacct places related units of measure into groups. For example, the Count group includes related units of each, pair, and dozen. The unit of measure (UOM) groups that are provided with Sage Intacct cannot be deleted. Use the Sage Intacct UOM groups as is and create custom UOM groups. For more information, see [About unit of measure groups](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/UOM_groups/about-UOM-groups-OE.htm). x-displayName: Unit of measure groups - name: Inventory_Control_Units of measure description: > Details for a unit of measure included in a unit of measure group. Sage Intacct places related units of measure into groups. For example, the Count group includes related units of measure such as each, pair, and dozen. For more information, see [About unit of measure groups](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/UOM_groups/about-UOM-groups-OE.htm). x-displayName: Units of measure - name: Inventory_Control_Warehouses description: > A warehouse can be an actual warehouse, a store, or any type of stocking location or site that requires inventory tracking and management. Warehouse also serves as a dimension that can be set on transactions to expand report functionality and insight. See [Define warehouses](https://www.intacct.com/ia/docs/en_US/help_action/Inventory_Control/Setting_up_Inventory_Control/Warehouses/warehouses.htm) for more information. x-displayName: Warehouses - name: Inventory_Control_Zones description: >- A zone is one of four optional attributes (zone, aisle, row, and bin face) you can assign to a bin to make it easier to find in the warehouse. x-displayName: Zones - name: Inventory_Control_Product lines description: >- Product lines are groups of related products. Using product lines makes it easier to update prices and track inventory movement. See [Product lines](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/product-lines-OE.htm) for more information. x-displayName: Product lines - name: Inventory_Control_Item cross references description: > An item cross reference associates an inventory item with a specific customer or vendor, or with another inventory item. When an inventory item is associated with a customer or vendor (known as an external cross-reference), the customer or vendor can provide their own identifiers for inventory items that can be used in transactions. When an inventory item is associated with another inventory item (known as an internal cross-reference), you can provide an alternate item to substitute, upgrade, downgrade, or complement that item in Order Entry transactions in Sage Intacct. For more information, see [Item cross references](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Items/item-cross-references-OE.htm) in the Sage Intacct Help Center. x-displayName: Item cross references - name: Inventory_Control_Item landed costs description: > A landed cost item is a non-inventory item that represents a landed cost expense, such as freight, insurance, customs duties, or handling fees. This object is valid when Inventory Control is configured to enable landed costs. For more information, see [Landed costs overview](https://www.intacct.com/ia/docs/en_US/help_action/Purchasing/Using_Purchasing/Landed_costs/landed-costs-overview.htm) in the Sage Intacct Help Center. x-displayName: Item landed costs - name: Inventory_Control_Item vendors description: >- This object provides details about an item that can be purchased from a particular vendor. x-displayName: Item vendors - name: Inventory_Control_Item warehouse standard costs description: >- Standard cost for Item for warehouse. You can record differnet standard costs for different date ranges for item and warehouse combinations.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Item warehouse standard costs - name: Inventory_Control_Item warehouse vendors description: >- Use this object to specify the vendor information you want to use in the replenishment calculations for the item in this warehouse.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Item warehouse vendors - name: Inventory_Control_Kit components description: >- Components are the items of a kit, common combination of items to be ordered and invoiced as a single item, simplifying data entry. You can select inventory items, non-inventory items, and/or other kits.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Kit components - name: Inventory_Control_Lot categories description: >- Lot categories let you group a specific set of items that have something in common.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Lot categories - name: Inventory_Control_Inventory price lists description: >- An inventory price list is a container for price list entries.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Inventory price lists - name: Inventory_Control_Inventory price schedules description: >- Inventory price schedules are pricing groups that can be assigned to one or more customers. For example, to give discounts to a customer, assign the customer to a price schedule associated with a special price list that contains discounts on certain items.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Inventory price schedules - name: Inventory_Control_Inventory totals description: > Use inventory totals to keep track of the items on hand that are available for sale. Sage Intacct is preconfigured with nine inventory totals for tracking inventory that's damaged, in transit, on hand, on hold, on order, requisitioned, or is scrap and spoilage. You can also create your own inventory totals as needed. An inventory total can be assigned to a transaction definition so that the specified total is affected when a transaction with that definition template is saved. For more information and a detailed example, see [Inventory totals](https://www.intacct.com/ia/docs/en_US/help_action/Inventory_Control/Setting_up_Inventory_Control/Inventory_totals/inventory-totals.htm) in the Sage Intacct Help Center. x-displayName: Inventory totals - name: Inventory_Control_Inventory transaction definitions description: >- An inventory transaction definition includes the accounting rules, workflow settings, security settings, and other characteristics for a transaction.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Inventory transaction definitions - name: Inventory_Control_Inventory transaction definition sources description: >- Inventory transaction definition source document for an inventory transaction. This object holds all the source inventory transaction definitions that it can be converted from.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Inventory transaction definition sources - name: Inventory_Control_Inventory transaction definition COGS GL details description: >- This object holds the inventory account mapping for inventory transaction definitions that are configured to post cost of goods (COGS) adjustments to the General Ledger. For example, if a transaction definition is for a cost of goods (COG) adjustment that accounts for spoilage, you might debit the spoilage account and credit the Inventory account.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Inventory transaction definition COGS GL details - name: Inventory_Control_Inventory transaction definition entity details description: >- This object contains details about which entities can create transactions and also includes settings for each entity, such as numbering sequences and document templates. These details and settings are applicable to transaction definitions that are configured to create transactions at the "Top level or entity" or "Entity only" level.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Inventory transaction definition entity details - name: Inventory_Control_Inventory transaction definition subtotal details description: >- Subtotal detail for Inventory transaction definition will hold the type of subtotal that are supported by each Transaction definition.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Inventory transaction definition subtotal details - name: Inventory_Control_Inventory transaction definition total details description: >- Inventory transaction definition total details will allow users to track the inventory running total (i.e. ONHAND, ONORDER, etc) that will be affected by the inventory transaction definition.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Inventory transaction definition total details - name: Inventory_Control_Warehouse groups description: >- A warehouse group categorizes warehouse dimension records, mainly for the purpose of structuring financial reporting.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Warehouse groups - name: Inventory_Control_Inventory cycles description: >- Create and use inventory cycles to keep track of when to take physical inventory.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Inventory cycles - name: Inventory_Control_Inventory Control documents description: >- An Inventory Control document contains information about Inventory Control transactions
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Inventory Control documents - name: Inventory_Control_Inventory documents x-displayName: Inventory documents - name: Inventory_Control_Inventory Control document lines description: >- Line information for Inventory transactions including opening balances and adjustments.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Inventory Control document lines - name: Inventory_Control_Inventory document subtotals description: >- Details of Subtotals, taxes, discounts, charges etc for the transaction.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Inventory document subtotals - name: Inventory_Control_Item groups description: >- An item group categorizes item dimension records, mainly for the purpose of structuring financial reporting.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Item groups - name: Order_Entry_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: Order_Entry_Documents description: >- An order entry document contains information about sales transactions.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Documents - name: Order_Entry_Document lines description: >- Line items in a document that represent order entry transactions.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Document lines - name: Order_Entry_Document line details description: >- Order Entry document line details
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Document line details - name: Order_Entry_Document subtotals description: >- Details of Subtotals, taxes, discounts, charges etc for the transaction.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Document subtotals - name: Order_Entry_Document histories description: >- An Order Entry document history contains one entry for each existing transaction in the workflow associated with the selected transaction.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Document histories - name: Order_Entry_Transaction definitions description: >- An order entry transaction definition includes the accounting rules, workflow settings, security settings, and other characteristics for a transaction.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definitions - name: Order_Entry_Transaction definition additional GL posting account details description: >- Use this for additional GL entry account mapping. When additional posting is enabled for a transaction definition, additional GL posting account mapping is available for the posting configuration of that definition.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition additional GL posting account details - name: Order_Entry_Transaction definition account details description: >- If an order entry transaction is posting to either Accounts Receivable or the General Ledger, the the applicable account mapping is defined using this object.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition account details - name: Order_Entry_Transaction definition COGS account details description: >- Use this object to set COGS GL account and Inventory account mapping of an order entry transaction definition.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition COGS account details - name: Order_Entry_Transaction definition entity details description: >- Specify which entities can create transactions. Also use this object to define different settings for each desired entity; numbering sequences, document templates, and so on.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition entity details - name: Order_Entry_Transaction definition inventory total details description: >- Use this object to specify the inventory running total that will be affected by the transaction, whether to track the quantity, value, or both, and whether that amount will increase or decrease when the user saves the transaction.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition inventory total details - name: Order_Entry_Transaction definition document conversion details description: >- Specify the transaction definitions from which this transaction can be converted.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition document conversion details - name: Order_Entry_Transaction definition subtotal details description: >- Specify the subtotal detail for an Order Entry transaction.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Transaction definition subtotal details - name: Order_Entry_Billing schedules description: >- This object provides order entry billing schedule information, including billing template details.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Billing schedules - name: Order_Entry_Price schedules description: >- Price schedules are pricing groups that you can assign to one or more customers.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Price schedules - name: Order_Entry_Renewal templates description: >- A renewal template defines a set of actions Sage Intacct will perform when a contract reaches its end date.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Renewal templates - name: Order_Entry_Subtotal templates description: >- In a multi-entity organization, subtotal templates enable you to create different sets of subtotals and then refer to them by name within a transaction definition. They simplify setting up and managing transactions definitions.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Subtotal templates - name: Project_and_Resource_Management_Projects description: >- Use projects to manage, track, and report on work performed by or for your company.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Projects - name: Project_and_Resource_Management_Project resources description: >- Project resource description -- explain what it's for and how it's used.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Project resources - name: Project_and_Resource_Management_Project statuses description: >- Project statuses let you track the progress of projects through different states. You can also disable (prevent) certain types of transactions from occurring in specific states, such as not allowing timesheet entries when a project is in a "Not Started" state.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Project statuses - name: Project_and_Resource_Management_Project types description: >- Project types let you group projects into categories for reporting (such as, consulting, internal, or training). After defining project types, you can set each project to one of the types and then group and query based on the type.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Project types - name: Project_and_Resource_Management_Tasks description: >- A unit of work to be performed for a project. Use tasks to: - Track project work by task and assigned resources. - Identify which tasks are billable to the customer. - Enter estimated and planned hours, track percent completed as the task progresses, and create recurring schedules. - Create task dependencies so one task doesn't start until another finishes. - Set other optional information, such as the priority or status of the task.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Tasks - name: Project_and_Resource_Management_Task resources description: >- An employee who works on a project task is considered a task resource.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Task resources - name: Project_and_Resource_Management_Employee rates description: >- Employee rate provides information about compensation by date. The rate can be either hourly or annual.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Employee rates - name: Project_and_Resource_Management_Position skills description: >- Position skill description -- explain what it's for and how it's used.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Position skills - name: Project_and_Resource_Management_Project billing templates description: >- Optimize project billing with our easy-to-use project billing template.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Project billing templates - name: Purchasing_Price lists description: > A purchasing price list is a container for price list entries. First create the price list and then the price list entries associated with the list. Price lists contain the prices for products or services purchased from vendors. Typically there is one price list per vendor, but multiple lists can be created as needed. See [Price lists — Purchasing](https://www.intacct.com/ia/docs/en_US/help_action/Purchasing/Setting_up_Purchasing/Price_lists/price-lists-PO.htm) for more information. x-displayName: Price lists - name: Purchasing_Price schedules description: >- Purchasing price schedules are pricing groups that you can assign to one or more vendors. Discount items by assigning a vendor to a price schedule associated with a price list that contains different discounts for various items. Or define a price schedule with a 10% discount off all items and assign that price schedule to the vendor. See [Price schedules — Purchasing](https://www.intacct.com/ia/docs/en_US/help_action/Purchasing/Setting_up_Purchasing/Price_lists/price-schedules-po-ns.htm?tocpath=Applications%7CPurchasing%7CSetup%7CPrice%20lists%7C_____4) for more information.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Price schedules - name: Purchasing_Purchasing transaction definitions description: >- This API object represents a Purchasing Transaction Definition. It is designed to manage various types of purchasing transactions within a system, including purchase requisitions, purchase orders, receipts, vendor invoices, and adjustments. The API object provides endpoints for creating, retrieving, updating, and deleting purchasing transaction definitions. It also provides a list of all purchasing transaction definitions in the system.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Purchasing transaction definitions - name: Purchasing_Subtotal templates description: >- Template for purchasing subtotals.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Subtotal templates - name: Purchasing_Documents description: >- A purchasing document contains information about purchasing transactions.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Documents - name: Purchasing_Document lines description: >- Line items in a purchasing document represent purchasing transactions.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Document lines - name: Purchasing_Document subtotals description: >- Subtotal for purchasing documents.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Document subtotals - name: Tax_Order Entry tax details description: >- Order Entry tax details describe a specific type of tax that applies to lines in Accounts Receivable and Order Entry transactions. When Sage Intacct calculates taxes, the tax schedule map applies the tax details to the taxable lines. See [Tax details—Taxes application](https://www.intacct.com/ia/docs/en_US/help_action/Taxes/Indirect_Tax/VAT_and_GST/Setup/Tax_objects/tax-details.htm) for more information.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Order Entry tax details - name: Tax_Order Entry tax schedules description: > A tax schedule identifies the tax details that are applied when the schedule is referenced by a tax schedule map. For example, a tax schedule named "Purchase Goods Standard Rate" could include one tax detail named "Purchase Goods Standard Rate". When this schedule is referenced, the tax detail is applied. See [Tax schedules—Taxes application](https://www.intacct.com/ia/docs/en_US/help_action/Taxes/Indirect_Tax/VAT_and_GST/Setup/Tax_objects/tax-schedules.htm) for more information. x-displayName: Order Entry tax schedules - name: Tax_Purchasing tax details description: >- Purchasing tax details describe a specific type of tax that apply to lines in Accounts Payable and Purchasing transactions. When Sage Intacct calculates taxes, the tax schedule map applies the tax details to the taxable lines. See [Tax details—Taxes application](https://www.intacct.com/ia/docs/en_US/help_action/Taxes/Indirect_Tax/VAT_and_GST/Setup/Tax_objects/tax-details.htm) for more information.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Purchasing tax details - name: Tax_Purchasing tax schedules description: >- A tax schedule identifies the tax details that are applied when the schedule is referenced by a tax schedule map. For example, a tax schedule named "Purchase Goods Standard Rate" could include one tax detail named "Purchase Goods Standard Rate". When this schedule is referenced, the tax detail is applied. See [Tax schedules—Taxes application](https://www.intacct.com/ia/docs/en_US/help_action/Taxes/Indirect_Tax/VAT_and_GST/Setup/Tax_objects/tax-schedules.htm) for more information.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Purchasing tax schedules - name: Tax_Tax authorities description: >- Tax authorities are agencies for whom you collect sales tax or other taxes. For example, in the United States, you might report and pay any tax you owe to city, county, and state agencies. Tax authorities are shared across Accounts Payable, Accounts Receivable, Order Entry, and Purchasing. See [Tax authorities—Taxes application](https://www.intacct.com/ia/docs/en_US/help_action/Taxes/Indirect_Tax/VAT_and_GST/Setup/Tax_objects/tax-authorities.htm) for more information.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Tax authorities - name: Tax_Contact tax groups description: >- Contact tax groups enable taxes to be applied to customers, vendors, and their contacts, according to their jurisdictions. Associate customers, vendors, and their contacts with contact tax groups. Then, use tax schedule maps to apply different tax schedules to contact tax groups. Only applicable with Advanced Tax.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Contact tax groups - name: Tax_Item tax groups description: >- Item tax groups enable you to apply different taxes to items. Associate items with item tax groups and then use tax schedule maps to apply different tax schedules to item tax groups.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Item tax groups - name: Tax_Order Entry tax schedule maps description: >- An Order Entry tax schedule map associates a tax schedule with customers (through a contact tax group) and items (through an item tax group). These maps drive the taxes that are applied to a line item. The tax schedule contains the tax detail records, which define the amount of tax to apply.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Order Entry tax schedule maps - name: Tax_Purchasing tax schedule maps description: >- A Purchasing tax schedule map associates a tax schedule with vendors (through a contact tax group) and items (through an item tax group). These maps drive the taxes that are applied to a line item. The tax schedule contains the tax detail records, which define the amount of tax to apply.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Purchasing tax schedule maps - name: Tax_Tax returns description: >- You can submit a tax return through Sage Regulatory Reporting for Australia, Canada, South Africa, and the United Kingdom. Multi-entity companies typically submit taxes from the top level. You can submit taxes for an individual entity only if the entity has a unique tax ID. For more information, see [Submit taxes](https://www.intacct.com/ia/docs/en_US/help_action/Taxes/Indirect_Tax/VAT_and_GST/Use/Submit_taxes/submit-taxes.htm).
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Tax returns - name: Tax_Tax solutions description: >- A tax solution provides the underlying mechanism (tax engine) for capturing and reporting taxes. A tax solution also includes information about the GL accounts for input and output taxes as well as the start date of the first tax submission period. Pre-configured tax solutions are only available for AU, CAN, FR, GB, and ZA.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Tax solutions - name: Tax_Order Entry tax schedule details description: >- Order Entry tax schedule detail description -- explain what it's for and how it's used.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Order Entry tax schedule details - name: Tax_Purchasing tax schedule details description: >- Purchasing tax schedule detail description -- explain what it's for and how it's used.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Purchasing tax schedule details - name: Time_and_Expenses_Timesheets description: >- Timesheets ensure workers are paid appropriately and help project managers invoice clients and track overall project costs and expenses over time- Timesheets are used in both Projects and Time & Expenses. A subscription to Projects is required to approve timesheets and save timesheets as drafts. Each time a timesheet entry is submitted, a timesheet approval history object is created for tracking purposes.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Timesheets - name: Time_and_Expenses_Timesheet lines description: >- A timesheet line is an entry on a timesheet that represents work done by one employee on a single day. Each timesheet line should reflect the dimensions used by the company. That is, work done for one customer or project should be recorded in a separate timesheet line from work done for another customer or project, etc. Reports and invoices use the dimension values to group timesheet lines for billing.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Timesheet lines - name: Time_and_Expenses_Timesheet approval records description: >- Timesheet approval record.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Timesheet approval records - name: Time_and_Expenses_Time types description: >- Time type description -- explain what it's for and how it's used.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Time types - name: Time_and_Expenses_Earning types description: >- Earning types are a key component in configuring the system to post project labor costs to one or more General Ledger journals. After creating earning types, they must be assigned to employees before the system can begin posting labor costs to a General Ledger journal.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Earning types - name: Time_and_Expenses_Employee expenses description: >- Expense report for an employee. This is a header object for employee-expense-lines.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Employee expenses - name: Time_and_Expenses_Employee expense lines description: >- Details for each expense line on the employee expense report.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Employee expense lines - name: Time_and_Expenses_Employee expense summaries description: >- Expense summaries are collections of the same type of transactions, grouped together for processing. Expense summaries are referenced by [employee expense](/openapi/ee/expenses-employee-expense/tag/Employee-expenses) objects.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Employee expense summaries - name: Time_and_Expenses_Employee expense types description: >- An employee expense type is a user-defined type that associates a certain type of expense with a GL account. It is applied to line items in an employee expense reports or expense adjustments. x-displayName: Employee expense types - name: Time_and_Expenses_Employee expense payment types description: >- User-defined employee expense payment type that is applied to the line items in an employee expense report or an expense adjustment.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Employee expense payment types - name: Time_and_Expenses_Unit rates description: Unit-rate description -- explain what it's for and how it's used. x-displayName: Unit rates - name: Time_and_Expenses_Employees description: >- An employee is a resource that executes work for a company and is associated with a financial transaction such as a timesheet entry or expense transaction. If the employee is also a user in Sage Intacct (which is required if they will be entering Time & Expenses), the employee and user must be associated with the same Sage Intacct contact.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Employees - name: Time_and_Expenses_Employee types description: >- An employee type is a user-defined or default type for an employee, usually related to payroll requirements. Examples include full time, part time, intern, and so forth.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Employee types paths: /objects/cash-management/payment-provider: get: summary: List payment providers description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each payment provider. 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
SubscriptionCash Management, Sage Cloud Services, Outbound Payment Services
User ypeBusiness user with admin permissions
PermissionsList, View Application Subscriptions
tags: - Accounts_Payable_Payment providers operationId: list-cash-management-payment-provider responses: '200': description: OK content: application/json: schema: type: object title: List payment providers properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List payment providers: value: ia::result: - key: '3' id: CSI href: /objects/cash-management/payment-provider/3 ia::meta: totalCount: 1 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/payment-provider/{key}: parameters: - schema: type: string name: key in: path required: true example: '3' description: Payment provider key get: summary: Get a payment provider description: >+ Returns detailed information for a specified payment provider, including name, ID, payment withdrawal type, and payment methods.
Permissions and other requirements
SubscriptionCash Management, Sage Cloud Services, Outbound Payment Services
User ypeBusiness user with admin permissions
PermissionsList, View Application Subscriptions
tags: - Accounts_Payable_Payment providers operationId: get-cash-management-payment-provider-key responses: '200': description: OK content: application/json: schema: type: object title: Payment provider details properties: ia::result: $ref: '#/components/schemas/cash-management-payment-provider' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a payment-provider: value: ia::result: key: '3' id: CSI name: CSI paymentWithdrawalType: perTransaction state: subscribed audit: createdDateTime: '2021-07-28T11:07:33Z' modifiedDateTime: '2021-09-06T05:17:26Z' createdBy: '1' modifiedBy: '1' paymentMethods: - key: '453' id: '453' paymentProvider: id: CSI name: CSI key: '3' href: /objects/cash-management/payment-provider/3 paymentType: VCARD audit: createdDateTime: '2021-07-30T03:29:20Z' modifiedDateTime: '2021-09-06T05:17:26Z' createdBy: '1' modifiedBy: '1' href: /objects/cash-management/provider-payment-method/453 href: /objects/cash-management/payment-provider/3 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/payment-provider-bank-account: get: summary: List payment provider bank accounts description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each payment provider bank account. 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
SubscriptionAdministration, Sage Cloud Services, Outbound Payment Services
User ypeBusiness user with admin permissions
PermissionsList, View, Subscribe, Configure Application Subscriptions
tags: - Accounts_Payable_Payment provider bank accounts operationId: list-cash-management-payment-provider-bank-account responses: '200': description: OK content: application/json: schema: type: object title: List payment provider bank accounts properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List payment provider bank accounts: value: ia::result: - key: '1' id: '1' href: '/objects/cash-management/payment-provider-bank-account/1' - key: '2' id: '2' href: '/objects/cash-management/payment-provider-bank-account/2' - key: '3' id: '3' href: '/objects/cash-management/payment-provider-bank-account/3' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '404': $ref: '#/components/responses/404error' security: - OAuth2: [] parameters: [] post: summary: Create a payment provider bank account description: >+ Creates a new payment provider bank account.
Permissions and other requirements
SubscriptionAdministration, Sage Cloud Services, Outbound Payment Services
User ypeBusiness user with admin permissions
PermissionsList, View, Subscribe, Configure Application Subscriptions
tags: - Accounts_Payable_Payment provider bank accounts operationId: create-cash-management-payment-provider-bank-account requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-payment-provider-bank-account' examples: Create a payment provider bank account: value: paymentProvider: id: CSI bankAccount: id: WF status: active checkStartNumber: '111000' remittanceEmail: jsmith@example.com responses: '201': description: Created content: application/json: schema: type: object title: New payment provider bank account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New Payment Provider bank account: value: ia::result: key: '22' id: '22' href: '/objects/cash-management/payment-provider-bank-account/22' ia::meta: totalCount: 1 '422': $ref: '#/components/responses/422error' security: - OAuth2: [] /objects/cash-management/payment-provider-bank-account/{key}: parameters: - name: key description: System-assigned key for the payment provider bank account. in: path required: true schema: type: string get: summary: Get a payment provider bank account description: >+ Returns detailed information for a specified payment provider bank account.
Permissions and other requirements
SubscriptionAdministration, Sage Cloud Services, Outbound Payment Services
User ypeBusiness user with admin permissions
PermissionsList, View, Subscribe, Configure Application Subscriptions
tags: - Accounts_Payable_Payment provider bank accounts operationId: get-cash-management-payment-provider-bank-account-key responses: '200': description: OK content: application/json: schema: type: object title: Details for the payment provider bank account properties: ia::result: $ref: '#/components/schemas/cash-management-payment-provider-bank-account' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a payment provider bank account: value: ia::result: key: '19' id: '19' paymentProvider: key: '1' id: CSI href: /objects/cash-management/payment-provider/1 bankAccount: key: '72' id: BOA currency: USD href: /objects/cash-management/checking-account/72 state: subscribed isRebateAccount: false providerReferenceNumber: 44397977-72-1643357336 authenticationURL: '' audit: createdDateTime: '2022-01-28T08:08:56Z' modifiedDateTime: '2022-01-28T08:23:08Z' createdBy: '1' modifiedBy: '1' status: active checkStartNumber: '123456' href: '/objects/cash-management/payment-provider-bank-account/19' ia::meta: totalCount: 1 '404': $ref: '#/components/responses/404error' security: - OAuth2: [] patch: summary: Update a payment provider bank account description: >+ Updates an existing payment provider bank account by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAdministration, Sage Cloud Services, Outbound Payment Services
User ypeBusiness user with admin permissions
PermissionsList, View, Subscribe, Configure Application Subscriptions
tags: - Accounts_Payable_Payment provider bank accounts operationId: update-cash-management-payment-provider-bank-account-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-payment-provider-bank-account' - type: object properties: id: readOnly: true examples: Update a payment provider bank account: value: isRebateAccount: false checkStartNumber: '111222' responses: '200': description: OK content: application/json: schema: type: object title: Updated payment-provider-bank-account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated payment provider bank account: value: ia::result: key: '19' id: '19' href: '/objects/cash-management/payment-provider-bank-account/19' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/provider-payment-method: get: summary: List provider payment methods description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each provider payment method. This operation is mostly for use in testing; use query to find objects that meet certain criteria and specify the properties that are returned.
Permissions and other requirements
SubscriptionCash Management, Sage Cloud Services, Outbound Payment Services
User ypeBusiness user with admin permissions
PermissionsList, View Application Subscriptions
operationId: list-cash-management-provider-payment-method tags: - Accounts_Payable_Provider payment methods responses: '200': description: OK content: application/json: schema: type: object title: List provider payment methods properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List provider payment methods: value: ia::result: - key: '453' id: '453' href: /objects/cash-management/provider-payment-method/453 - key: '454' id: '454' href: /objects/cash-management/provider-payment-method/454 - key: '455' id: '455' href: /objects/cash-management/provider-payment-method/455 - key: '456' id: '456' href: /objects/cash-management/provider-payment-method/456 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/provider-payment-method/{key}: parameters: - schema: type: string name: key in: path required: true example: '454' description: Payment method key get: summary: Get a provider payment method description: >+ Returns detailed information for a specified provider payment method.
Permissions and other requirements
SubscriptionCash Management, Sage Cloud Services, Outbound Payment Services
User ypeBusiness user with admin permissions
PermissionsList, View Application Subscriptions
tags: - Accounts_Payable_Provider payment methods operationId: get-cash-management-provider-payment-method-key responses: '200': description: OK content: application/json: schema: type: object title: Provider payment method details properties: ia::result: $ref: '#/components/schemas/cash-management-provider-payment-method' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a provider payment method: value: ia::result: key: '454' id: '454' paymentProvider: id: CSI name: CSI key: '3' href: /objects/cash-management/payment-provider/3 paymentType: CHECK audit: createdDateTime: '2021-07-30T03:29:20Z' modifiedDateTime: '2021-09-06T05:17:26Z' createdBy: '1' modifiedBy: '1' href: /objects/cash-management/provider-payment-method/454 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/term: get: summary: List terms operationId: list-accounts-payable-term description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each term. 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
SubscriptionAccounts Payable
User ypeBusiness
PermissionsList, View terms
tags: - Accounts_Payable_Terms responses: '200': description: OK content: application/json: schema: type: object title: List term objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List terms: value: ia::result: - key: '15' id: Net40 href: /objects/accounts-payable/term/15 - key: '17' id: N40_G href: /objects/accounts-payable/term/17 - key: '9' id: N30 href: /objects/accounts-payable/term/9 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a term description: |+ Creates a new term.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness
PermissionsAdd terms
tags: - Accounts_Payable_Terms operationId: create-accounts-payable-term responses: '201': description: Created content: application/json: schema: type: object title: New term properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a term: value: ia::result: key: '27' id: N500 href: /objects/accounts-payable/term/27 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-term' - $ref: '#/components/schemas/accounts-payable-termRequiredProperties' examples: Create a term: value: id: N500 description: 60 Days term status: active due: days: 2 from: of5thMonthFromBillDate discount: days: 1 from: of3rdMonthFromBillDate amount: 10 unit: amount graceDays: 15 calculateOn: billTotal penalty: cycle: quarterly amount: 101 unit: amount graceDays: 16 security: - OAuth2: [] /objects/accounts-payable/term/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the term. get: summary: Get a term description: |+ Returns detailed information for a specified term.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness
PermissionsList, View terms
tags: - Accounts_Payable_Terms operationId: get-accounts-payable-term-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the term properties: ia::result: $ref: '#/components/schemas/accounts-payable-term' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a term: value: ia::result: id: N500 description: 60 Days term status: active key: '27' audit: modifiedDateTime: '2023-04-19T17:05:02Z' createdDateTime: '2023-04-19T16:53:48Z' modifiedBy: '39' createdBy: '39' due: days: 2 from: of5thMonthFromBillDate discount: days: 1 from: of3rdMonthFromBillDate amount: 10 unit: percentage graceDays: 15 calculateOn: billTotal penalty: cycle: quarterly amount: 10.5 unit: percentage graceDays: 16 href: /objects/accounts-payable/term/27 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a term operationId: update-accounts-payable-term-key description: >+ Updates an existing term by setting field values. Any fields not provided remain unchanged. Updating a term already applied to bills may affect payment scheduling for those bills. Existing bills are not updated with edited term information. To update term information for an existing bill, reverse and resubmit the bill.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness
PermissionsList, View, Edit terms
tags: - Accounts_Payable_Terms responses: '200': description: OK content: application/json: schema: type: object title: Updated term properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a term: value: ia::result: key: '27' id: N500 href: /objects/accounts-payable/term/27 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-term' - type: object properties: id: readOnly: true examples: Update a single value: value: penalty: amount: 10.5 security: - OAuth2: [] delete: summary: Delete a term description: |+ Deletes a term.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness
PermissionsList, View, Delete terms
tags: - Accounts_Payable_Terms operationId: delete-accounts-payable-term-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/vendor: get: summary: List vendors description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each vendor. This operation is mostly for use in testing. Use query to fnd objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Vendors
tags: - Accounts_Payable_Vendors responses: '200': description: OK content: application/json: schema: type: object title: List of vendor objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List vendors: value: ia::result: - key: '84' id: Vend-00001 href: /objects/accounts-payable/vendor/84 - key: '85' id: Vend-00002 href: /objects/accounts-payable/vendor/85 - key: '60' id: Vend-00003 href: /objects/accounts-payable/vendor/60 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' operationId: list-accounts-payable-vendor security: - OAuth2: [] post: summary: Create a vendor description: >+ Creates a new vendor. When you add a new vendor, you can provide key descriptive information about that vendor and establish how you want to pay them.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness user
PermissionsList, View, Add, Edit Vendors (Bank Details permissions required to access vendor bank account.)
tags: - Accounts_Payable_Vendors operationId: create-accounts-payable-vendor requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-vendor' - $ref: '#/components/schemas/accounts-payable-vendorRequiredProperties' examples: Create a vendor: value: id: Vend-00010 name: Design Works taxId: 12-3456789 form1099: is1099Eligible: true nameOn1099: Design Works Inc type: MISC box: '3' creditLimit: 40000 isOnHold: false doNotPay: false billingType: openItem paymentPriority: normal billPayment: defaultDateOptions: none enableACHPayments: false Create an unrestricted vendor: value: id: Vendor_A0000003 name: Global Networks form1099: is1099Eligible: true nameOn1099: ISC 1099 type: MISC box: '3' parent: id: '201' contacts: default: mailingAddress: addressLine1: 300 Park Avenue addressLine2: Suite 1400 addressLine3: Western industrial area city: San Jose country: United States postCode: '95110' state: California tax: isTaxable: true URL1: https://alice.example.com URL2: https://gnw.example.com companyName: Ecology Corporation email1: alice@example.com email2: cooper@example.com fax: '14085555309' firstName: Cooper lastName: Alice middleName: Mary mobile: '14085554420' pager: '14085559987' phone1: '14085551212' printAs: Cooper.Alice hideContactList: false primary: id: 1099 IntCA payTo: id: 1099 Int returnTo: id: 111(V111) recipient1099: id: 123515(V123515) term: id: Net 60 vendorAccountNumber: '123456789' taxId: 111-22-1111 creditLimit: 1000 billingType: openItem vendorType: id: Retailer accountGroup: id: Stationary VGL Group priceSchedule: id: PO Price S discountPercent: 20 priceList: id: PO Price List notes: Comments of IN202 defaultExpenseGLAccount: id: '6700.04' paymentPriority: normal status: active state: a isOneTimeUse: true isOnHold: true doNotPay: true ach: enablePayments: true routingNumber: '123456789' accountNumber: '987654321' accountType: checkingAccount remittanceType: businessCTX displayTermDiscountOnCheckStub: false displayVendorAccountOnCheckStub: false sendPaymentNotification: true preferredPaymentMethod: printedCheck mergePaymentRequests: true overrideOffsetGLAccount: id: '1000.00' attachment: id: Attach-12574 contactList: - name: primary contact: id: 1099 IntCA - name: pay to contact: id: 1099 Int - name: return to contact: id: 111(V111) - name: '1099' contact: id: 123515(V123515) vendorAccountNumberList: - locationId: 1--United States of America accountNo: '111111111' vendorEmailTemplates: - vendor: id: Vendor_A0000003 txnDefinitionName: Purchase Order emailTemplate: id: '5' name: AP billPayment: defaultDateOptions: none Create a restricted vendor: value: id: Vend-00100 name: Regulatory Filing Group parent: id: '202' contacts: default: mailingAddress: addressLine1: 9500 Arboretum Blvd addressLine2: Suite 310 addressLine3: Western industrial area city: Austin country: United States postCode: '78759' state: TX tax: isTaxable: true URL1: https://jack.exammple.com companyName: Jack Henry email1: Henry@example.com email2: Jack@example.com fax: '14085555522' firstName: Jack lastName: Henry middleName: Inc mobile: '14085554420' pager: '14085554400' phone1: '14085551212' printAs: Jack Henry & Associates hideContactList: true term: id: Net 60 vendorAccountNumber: '203' taxId: 192-35-4308 creditLimit: 350000 billingType: balanceForward notes: None defaultExpenseGLAccount: id: '1500' paymentPriority: normal status: active state: a isOneTimeUse: false isOnHold: false doNotPay: false displayTermDiscountOnCheckStub: false displayVendorAccountOnCheckStub: false sendPaymentNotification: false restrictions: restrictionType: restricted locations: - 1--United States of America - 2--India - 3--United Kingdom - 1st Level Locations--Level 1 Locations - 2nd Level Locations--Level 2 Locations departments: - 11--Accounting - 1st Level Depts--Level 1 Departments mergePaymentRequests: true billPayment: defaultDateOptions: none Create a vendor in a PO-match enabled company: value: id: VEND-0001 name: Office Supplies taxId: 12-3456788 creditLimit: 50000 isOnHold: false doNotPay: false alwaysCreateBill: true billingType: openItem paymentPriority: normal billPayment: defaultDateOptions: none responses: '201': description: Created content: application/json: schema: type: object title: New vendor properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a vendor: value: ia::result: key: '111' href: /objects/accounts-payable/vendor/111 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/vendor/{key}: parameters: - schema: type: string example: '111' name: key in: path required: true description: System-assigned key for the vendor. example: '111' get: summary: Get a vendor description: >+ Returns detailed information for a specified vendor.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Vendors
tags: - Accounts_Payable_Vendors operationId: get-accounts-payable-vendor-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the vendor properties: ia::result: $ref: '#/components/schemas/accounts-payable-vendor' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a vendor: value: ia::result: key: '111' id: VEND-00010 name: Design Works status: active state: a taxId: 12-3456789 form1099: nameOn1099: Design Works Inc type: MISC box: '3' creditLimit: 40000 isOnHold: true doNotPay: true alwaysCreateBill: false currency: USD contacts: primary: id: Doe, John key: '271' href: /objects/company-config/contact/271 payTo: id: Ho, Amy key: '298' href: /objects/company-config/contact/298 returnTo: id: Doe, John key: '271' href: /objects/company-config/contact/271 recipient1099: id: Ho, Amy key: '298' href: /objects/company-config/contact/298 mergePaymentRequests: true sendPaymentNotification: true billingType: openItem paymentPriority: normal displayTermDiscountOnCheckStub: true billPayment: defaultDateOptions: none displayVendorAccountOnCheckStub: true ach: enablePayments: false routingNumber: null accountNumber: null accountType: null remittanceType: null audit: modifiedDateTime: '2021-03-24T21:16:54Z' createdDateTime: '2021-03-24T21:16:54Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-payable/vendor/111 ia::meta: totalCount: 1 Get an unrestricted vendor: value: ia::result: key: '69' id: Vendor_A0000001 name: Vendor_A0000001 form1099: nameOn1099: ISC 1099 type: MISC box: '3' parent: key: '47' id: '201' name: PG & E href: /objects/accounts-payable/vendor/47 contacts: default: mailingAddress: addressLine1: 300 Park Avenue addressLine2: Suite 1400 addressLine3: Western industrial area city: San Jose country: United States postCode: '95110' state: California tax: isTaxable: true URL1: https://alice.example.com URL2: https://anothercompany.com companyName: Ecology Corp email1: alice@example.com email2: cooper@example.com fax: '14085555309' firstName: Alice id: Vendor_A0000001 lastName: Cooper middleName: Mary mobile: '14085554420' pager: '14085559987' phone1: '14085551212' phone2: '14085559876' prefix: Ms. printAs: Alice.Cooper key: '237' hideContactList: false href: /objects/company-config/contact/237 primary: id: 1099 IntCA key: '206' href: /objects/company-config/contact/206 payTo: id: 1099 Int key: '211' href: /objects/company-config/contact/211 returnTo: id: 111(V111) key: '748' href: /objects/company-config/contact/748 recipient1099: id: 123515(V123515) key: '341' href: /objects/company-config/contact/341 term: id: Net 60 key: '11' href: /objects/accounts-payable/term/11 vendorAccountNumber: '123456789' taxId: 111-22-1111 creditLimit: 1000 totalDue: '0' billingType: openItem vendorType: id: Retailer key: '14' href: /objects/accounts-payable/vendor-type/14 accountGroup: id: Stationary VGL Group key: '14' href: /objects/accounts-payable/vendor-account-group/14 priceSchedule: id: PO Price S discountPercent: 20 priceList: id: PO Price List key: '2' href: /objects/purchasing/price-list/2 notes: Comments of IN202 accountlabel: id: Equipment key: '10' defaultExpenseGLAccount: id: '6700.04' name: CC Other Charges & Fees key: '326' href: /objects/general-ledger/account/326 paymentPriority: normal status: active state: a isOneTimeUse: true isOnHold: true audit: modifiedDateTime: '2022-05-26T04:49:44Z' createdDateTime: '2018-07-28T19:35:16Z' createdBy: '1' modifiedBy: '1' doNotPay: true alwaysCreateBill: false currency: USD ach: enablePayments: true routingNumber: '123456789' accountNumber: '987654321' accountType: checkingAccount remittanceType: businessCTX displayTermDiscountOnCheckStub: false displayVendorAccountOnCheckStub: false sendPaymentNotification: true preferredPaymentMethod: printedCheck restrictions: restrictionType: unrestricted mergePaymentRequests: true overrideOffsetGLAccount: id: '1000.00' key: '1000.00' name: '10000' href: /objects/general-ledger/account/1000.00--10000 attachment: id: Attach-12574 key: Attach-12574 href: /objects/company-config/attachment/Attach-12574 defaultLeadTime: 5 retainagePercentage: 10 lastBillCreatedDate: null lastPaymentMadeDate: null tpar: isTparEnabled: true name: 4IMPRINT INC t5018: isT5018Enabled: true t5018Number: 123OOR652 contactList: - id: '215' key: '215' name: primary contact: id: 1099 IntCA audit: modifiedDateTime: '2022-05-26T04:49:44Z' createdDateTime: '2022-05-26T04:49:44Z' createdBy: '1' modifiedBy: '1' - id: '216' key: '216' name: pay to contact: id: 1099 Int audit: modifiedDateTime: '2022-05-26T04:49:44Z' createdDateTime: '2022-05-26T04:49:44Z' createdBy: '1' modifiedBy: '1' - id: '217' key: '217' name: return to contact: id: 111(V111) audit: modifiedDateTime: '2022-05-26T04:49:44Z' createdDateTime: '2022-05-26T04:49:44Z' createdBy: '1' modifiedBy: '1' - id: '218' key: '218' name: '1099' contact: id: 123515(V123515) audit: modifiedDateTime: '2022-05-26T04:49:44Z' createdDateTime: '2022-05-26T04:49:44Z' createdBy: '1' modifiedBy: '1' vendorAccountNumberList: - locationId: 1--United States of America accountNo: '111111111' vendorEmailTemplates: - id: '11' key: '11' vendor: key: '69' id: Vendor_A0000001 href: /objects/accounts-payable/vendor/69 txnDefinitionName: Purchase Order emailTemplate: id: '5' key: '5' name: AP href: /objects/company-config/email-template/5 href: /objects/accounts-payable/vendor-email-template/11 vendorPaymentProviders: [] billPayment: defaultDateOptions: none href: /objects/accounts-payable/vendor/69 ia::meta: totalCount: 1 Get a restricted vendor: value: ia::result: key: '49' id: '203' name: NCS, Inc. form1099: nameOn1099: null type: null box: null parent: key: '48' id: '202' name: Pac Bell href: /objects/accounts-payable/vendor/48 contacts: default: mailingAddress: addressLine1: '9500' addressLine2: Arboretum Blvd, Suite 310 addressLine3: Western industrial area city: Austin country: United States postCode: '78759' state: TX tax: isTaxable: true URL1: https://jack.exammple.com URL2: https://anothercompany.com companyName: NCS, Inc. email1: Henry@example.com email2: Jack@example.com fax: '14085555522' firstName: Jack1 id: NCS, Inc. lastName: Henry1 middleName: Inc1 mobile: '14085554420' pager: '14085554400' phone1: '14085551212' phone2: '14085559876' prefix: Mr. printAs: Jack Henry & Associates1 key: '217' hideContactList: true href: /objects/company-config/contact/217 primary: id: null key: null payTo: id: null key: null returnTo: id: null key: null recipient1099: id: null key: null term: id: Net 60 key: '11' href: /objects/accounts-payable/term/11 vendorAccountNumber: '203' taxId: 192-35-4308 creditLimit: 350000 totalDue: '0' billingType: balanceForward vendorType: id: Wholesaler key: '12' accountGroup: id: Midwest key: '5' priceSchedule: id: null discountPercent: null priceList: id: null key: null notes: None accountlabel: id: null key: null defaultExpenseGLAccount: id: '1500' name: Equipment key: '93' href: /objects/general-ledger/account/93 paymentPriority: normal status: active state: a isOneTimeUse: false isOnHold: false audit: modifiedDateTime: '2022-05-26T05:28:54Z' createdDateTime: '2018-07-28T19:35:15Z' createdBy: '1' modifiedBy: '1' doNotPay: false alwaysCreateBill: false currency: USD ach: enablePayments: false routingNumber: null accountNumber: null accountType: null remittanceType: null displayTermDiscountOnCheckStub: false displayVendorAccountOnCheckStub: false sendPaymentNotification: false preferredPaymentMethod: null restrictions: restrictionType: restricted locations: - 1--United States of America1 - 2--India - 3--United Kingdom - 1st Level Locations--Level 1 Locations - 2nd Level Locations--Level 2 Locations departments: - 11--Accounting - 1st Level Depts--Level 1 Departments mergePaymentRequests: true overrideOffsetGLAccount: id: null key: null name: null attachment: id: null key: null defaultLeadTime: null retainagePercentage: null lastBillCreatedDate: null lastPaymentMadeDate: null tpar: isTparEnabled: true name: 4IMPRINT INC t5018: isT5018Enabled: true t5018Number: 123OOR652 contactList: [] vendorAccountNumberList: [] vendorEmailTemplates: [] vendorPaymentProviders: [] billPayment: defaultDateOptions: none href: /objects/accounts-payable/vendor/49 ia::meta: totalCount: 1 Get a vendor enabled for United Kingdom (GB) bank files: value: ia::result: key: '203' id: UKVendor name: UKVendor form1099: nameOn1099: null type: null box: null parent: key: null id: null name: null contacts: default: mailingAddress: addressLine1: 300 Park Avenue addressLine2: Suite 1400 addressLine3: Western industrial area city: San Jose country: United Kingdom postCode: '95110' state: California tax: isTaxable: true URL1: https://alice.example.com URL2: https://anothercompany.com companyName: AlcoSoft Inc email1: alice@example.com email2: alice@example.com fax: '14085555309' firstName: Alice id: UKVendor(VUKVendor) lastName: Cooper middleName: Alice mobile: '14085554420' pager: '14085559987' phone1: '14085551212' phone2: '14085559876' prefix: Mr. printAs: UKVendor key: '442' hideContactList: false href: /objects/company-config/contact/237 primary: id: null key: null payTo: id: null key: null returnTo: id: null key: null recipient1099: id: null key: null term: id: null key: null vendorAccountNumber: null taxId: null creditLimit: 1000 totalDue: '507.40' billingType: openItem vendorType: id: null key: null accountGroup: id: null key: null priceSchedule: id: null discountPercent: null priceList: id: null key: null notes: null accountlabel: id: null key: null defaultExpenseGLAccount: id: null name: null key: null paymentPriority: normal status: active state: a isOneTimeUse: false isOnHold: false audit: modifiedDateTime: '2024-01-03T06:43:34Z' createdDateTime: '2024-01-03T06:39:33Z' createdBy: '1' modifiedBy: '1' doNotPay: false alwaysCreateBill: false currency: USD ach: enablePayments: false routingNumber: null accountNumber: null accountType: null remittanceType: null bankFiles: paymentCountryCode: gb paymentCurrency: GBP displayTermDiscountOnCheckStub: false displayVendorAccountOnCheckStub: false sendPaymentNotification: false preferredPaymentMethod: null restrictions: restrictionType: unrestricted mergePaymentRequests: true overrideOffsetGLAccount: id: null key: null name: null attachment: id: null key: null defaultLeadTime: null retainagePercentage: null lastBillCreatedDate: null lastPaymentMadeDate: null tpar: isTparEnabled: true name: 4IMPRINT INC t5018: isT5018Enabled: true t5018Number: 123OOR652 vendorBankFileSetup: - id: '26' key: '26' vendor: key: '203' id: UKVendor href: /objects/accounts-payable/vendor/203 bsbNumber: 047-359 paymentReference: BACS HSBC corp sortCode: '849571' branchCode: '213456' bankAccountType: '4' bankAccountCode: '345624' proofOfPayment: true bankAccountNumber: '87402896' bankAccountName: UK Bank Corp. businessIdCode: AIBKIE2D491 href: /objects/accounts-payable/vendor-bank-file-setup/26 vendorEmailTemplates: null vendorPaymentProviders: [] billPayment: defaultDateOptions: none href: /objects/accounts-payable/vendor/203 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a vendor description: >+ Updates an existing vendor by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness user
PermissionsList, View, Edit Vendors
tags: - Accounts_Payable_Vendors operationId: update-accounts-payable-vendor-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-vendor' - type: object properties: id: readOnly: true examples: Update a single value: value: billingType: balanceForward Update multiple values: value: defaultLeadTime: 5 taxId: '192354308' form1099: nameOn1099: NCS type: MISC box: '3' isOnHold: true doNotPay: true alwaysCreateBill: true creditLimit: 10000 retainagePercentage: 20 notes: Make sure to include on 1099 discountPercent: 20 responses: '200': description: OK content: application/json: schema: type: object title: Updated vendor properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a vendor: value: ia::result: key: '1' id: RituDate11-21-2015 href: /objects/accounts-payable/vendor/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a vendor description: >+ Deletes a vendor. You can only delete vendors that aren't tied to any transactions or payments.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness user
PermissionsList, View, Delete Vendors
tags: - Accounts_Payable_Vendors operationId: delete-accounts-payable-vendor-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /workflows/accounts-payable/vendor/approve: post: summary: Approve a vendor description: Approve a vendor tags: - Accounts_Payable_Vendors operationId: approve-accounts-payable-vendor requestBody: content: application/json: schema: $ref: '#/components/schemas/request' responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/response' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /workflows/accounts-payable/vendor/decline: post: summary: Decline a vendor description: Decline a vendor tags: - Accounts_Payable_Vendors operationId: decline-accounts-payable-vendor requestBody: content: application/json: schema: $ref: '#/components/schemas/decline-request' responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/decline-response' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/vendor-type: get: summary: List vendor types description: >+ Returns a collection with a key, ID, and link for each vendor type. 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
SubscriptionAccounts Payable
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Vendor types
tags: - Accounts_Payable_Vendor types operationId: list-accounts-payable-vendor-type responses: '200': description: OK content: application/json: schema: type: object title: List of vendor-type objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List vendor types: value: ia::result: - key: '14' id: WholeSale href: /objects/accounts-payable/vendor-type/14 - key: '2' id: Supplier href: /objects/accounts-payable/vendor-type/2 - key: '4' id: VType-1099INT href: /objects/accounts-payable/vendor-type/4 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a vendor type description: |+ Creates a new vendor type.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness
PermissionsList, Add Vendor types
tags: - Accounts_Payable_Vendor types operationId: create-accounts-payable-vendor-type responses: '201': description: Created content: application/json: schema: type: object title: New vendor-type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a vendor type: value: ia::result: key: '23' id: WholeSaleDistributor href: /objects/accounts-payable/vendor-type/23 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-vendor-type' - $ref: '#/components/schemas/accounts-payable-vendor-typeRequiredProperties' examples: Create a vendor type: value: id: WholeSaleDistributor form1099: type: DIV box: 1B security: - OAuth2: [] /objects/accounts-payable/vendor-type/{key}: parameters: - schema: type: string name: key description: System-assigned key for the vendor type. in: path required: true example: '4' get: summary: Get a vendor type description: |+ Returns detailed information for a specified vendor type.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness
PermissionsList, View Vendor types
tags: - Accounts_Payable_Vendor types operationId: get-accounts-payable-vendor-type-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the vendor-type properties: ia::result: $ref: '#/components/schemas/accounts-payable-vendor-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a vendor type: value: ia::result: id: Wholesaler parent: id: WholeSaleDistributor key: '23' href: /objects/accounts-payable/vendor-type/23 status: active form1099: type: DIV box: 1B key: '5' audit: createdDateTime: '2018-07-28T19:29:46Z' modifiedDateTime: '2023-04-11T06:53:27Z' createdBy: '68' modifiedBy: '68' href: /objects/accounts-payable/vendor-type/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a vendor type operationId: update-accounts-payable-vendor-type-key description: >+ Updates an existing vendor type by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness
PermissionsList, Edit Vendor types
tags: - Accounts_Payable_Vendor types responses: '200': description: OK content: application/json: schema: type: object title: Updated vendor-type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a vendor type: value: ia::result: key: '5' id: Wholesaler href: /objects/accounts-payable/vendor-type/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-vendor-type' - type: object properties: id: readOnly: true examples: Update a vendor type: value: status: inactive Update a parent vendor type: value: parent: id: WholeSaleDistributor status: inactive security: - OAuth2: [] delete: summary: Delete a vendor type description: >+ Deletes a vendor type.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness
PermissionsList, View, Delete Vendor types
tags: - Accounts_Payable_Vendor types operationId: delete-accounts-payable-vendor-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/vendor-payment-provider: get: summary: List vendor payment providers description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each vendor payment provider. 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
SubscriptionAdministration, Accounts Payable, Sage Cloud Services, Outbound Payment Services
User ypeBusiness user with admin permissions
PermissionsList, View Application Subscriptions and Vendors
tags: - Accounts_Payable_Vendor payment providers operationId: list-accounts-payable-vendor-payment-provider responses: '200': description: OK content: application/json: schema: type: object title: List vendor payment providers properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List vendor payment providers: value: ia::result: - key: '1' id: '1' href: /objects/accounts-payable/vendor-payment-provider/1 - key: '2' id: '2' href: /objects/accounts-payable/vendor-payment-provider/2 - key: '3' id: '3' href: /objects/accounts-payable/vendor-payment-provider/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a vendor payment provider description: >+ Creates a new vendor payment provider.
Permissions and other requirements
SubscriptionAdministration, Accounts Payable, Sage Cloud Services, Outbound Payment Services
User ypeBusiness user with admin permissions
PermissionsList, View, Subscribe, Configure Application Subscriptions
List, View, Edit Vendors
tags: - Accounts_Payable_Vendor payment providers operationId: create-accounts-payable-vendor-payment-provider requestBody: description: Create a vendor payment provider required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-vendor-payment-provider' - $ref: '#/components/schemas/accounts-payable-vendor-payment-providerRequiredProperties' examples: Create a vendor payment provider: value: paymentProvider: id: CSI vendor: id: PV001 status: active responses: '201': description: Created content: application/json: schema: type: object title: New vendor payment provider properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a vendor payment provider: value: ia::result: key: '111' href: /objects/accounts-payable/vendor-payment-provider/111 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/vendor-payment-provider/{key}: parameters: - name: key description: System-assigned key for the vendor payment provider. in: path required: true example: '1' schema: type: string get: summary: Get a vendor payment provider description: >+ Returns detailed information for a specified vendor payment provider.
Permissions and other requirements
SubscriptionAdministration, Accounts Payable, Sage Cloud Services, Outbound Payment Services
User ypeBusiness user with admin permissions
PermissionsList, View Application Subscriptions and Vendors
tags: - Accounts_Payable_Vendor payment providers operationId: get-accounts-payable-vendor-payment-provider-key responses: '200': description: OK content: application/json: schema: type: object title: Details of a vendor payment provider properties: ia::result: $ref: '#/components/schemas/accounts-payable-vendor-payment-provider' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a vendor payment provider: value: ia::result: key: '1' id: '1' paymentProvider: key: '3' id: CSI name: CSI href: /objects/cash-management/payment-provider/3 vendor: key: '111' id: VEND-00010 name: Design Works href: /objects/accounts-payable/vendor/111 state: subscribed message: 44299680-351-1628136894 status: active audit: createdDateTime: '2021-08-05T04:14:56Z' modifiedDateTime: '2021-09-29T06:43:06Z' createdBy: '1' modifiedBy: '1' preferredPaymentMethod: key: '454' id: '454' name: Check href: /objects/cash-management/provider-payment-method/454 href: /objects/accounts-payable/vendor-payment-provider/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a vendor payment provider description: >+ Updates an existing vendor payment provider by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAdministration, Accounts Payable, Sage Cloud Services, Outbound Payment Services
User ypeBusiness user with admin permissions
PermissionsList, View, Subscribe, Configure Application Subscriptions
List, View, Edit Vendors
tags: - Accounts_Payable_Vendor payment providers operationId: update-accounts-payable-vendor-payment-provider-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-vendor-payment-provider' - type: object properties: id: readOnly: true examples: Update a single value: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Update a vendor payment provider properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: key: '1' id: '1' href: /objects/accounts-payable/vendor-payment-provider/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/account-label: get: summary: List account labels description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each label. 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
SubscriptionAccounts Payable
User ypeBusiness
PermissionsList account labels
tags: - Accounts_Payable_Account labels responses: '200': description: OK content: application/json: schema: type: object title: List of account-label objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List account labels: value: ia::result: - key: '8' id: Accounting Fees href: /objects/accounts-payable/account-label/8 - key: '9' id: Bank Fees href: /objects/accounts-payable/account-label/9 - key: '10' id: Bank Interest Earned href: /objects/accounts-payable/account-label/10 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' operationId: list-accounts-payable-account-label security: - OAuth2: [] post: summary: Create an account label description: |+ Creates a new account label.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness
PermissionsAdd account labels
tags: - Accounts_Payable_Account labels operationId: create-accounts-payable-account-label responses: '201': description: Created content: application/json: schema: type: object title: New account-label properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create an account label: value: ia::result: key: '37' id: Sales href: /objects/accounts-payable/account-label/37 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-account-label' - $ref: '#/components/schemas/accounts-payable-account-labelRequiredProperties' examples: Create an account label: value: id: Sales description: Sales team expenses status: active glAccount: id: 4000--Sales offsetGLAccount: id: 4001--Miscellaneous - Sales security: - OAuth2: [] /objects/accounts-payable/account-label/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the account label. get: summary: Get an account label description: >+ Returns detailed information for a specified account label.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness
PermissionsList, Edit account labels
operationId: get-accounts-payable-account-label-key tags: - Accounts_Payable_Account labels responses: '200': description: OK content: application/json: schema: type: object title: Details of the account-label properties: ia::result: $ref: '#/components/schemas/accounts-payable-account-label' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an account label: value: ia::result: key: '8' id: Accounting Fees description: Accounting Fees glAccount: id: 6600.01--Accounting Fees key: '318' href: /objects/general-ledger/account/318 status: active offsetGLAccount: id: null key: null form1099Type: DIV form1099Box: 1B href: /objects/accounts-payable/account-label/8 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an account label operationId: update-accounts-payable-account-label-key description: >+ Updates an existing account label by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness
PermissionsList, Edit account labels
tags: - Accounts_Payable_Account labels responses: '200': description: OK content: application/json: schema: type: object title: Updated account-label properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update an account label: value: ia::result: key: '37' id: Sales href: /objects/accounts-payable/account-label/37 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-account-label' - type: object properties: id: readOnly: true examples: Update an account label: value: description: This is Sales Account label status: active offsetGLAccount: id: 4000.03--Sales-Others security: - OAuth2: [] delete: summary: Delete an account label description: >+ Deletes an account label.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness
PermissionsList, Delete account labels
tags: - Accounts_Payable_Account labels operationId: delete-accounts-payable-account-label-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/adjustment: get: summary: List adjustments description: >- Returns a collection with a key, ID, and link for each adjustment. 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: - Accounts_Payable_Adjustments operationId: list-accounts-payable-adjustment responses: '200': description: OK content: application/json: schema: type: object title: List of adjustment objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List adjustments: value: ia::result: - key: '186' id: '186' href: /objects/accounts-payable/adjustment/186 - key: '187' id: '187' href: /objects/accounts-payable/adjustment/187 - key: '319' id: '319' href: /objects/accounts-payable/adjustment/319 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an adjustment description: Creates a new adjustment. tags: - Accounts_Payable_Adjustments operationId: create-accounts-payable-adjustment responses: '201': description: Created content: application/json: schema: type: object title: New adjustment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create an adjustment: value: ia::result: key: '26' id: '26' href: /objects/accounts-payable/adjustment/26 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-adjustment' - $ref: '#/components/schemas/accounts-payable-adjustmentRequiredProperties' examples: Create an adjustment: value: adjustmentNumber: credit-001 vendor: id: 1099 Int description: Adj for Bil -001 referenceNumber: Bill-001-02 adjustmentSummary: glPostingDate: '2024-03-05' createdDate: '2024-03-05' contacts: payTo: id: 1099 Int returnTo: id: 1099 Int isTaxInclusive: false currency: baseCurrency: AUD txnCurrency: USD exchangeRateDate: '2024-03-08' exchangeRateTypeId: Intacct Daily Rate exchangeRate: 1.5154 lines: - glAccount: id: '6000' txnAmount: '5.00' totalTxnAmount: '25.00' dimensions: department: id: '11' location: id: '4' project: id: '8' customer: id: '1' vendor: id: 1099 Int employee: id: '1' item: id: '1' class: id: '3' memo: Adj for Bil -001 security: - OAuth2: [] /objects/accounts-payable/adjustment/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the adjustment. get: summary: Get an adjustment description: Returns detailed information for a specified adjustment. tags: - Accounts_Payable_Adjustments operationId: get-accounts-payable-adjustment-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the adjustment properties: ia::result: $ref: '#/components/schemas/accounts-payable-adjustment' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an adjustment: value: ia::result: id: '67' key: '67' recordType: pa adjustmentNumber: credit-001 state: posted vendor: id: 1099 Int key: 1099 Int name: 1099 Int vendorDue: '28.94' href: /objects/accounts-payable/vendor/1099 Int referenceNumber: Bill-001-02 description: Adj for Bil -001 createdDate: '2024-03-05' audit: createdDateTime: '2024-03-05T00:00:00Z' modifiedDateTime: '2024-03-20T09:29:02Z' createdBy: '1' modifiedBy: '1' adjustmentSummary: glPostingDate: '2024-03-05' name: 'Adjustments: 2024/03/05 Batch' id: '45' key: '45' isSummaryOpen: open isSummaryPosted: 'false' href: /objects/accounts-payable/adjustment-summary/45 currency: baseCurrency: AUD txnCurrency: USD exchangeRateDate: '2024-03-08' exchangeRateTypeId: Intacct Daily Rate exchangeRate: 1.5154 totalEntered: '7.58' totalBaseAmountDue: '7.58' txnTotalEntered: '5.00' txnTotalDue: '5.00' contacts: payTo: id: 1099 Int key: '299' href: /objects/company-config/contact/299 returnTo: id: 1099 Int key: '299' href: /objects/company-config/contact/299 moduleKey: 3.AP isTaxInclusive: false lines: - id: '700' key: '700' apAdjustment: id: '67' key: '67' href: /objects/accounts-payable/adjustment/67 glAccount: key: '246' id: '6000' name: G&A Salaries href: /objects/general-ledger/account/246 overriddenOffsetGLAccount: key: '109' id: '2000' name: Accounts Payable href: /objects/general-ledger/account/109 accountLabel: key: null id: null baseAmount: '7.58' txnAmount: '5.00' dimensions: department: key: '9' id: '11' name: Accounting href: /objects/company-config/department/9 location: key: '4' id: '4' name: Australia href: /objects/company-config/location/4 project: key: '8' id: '8' name: Client Services - Power Aerospace Materials href: /objects/projects/project/8 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 class: key: '1' id: '3' name: Heath Care href: /objects/company-config/class/1 memo: Adj for Bil -001 currency: exchangeRate: date: '2024-03-08' typeId: '-1' rate: '1.5154' txnCurrency: USD baseCurrency: AUD lineNumber: '1' paymentInformation: totalBaseAmountPaid: '0.00' txnTotalPaid: '0.00' totalBaseAmountSelected: '0.00' txnTotalSelected: '0.00' adjustmentType: pa audit: modifiedBy: '1' createdDateTime: '2024-03-20T09:29:02Z' modifiedDateTime: '2024-03-20T09:29:02Z' createdBy: '1' hasForm1099: false href: /objects/accounts-payable/adjustment-line/700 href: /objects/accounts-payable/adjustment/67 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an adjustment operationId: update-accounts-payable-adjustment-key description: >- Updates an adjustment by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Payable_Adjustments responses: '200': description: OK content: application/json: schema: type: object title: Updated adjustment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated adjustment: value: description: Bill -001 adjustment-1 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-adjustment' - type: object properties: id: readOnly: true adjustmentType: readOnly: true state: readOnly: true examples: Update an adjustment: value: ia::result: key: '26' id: '26' href: /objects/accounts-payable/adjustment/625459 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 security: - OAuth2: [] delete: summary: Delete an adjustment description: >- Deletes an adjustment. If an adjustment has not been applied to a bill, it can be deleted. tags: - Accounts_Payable_Adjustments operationId: delete-accounts-payable-adjustment-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/adjustment-line/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the adjustment line. get: summary: Get an adjustment line description: Returns detailed information for a specified adjustment line. tags: - Accounts_Payable_Adjustment lines responses: '200': description: OK content: application/json: schema: type: object title: Details of the adjustment-line properties: ia::result: $ref: '#/components/schemas/accounts-payable-adjustment-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an adjustment: value: ia::result: id: '146' key: '146' apAdjustment: id: '24' key: '24' href: /objects/accounts-payable/adjustment/24 glAccount: key: '246' id: '6000' name: G&A Salaries href: /objects/general-ledger/account/246 overriddenOffsetGLAccount: key: '109' id: '2000' name: Accounts Payable href: /objects/general-ledger/account/109 accountLabel: key: null id: null baseAmount: '-318.23' txnAmount: '-210.00' dimensions: department: key: '9' id: '11' name: Accounting href: /objects/company-config/department/9 location: key: '4' id: '4' name: Australia href: /objects/company-config/location/4 project: key: '8' id: '8' name: Client Services - Power Aerospace Materials href: /objects/projects/project/8 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 class: key: '1' id: '3' name: Heath Care href: /objects/company-config/class/1 memo: Adj for Bil -001 currency: exchangeRate: date: '2024-03-08' typeId: '-1' rate: '1.5154' txnCurrency: USD baseCurrency: AUD lineNumber: '1' paymentInformation: totalBaseAmountPaid: '0.00' txnTotalPaid: '0.00' totalBaseAmountSelected: '0.00' txnTotalSelected: '0.00' adjustmentType: pa audit: modifiedBy: '1' createdDateTime: '2024-03-09T07:42:01Z' modifiedDateTime: '2024-03-09T07:52:39Z' createdBy: '1' hasForm1099: 'false' form1099: type: null box: null href: /objects/accounts-payable/adjustment-line/146 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' operationId: get-accounts-payable-adjustment-line-key security: - OAuth2: [] /objects/accounts-payable/adjustment-summary: get: summary: List adjustment summaries description: >- Returns a collection with a key, ID, and link for each adjustment summary. 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: - Accounts_Payable_Adjustment summaries operationId: list-accounts-payable-adjustment-summary responses: '200': description: OK content: application/json: schema: type: object title: accounts-payable-adjustment-summary Collection properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List adjustment summaries: value: ia::result: - key: '13' id: '13' href: /objects/accounts-payable/adjustment-summary/13 - key: '26' id: '26' href: /objects/accounts-payable/adjustment-summary/26 - key: '20' id: '20' href: /objects/accounts-payable/adjustment-summary/20 - key: '771' id: '771' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/adjustment-summary/{key}: parameters: - name: key description: System-assigned key for the adjustment summary. in: path required: true schema: type: string get: summary: Get an adjustment summary description: Returns detailed information for a specified adjustment summary. tags: - Accounts_Payable_Adjustment summaries operationId: get-accounts-payable-adjustment-summary-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the adjustment-summary properties: ia::result: $ref: '#/components/schemas/accounts-payable-adjustment-summary' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an adjustment summary: value: ia::result: key: '13' id: '13' name: 'Adjustments: 2019/01/18 Batch' glPostingDate: '2019-01-18' status: active recordType: apAdjustments totalAmount: '43.00' state: open parent: key: 'null' id: 'null' preventGLPosting: false bankAccountId: key: 'null' id: 'null' summaryCreationType: system isQuickPaymentSummary: false href: /objects/accounts-payable/adjustment-summary/13 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/bill: get: summary: List bills description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each bill. 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
SubscriptionAccounts Payable
User ypeBusiness user
PermissionsList Bills
tags: - Accounts_Payable_Bills operationId: list-accounts-payable-bill responses: '200': description: OK content: application/json: schema: type: object title: List of bill objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bills: value: ia::result: - key: '299' id: '299' href: /objects/accounts-payable/bill/299 - key: '294' id: '294' href: /objects/accounts-payable/bill/294 - key: '295' id: '295' href: /objects/accounts-payable/bill/295 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a bill description: |+ Creates a new bill.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness user
PermissionsList, View, Add Bills
tags: - Accounts_Payable_Bills operationId: create-accounts-payable-bill requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-bill' - $ref: '#/components/schemas/accounts-payable-billRequiredProperties' examples: Create a bill: value: billNumber: Bill-001-06 vendor: id: 1099 Int referenceNumber: Ref-123 description: bill - 001 - vendor 1099 createdDate: '2022-02-21' postingDate: '2022-02-21' discountCutOffDate: '2022-02-21' dueDate: '2022-03-08' recommendedPaymentDate: '2022-02-26' paymentPriority: normal isOnHold: false currency: baseCurrency: USD txnCurrency: USD exchangeRate: date: '2022-02-21' typeId: Intacct Daily Rate rate: 1.0679 contacts: payTo: id: 1099 Int returnTo: id: 1099 Int attachment: id: atch1 isTaxInclusive: false lines: - glAccount: id: '6000' txnAmount: '5' totalTxnAmount: '15.00' dimensions: location: id: '4' department: id: '11' project: id: '8' customer: id: '1' vendor: id: 1099 Int employee: id: '1' item: id: '1' class: id: '3' memo: bill - 001 - vendor 1099 hasForm1099: 'false' project: isBillable: false - glAccount: id: '6000' txnAmount: '5.00' totalTxnAmount: '25.00' dimensions: location: id: '4' department: id: '11' project: id: '8' customer: id: '1' vendor: id: 1099 Int employee: id: '1' item: id: '1' class: id: '3' memo: bill - 001 - vendor 1099 hasForm1099: 'false' project: isBillable: false responses: '201': description: Created content: application/json: schema: type: object title: New bill properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New bill: value: ia::result: key: '299' id: '299' href: /objects/accounts-payable/bill/299 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/bill/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the bill. get: summary: Get a bill description: |+ Returns detailed information for a specified bill.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness user
PermissionsList, View Bills
tags: - Accounts_Payable_Bills operationId: get-accounts-payable-bill-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bill properties: ia::result: $ref: '#/components/schemas/accounts-payable-bill' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bill: value: ia::result: id: '60' key: '60' recordType: pi billNumber: Bill-001-06 state: posted vendor: id: 1099 Int name: 1099 Int key: '43' form1099: type: null box: null vendorTypeForm1099Type: null vendorDue: '21.36' href: /objects/accounts-payable/vendor/43 referenceNumber: Ref-123 description: bill - 001 - vendor 1099 createdDate: '2022-02-21' audit: createdDateTime: '2022-02-21T00:00:00Z' modifiedDateTime: '2024-03-20T08:31:41Z' createdBy: '1' modifiedBy: '1' postingDate: '2022-02-21' discountCutOffDate: '2022-02-21' dueDate: '2022-03-08' recommendedPaymentDate: '2022-02-26' paymentPriority: normal isOnHold: false currency: baseCurrency: AUD txnCurrency: USD exchangeRate: date: '2022-02-21' typeId: Custom rate: 1.0679 totalBaseAmount: '10.68' totalBaseAmountDue: '10.68' totalTxnAmount: '10.00' totalTxnAmountDue: '10.00' contacts: payTo: id: 1099 Int key: '299' href: /objects/company-config/contact/299 returnTo: id: 1099 Int key: '299' href: /objects/company-config/contact/299 billSummary: name: 'Bills: 2022/02/21 Batch' id: '37' key: '37' isSummaryOpen: open isSummaryPosted: 'false' href: /objects/accounts-payable/bill-summary/37 recurringSchedule: key: null isSystemGenerated: F dueInDays: '743' isTaxInclusive: false attachment: id: atch1 key: '6' href: /objects/company-config/attachment/6 sourceModule: accountsPayable lines: - id: '440' key: '440' bill: id: '60' key: '60' href: /objects/accounts-payable/bill/60 glAccount: key: '246' id: '6000' name: G&A Salaries href: /objects/general-ledger/account/246 overrideOffsetGLAccount: key: '109' id: '2000' name: Accounts Payable href: /objects/general-ledger/account/109 accountLabel: key: null id: null createdDate: '2022-02-21' baseAmount: '5.34' txnAmount: '5.00' dimensions: department: key: '9' id: '11' name: Accounting href: /objects/company-config/department/9 location: key: '4' id: '4' name: Australia href: /objects/company-config/location/4 project: key: '8' id: '8' name: Client Services - Power Aerospace Materials href: /objects/projects/project/8 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 class: key: '1' id: '3' name: Heath Care href: /objects/company-config/class/1 baseLocation: name: Australia key: '4' href: /objects/company-config/location/4 memo: bill - 001 - vendor 1099 currency: exchangeRate: date: '2022-02-21' typeId: '-99' rate: 1.0679 txnCurrency: USD baseCurrency: AUD hasForm1099: 'false' lineNumber: '1' paymentInformation: totalBaseAmountPaid: '0.00' totalTxnAmountPaid: '0.00' totalBaseAmountSelectedForPayment: '0.00' totalTxnAmountSelectedForPayment: '0.00' project: isBillable: false isBilled: false href: /objects/accounts-payable/bill-line/440 - id: '442' key: '442' bill: id: '60' key: '60' href: /objects/accounts-payable/bill/60 glAccount: key: '246' id: '6000' name: G&A Salaries href: /objects/general-ledger/account/246 overrideOffsetGLAccount: key: '109' id: '2000' name: Accounts Payable href: /objects/general-ledger/account/109 accountLabel: key: null id: null createdDate: '2022-02-21' baseAmount: '5.34' txnAmount: '5.00' dimensions: department: key: '9' id: '11' name: Accounting href: /objects/company-config/department/9 location: key: '4' id: '4' name: Australia href: /objects/company-config/location/4 project: key: '8' id: '8' name: Client Services - Power Aerospace Materials href: /objects/projects/project/8 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 class: key: '1' id: '3' name: Heath Care href: /objects/company-config/class/1 baseLocation: name: Australia key: '4' href: /objects/company-config/location/4 memo: bill - 001 - vendor 1099 currency: exchangeRate: date: '2022-02-21' typeId: '-99' rate: 1.0679 txnCurrency: USD baseCurrency: AUD hasForm1099: 'false' lineNumber: '2' paymentInformation: totalBaseAmountPaid: '0.00' totalTxnAmountPaid: '0.00' totalBaseAmountSelectedForPayment: '0.00' totalTxnAmountSelectedForPayment: '0.00' project: isBillable: false isBilled: false href: /objects/accounts-payable/bill-line/442 href: /objects/accounts-payable/bill/60 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a bill description: >+ Updates an existing bill by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness user
PermissionsList, View, Edit Bills
tags: - Accounts_Payable_Bills operationId: update-accounts-payable-bill-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-bill' - type: object properties: id: readOnly: true examples: Update a single value: value: billNumber: bill10 responses: '200': description: OK content: application/json: schema: type: object title: Updated bill properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: key: '63' id: '198376' href: /objects/accounts-payable/bill/63 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a bill description: >+ Deletes a bill. You can only delete a bill that's in a Posted, Draft, or Declined state. For partially paid bills, first cancel the payment request, which changes the bill's state to Posted. Bills in an Approved state can only be deleted if no payment has been made against them.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness user
PermissionsList, Delete Bills
tags: - Accounts_Payable_Bills operationId: delete-accounts-payable-bill-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/bill-line: get: summary: List bill lines description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each bill 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
SubscriptionAccounts Payable
User ypeBusiness user
PermissionsList, View Bills
tags: - Accounts_Payable_Bill lines operationId: list-accounts-payable-bill-line responses: '200': description: OK content: application/json: schema: type: object title: List of bill-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bill lines: value: ia::result: - key: '1' id: '1' href: /objects/accounts-payable/bill-line/1 - key: '3' id: '3' href: /objects/accounts-payable/bill-line/3 - key: '5' id: '5' href: /objects/accounts-payable/bill-line/5 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/bill-line/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the line item. get: summary: Get a bill line description: |+ Returns detailed information for a specified line item in a bill.
Permissions and other requirements
SubscriptionAccounts Payable
User ypeBusiness user
PermissionsList, View Bills
tags: - Accounts_Payable_Bill lines operationId: get-accounts-payable-bill-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bill-line properties: ia::result: $ref: '#/components/schemas/accounts-payable-bill-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a line item: value: ia::result: id: '94' key: '94' bill: id: '18' key: '18' href: /objects/accounts-payable/bill/18 glAccount: key: '246' id: '6000' name: G&A Salaries href: /objects/general-ledger/account/246 overrideOffsetGLAccount: key: '109' id: '2000' name: Accounts Payable href: /objects/general-ledger/account/109 accountLabel: key: null id: null createdDate: '2022-02-21' baseAmount: '5.34' txnAmount: '5.00' dimensions: department: key: '9' id: '11' name: Accounting href: /objects/company-config/department/9 location: key: '4' id: '4' name: Australia href: /objects/company-config/location/4 project: key: '8' id: '8' name: Client Services - Power Aerospace Materials href: /objects/projects/project/8 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 class: key: '1' id: '3' name: Heath Care href: /objects/company-config/class/1 baseLocation: name: Australia key: '4' href: /objects/company-config/location/4 memo: bill - 001 - vendor 1099 currency: exchangeRate: date: '2022-02-21' typeId: '-99' rate: 1.0679 txnCurrency: USD baseCurrency: AUD allocation: name: null id: null key: null hasForm1099: 'false' lineNumber: '1' project: isBillable: false isBilled: false releaseToPay: null state: A form1099: type: null box: null fixedAsset: nameOfAcquiredAsset: null includeTaxInAssetCost: false href: /objects/accounts-payable/bill-line/94 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/bill-summary: get: summary: List bill summaries description: >- Returns up to 100 object references from the collection with a key, ID, and link for each bill summary. 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: - Accounts_Payable_Bill summaries operationId: list-accounts-payable-bill-summary responses: '200': description: OK content: application/json: schema: type: object title: List of bill-summary objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bill summaries: value: ia::result: - key: '94' id: '94' href: /objects/accounts-payable/bill-summary/94 - key: '96' id: '96' href: /objects/accounts-payable/bill-summary/96 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/bill-summary/{key}: parameters: - name: key description: System-assigned key for the bill summary. in: path required: true schema: type: string get: summary: Get a bill summary description: Returns detailed information for a specified bill summary. tags: - Accounts_Payable_Bill summaries operationId: get-accounts-payable-bill-summary-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bill-summary properties: ia::result: $ref: '#/components/schemas/accounts-payable-bill-summary' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bill summary: value: ia::result: id: '98' key: '98' name: 'Bills: 2022/08/02 Batch' glPostingDate: '2022-08-02' status: active recordType: apBill totalAmount: '100.23' state: open parent: id: null key: null preventGLPosting: false bankAccountId: id: null key: null summaryCreationType: Auto-Summary isQuickPaymentSummary: false href: /objects/accounts-payable/bill-summary/98 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/payment: get: summary: List payments description: >- Returns a collection with a key, ID, and link for each payment. 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: - Accounts_Payable_Payments operationId: list-accounts-payable-payment responses: '200': description: OK content: application/json: schema: type: object title: List of payment objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List payments: value: ia::result: - key: '1718' id: '1718' href: /objects/accounts-payable/payment/1718 - key: '1717' id: '1717' href: /objects/accounts-payable/payment/1717 - key: '3228' id: '3228' href: /objects/accounts-payable/payment/3228 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a payment description: Creates a new payment. tags: - Accounts_Payable_Payments operationId: create-accounts-payable-payment requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-payment' - $ref: '#/components/schemas/accounts-payable-paymentRequiredProperties' examples: Create a payment submit action: value: financialAccount: entityId: Visdb paymentDate: '2023-04-04' action: draft description: description documentNumber: '123' documentId: '123' baseCurrency: currency: USD txnCurrency: currency: USD paymentMethod: creditCard vendor: id: '201' details: - txnCurrency: paymentAmount: '10.00' inlineAmount: '10.00' adjustmentAmount: '10.00' postedAdvanceAmount: '10.00' bill: key: '3318' apDebitAdjustment: key: '3319' apDebitAdjustmentLine: key: '30854' apAdvance: key: '3320' apAdvanceLine: key: '30856' inlineBill: key: '3321' inlineBillLine: key: '30866' responses: '201': description: Created content: application/json: schema: type: object title: New payment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a payment: value: ia::result: id: '3323' key: '3323' href: /objects/accounts-payable/payment/3323 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/payment/{key}: parameters: - name: key description: System-assigned key for the payment. in: path required: true schema: type: string example: '3323' get: summary: Get a payment description: Returns detailed information for a specified payment. tags: - Accounts_Payable_Payments operationId: get-accounts-payable-payment-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the payment properties: ia::result: $ref: '#/components/schemas/accounts-payable-payment' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a payment: value: ia::result: id: '3302' key: '3302' paymentSummary: id: '1843' key: '1843' name: 'Payments: 2023/03/30 04:08:58:5637 Batch' postingDate: '2023-03-21' href: /objects/accounts-payable/summary/1843 recordType: pp financialAccount: entityId: Visdb entityType: cc name: VISA currency: USD state: Submitted paymentMethod: creditCard vendor: entity: V201 id: '201' name: PG & E documentNumber: '123' description: Payment for 2023-03-21 documentId: Paid For PrjUS_InvWParent_4 txnDate: '2023-03-21' txnPaidDate: '2023-03-21' baseCurrency: currency: USD totalAmount: '10' totalSelected: '0' totalPaid: '10' totalDue: '0' txnCurrency: currency: USD totalAmount: '10' totalSelected: '0' totalPaid: '10' totalDue: '0' exchangeRate: date: null typeId: null rate: null payToContact: payTo: name: PG & E(V201) key: '6886' href: /objects/company-config/contact/6886 audit: createdDateTime: '2023-03-29T18:08:57Z' modifiedDateTime: '2023-03-29T18:08:59Z' createdBy: '1' modifiedBy: '1' cleared: F clearedDate: null isInclusiveTax: false taxSolution: key: null id: null taxCalculationMethod: null lines: - id: '30762' key: '30762' apPayment: id: '3302' key: '3302' href: /objects/accounts-payable/payment/3302 glAccount: key: '376' id: '2000.02' name: Accounts Payable2 href: /objects/general-ledger/account/376 baseCurrency: amount: '10' currency: USD totalPaid: '10' totalSelected: '0' txnCurrency: amount: '10' currency: USD totalPaid: '10' totalSelected: '0' department: id: null name: null location: id: '2' name: India description: Create_MP_02 exchangeRate: date: '2023-03-21' typeId: null rate: '1' lineNumber: '1' paymentLineRecord: pp bankLocation: '2' audit: createdDateTime: '2023-03-29T18:08:57Z' modifiedDateTime: '2023-03-29T18:08:59Z' createdBy: '1' modifiedBy: '1' taxDetail: id: null key: null isTax: false dimensions: nsp::rgldim43731355_10015: key: '' id: '' nsp::rgldim43731355_10074: key: '' id: '' nsp::rgldim43731355_10127: key: '' id: '' nsp::rgldim44774013_10178: key: '' id: '' nsp::rgldim44774013_10232: key: '' id: '' href: /objects/accounts-payable/payment-line/30762 details: - id: '1059' key: '1059' bill: id: '3289' key: '3289' href: /objects/accounts-payable/bill/3289 billLine: id: '30724' key: '30724' href: /objects/accounts-payable/bill-line/30724 apCreditAdjustment: id: null key: null apCreditAdjustmentLine: id: null key: null apPayment: id: '3302' key: '3302' href: /objects/accounts-payable/payment/3302 apPaymentLine: id: '30762' key: '30762' href: /objects/accounts-payable/payment-line/30762 paymentDate: '2023-03-21' baseCurrency: paymentAmount: '10' inlineAmount: null discountAmount: null adjustmentAmount: null postedAdvanceAmount: null txnCurrency: paymentAmount: '10' inlineAmount: null discountAmount: null adjustmentAmount: null postedAdvanceAmount: null currency: USD inlineBill: id: null key: null inlineBillLine: id: null key: null apDiscount: id: null key: null apDiscountLine: id: null key: null discountDate: null apDebitAdjustment: id: null key: null apDebitAdjustmentLine: id: null key: null apAdvance: id: null key: null apAdvanceLine: id: null key: null apPostedAdvance: id: null key: null apPostedAdvanceLine: id: null key: null state: C moduleKey: 3.AP audit: createdDateTime: '2023-03-29T18:08:58Z' modifiedDateTime: '2023-03-29T18:08:58Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-payable/payment-detail/1059 href: /objects/accounts-payable/payment/3302 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a payment description: >- Updates an existing payment by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Payable_Payments operationId: update-accounts-payable-payment-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-payment' - type: object properties: id: readOnly: true examples: Update a payment: value: description: 'Payment for DOC Number: 22345' paymentDate: '2023-04-05' documentNumber: '22345' documentId: '22345' responses: '200': description: OK content: application/json: schema: type: object title: Updated payment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a payment: value: ia::result: id: '3325' key: '3325' href: /objects/accounts-payable/payment/3325 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a payment description: Deletes a payment. tags: - Accounts_Payable_Payments operationId: delete-accounts-payable-payment-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/payment-line: get: summary: List payment lines description: >- Returns a collection with a key, ID, and link for each payment line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Accounts_Payable_Payment lines operationId: list-accounts-payable-payment-line responses: '200': description: OK content: application/json: schema: type: object title: List of payment line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get payment lines: value: ia::result: - key: '3936' id: '3936' href: /objects/accounts-payable/payment-line/3936 - key: '3938' id: '3938' href: /objects/accounts-payable/payment-line/3938 ia::meta: totalCount: 2 start: 0 pageSize: 1 next: 0 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/payment-line/{key}: parameters: - name: key description: System-assigned key for the payment line. in: path required: true schema: type: string get: summary: Get a payment line description: Returns detailed information for a specified payment line. tags: - Accounts_Payable_Payment lines operationId: get-accounts-payable-payment-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the payment line properties: ia::result: $ref: '#/components/schemas/accounts-payable-payment-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get payment line: value: ia::result: id: '3936' key: '3936' apPayment: id: '267' key: '267' href: /objects/accounts-payable/payment/267 glAccount: key: '109' id: '2000' name: Accounts Payable href: /objects/general-ledger/account/109 baseCurrency: amount: '100' currency: USD totalPaid: '0' totalSelected: '100' txnCurrency: amount: '100' currency: USD totalPaid: '0' totalSelected: '100' dimensions: department: id: null name: null location: id: '1' name: United States of America customer: key: null id: null name: null vendor: key: '17' id: VEN-0019 name: EC href: /objects/accounts-payable/vendor/17 employee: key: null id: null name: null item: key: null id: null name: null class: key: null id: null name: null description: Invoice for development in March 2022 exchangeRate: date: '2022-07-21' typeId: null rate: '1' lineNumber: '1' paymentLineRecord: pp baseLocation: '1' audit: createdDateTime: '2022-07-21T10:00:13Z' modifiedDateTime: '2022-07-21T10:00:13Z' createdBy: '1' modifiedBy: '1' taxDetail: id: null key: null isTax: false href: /objects/accounts-payable/payment-line/3936 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/payment-detail: get: summary: List payment details description: >- Returns a collection with a key, ID, and link for each payment detail. 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: - Accounts_Payable_Payment details operationId: list-accounts-payable-payment-detail responses: '200': description: OK content: application/json: schema: type: object title: List of payment detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List payment details: value: ia::result: - key: '367' id: '367' href: /objects/accounts-payable/payment-detail/367 - key: '1043' id: '1043' href: /objects/accounts-payable/payment-detail/1043 - key: '1203' id: '1203' href: /objects/accounts-payable/payment-detail/1203 ia::meta: totalCount: 509 start: 1 pageSize: 100 next: 101 previous: null '201': description: Created '400': $ref: '#/components/responses/400error' '401': description: Unauthorized security: - OAuth2: [] /objects/accounts-payable/payment-detail/{key}: parameters: - name: key description: System-assigned key for the payment detail. in: path required: true schema: type: string get: summary: Get payment details description: Returns detailed information for a specified payment detail object. tags: - Accounts_Payable_Payment details operationId: get-accounts-payable-payment-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the payment detail properties: ia::result: $ref: '#/components/schemas/accounts-payable-payment-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a payment detail object: value: ia::result: id: '1133' key: '1133' bill: id: '2570' key: '2570' href: /objects/accounts-payable/bill/2570 billLine: id: '25392' key: '25392' href: /objects/accounts-payable/bill-line/25392 apCreditAdjustment: id: '25394' key: '25394' href: /objects/accounts-payable/adjustment/25394 apCreditAdjustmentLine: id: '25394' key: '25394' href: /objects/accounts-payable/adjustment-line/25394 apPayment: id: '3346' key: '3346' href: /objects/accounts-payable/payment/3346 apPaymentLine: id: '31060' key: '31060' href: /objects/accounts-payable/payment-line/31060 paymentDate: '2023-04-12' baseCurrency: paymentAmount: '100' inlineAmount: null discountAmount: null adjustmentAmount: null postedAdvanceAmount: null txnCurrency: paymentAmount: '100' inlineAmount: '10' discountAmount: '10' adjustmentAmount: '10' postedAdvanceAmount: '10' currency: USD inlineBill: id: '25394' key: '25394' href: /objects/accounts-payable/bill/25394 inlineBillLine: id: '25394' key: '25394' href: /objects/accounts-payable/bill-line/25394 apDiscount: id: '25394' key: '25394' href: /objects/accounts-payable/discount/25394 apDiscountLine: id: '25394' key: '25394' href: /objects/accounts-payable/discount-line/25394 discountDate: '2023' apDebitAdjustment: id: '25394' key: '25394' href: /objects/accounts-payable/adjustment/25394 apDebitAdjustmentLine: id: '25394' key: '25394' href: /objects/accounts-payable/adjustment-line/25394 apAdvance: id: '25394' key: '25394' href: /objects/accounts-payable/advance/25394 apAdvanceLine: id: '25394' key: '25394' href: /objects/accounts-payable/advance-line/25394 apPostedAdvance: id: '25394' key: '25394' href: /objects/accounts-payable/advance/25394 apPostedAdvanceLine: id: '25394' key: '25394' href: /objects/accounts-payable/advance-line/25394 state: C moduleKey: 3.AP audit: createdDateTime: '2023-04-12T07:05:13Z' modifiedDateTime: '2023-04-12T07:05:13Z' createdBy: '71' modifiedBy: '71' href: /objects/accounts-payable/payment-detail/1133 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/summary: get: summary: List summaries description: Returns a collection with a key, ID, and link for each summary. tags: - Accounts_Payable_Summaries operationId: list-accounts-payable-summary responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: type: array items: type: object properties: key: type: string id: type: string href: type: string ia::meta: type: object properties: totalCount: type: integer start: type: integer pageSize: type: integer next: type: integer previous: type: integer examples: List summaries: value: ia::result: - key: '36' id: '36' href: /objects/accounts-payable/summary/36 - key: '43' id: '43' href: /objects/accounts-payable/summary/43 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a summary description: Creates a new summary. tags: - Accounts_Payable_Summaries operationId: create-accounts-payable-summary requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-summary' - $ref: '#/components/schemas/accounts-payable-summaryRequiredProperties' examples: Create a new summary: value: name: Jan Batch 2021 glPostingDate: '2023-08-04' status: active recordType: apBill responses: '201': description: Created content: application/json: schema: type: object title: New summary properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Example 1: value: ia::result: key: '56' id: '56' href: string ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/summary/{key}: parameters: - name: key description: System-assigned unique key for the summary. in: path required: true schema: type: string get: summary: Get a summary description: Returns detailed information for a specified summary. tags: - Accounts_Payable_Summaries operationId: get-accounts-payable-summary-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the summary properties: ia::result: $ref: '#/components/schemas/accounts-payable-summary' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the summary: value: ia::result: id: '36' key: '36' name: 'Bills: 2022/08/02 Batch' glPostingDate: 08/02/2022 status: active recordType: apBill totalAmount: '100.23' state: open parent: id: null key: null preventGLPosting: null bankAccountId: id: null key: null summaryCreationType: Auto-Summary isQuickPaymentSummary: false href: /objects/accounts-payable/summary/36 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a summary description: >- Updates an existing summary by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Payable_Summaries operationId: update-accounts-payable-summary-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-summary' - type: object properties: id: readOnly: true examples: Updates a summary: value: name: Batch From Sep To Oct 2023 glPostingDate: 09/01/2023 status: active description: '' responses: '200': description: OK content: application/json: schema: type: object title: Updated summary properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated summary: value: ia::result: id: '50' key: '50' href: /objects/accounts-payable/summary/50 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a summary description: Deletes a summary. tags: - Accounts_Payable_Summaries operationId: delete-accounts-payable-summary-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/recurring-bill: get: summary: List recurring bills description: Returns a collection with a key, ID, and link for each recurring bill. tags: - Accounts_Payable_Recurring bills operationId: list-accounts-payable-recurring-bill responses: '200': description: OK content: application/json: schema: type: object title: List recurring bill objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List recurring bills: value: ia::result: - key: '1' id: Adjustment Increase href: /objects/accounts-payable/recurring-bill/1 - key: '2' id: Adjustment Increase href: /objects/accounts-payable/recurring-bill/2 - key: '3' id: Bill href: /objects/accounts-payable/recurring-bill/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a recurring bill description: Creates a new recurring bill. tags: - Accounts_Payable_Recurring bills operationId: create-accounts-payable-recurring-bill requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-recurring-bill' - $ref: '#/components/schemas/accounts-payable-recurring-billRequiredProperties' examples: Create a recurring bill: value: id: Invoice description: DNO Recurring Bill 001 schedule: startDate: '2024-03-21' repeatBy: days repeatInterval: '1' endDate: '2024-03-29' term: id: N15 referenceNumber: DNO Recurr bill status: active contract: id: '128' description: DNO contract vendor: id: 1099 Int currency: baseCurrency: USD txnCurrency: USD exchangeRate: date: '2022-02-21' typeId: Intacct Daily Rate rate: 1.0679 lines: - memo: DNO Recurring Bill line 01 glAccount: id: '6000' baseAmount: '150' dimensions: location: id: '1' department: id: '11' project: id: '8' customer: id: '1' vendor: id: 1099 Int employee: id: '1' item: id: '1' class: id: '3' hasForm1099: false accountLabel: id: null currency: txnCurrency: USD baseCurrency: AUD txnAmount: '120.00' - memo: DNO Recurring Bill line 02 glAccount: id: '6000' baseAmount: '110' dimensions: location: id: '1' department: id: '11' project: id: '8' customer: id: '1' vendor: id: 1099 Int employee: id: '1' item: id: '1' class: id: '3' hasForm1099: false accountLabel: id: null currency: txnCurrency: USD baseCurrency: AUD txnAmount: '130.00' responses: '201': description: Created content: application/json: schema: type: object title: New recurring bill properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New recurring bill: value: ia::result: key: '5' id: '5' href: /objects/accounts-payable/recurring-bill/5 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/recurring-bill/{key}: parameters: - name: key description: System assigned unique key for the recurring bill. in: path required: true schema: type: string get: summary: Get a recurring bill description: Returns detailed information for a particular recurring bill. tags: - Accounts_Payable_Recurring bills operationId: get-accounts-payable-recurring-bill-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the recurring bill properties: ia::result: $ref: '#/components/schemas/accounts-payable-recurring-bill' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the recurring bill: value: ia::result: key: '1' description: DNO Recurring Bill audit: createdDateTime: '2024-03-20T00:00:00Z' modifiedDateTime: '2024-03-20T11:38:13Z' createdBy: '1' modifiedBy: '1' term: key: '8' id: N15 href: /objects/accounts-payable/term/8 id: Invoice totalEntered: '337.02' referenceNumber: DNO Recurr bill moduleKey: 3.AP status: active recurringSchedule: id: '1' key: '1' href: /objects/core/schedule/1 contract: id: '128' description: DNO contract vendor: id: 1099 Int name: 1099 Int key: '43' href: /objects/accounts-payable/vendor/43 currency: txnCurrency: USD baseCurrency: AUD txnTotalEntered: '220.00' lines: - id: '1' key: '1' recurringBill: id: '1' key: '1' href: /objects/accounts-payable/recurring-bill/1 memo: DNO Recurring Bill glAccount: key: '246' id: '6000' name: G&A Salaries href: /objects/general-ledger/account/246 baseAmount: '183.83' dimensions: location: id: '1' name: United States of America department: id: '11' name: Accounting project: key: '8' id: '8' name: Client Services - Power Aerospace Materials href: /objects/projects/project/8 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 class: key: '1' id: '3' name: Heath Care href: /objects/company-config/class/1 lineNumber: '0' hasForm1099: false accountLabel: id: null currency: txnCurrency: USD baseCurrency: AUD txnAmount: '120.00' audit: createdDateTime: '2024-03-20T11:38:13Z' modifiedDateTime: '2024-03-20T11:38:13Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-payable/recurring-bill-line/1 - id: '2' key: '2' recurringBill: id: '1' key: '1' href: /objects/accounts-payable/recurring-bill/1 memo: DNO Recurring Bill glAccount: key: '246' id: '6000' name: G&A Salaries href: /objects/general-ledger/account/246 baseAmount: '153.19' dimensions: location: id: '1' name: United States of America department: id: '11' name: Accounting project: key: '8' id: '8' name: Client Services - Power Aerospace Materials href: /objects/projects/project/8 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 class: key: '1' id: '3' name: Heath Care href: /objects/company-config/class/1 lineNumber: '1' hasForm1099: false accountLabel: id: null currency: txnCurrency: USD baseCurrency: AUD txnAmount: '100.00' audit: createdDateTime: '2024-03-20T11:38:13Z' modifiedDateTime: '2024-03-20T11:38:13Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-payable/recurring-bill-line/2 href: /objects/accounts-payable/recurring-bill/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a recurring bill description: >- Updates an existing recurring bill by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Payable_Recurring bills operationId: update-accounts-payable-recurring-bill-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-recurring-bill' - type: object properties: id: readOnly: true examples: Update a recurring bill: value: description: New payouts recurring bill responses: '200': description: OK content: application/json: schema: type: object title: Updated recurring bill properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated recurring bill: value: ia::result: key: '5' id: '5' href: /objects/accounts-payable/recurring-bill/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a recurring bill description: Deletes a recurring bill with given key. tags: - Accounts_Payable_Recurring bills operationId: delete-accounts-payable-recurring-bill-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/recurring-bill-line: get: summary: List recurring bill lines description: >- Returns a collection with a key, ID, and link for each recurring bill line. tags: - Accounts_Payable_Recurring bill lines operationId: list-accounts-payable-recurring-bill-line responses: '200': description: OK content: application/json: schema: type: object title: List of recurring bill line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List recurring bill lines: value: ia::result: - key: '1' id: '1' href: /objects/accounts-payable/recurring-bill-line/1 - key: '4' id: '4' href: /objects/accounts-payable/recurring-bill-line/4 - key: '7' id: '7' href: /objects/accounts-payable/recurring-bill-line/7 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/recurring-bill-line/{key}: parameters: - name: key description: System assigned unique key for the recurring bill line. in: path required: true schema: type: string get: summary: Get a recurring bill line description: Returns detailed information for a specified recurring bill line. tags: - Accounts_Payable_Recurring bill lines operationId: get-accounts-payable-recurring-bill-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the recurring bill line properties: ia::result: $ref: '#/components/schemas/accounts-payable-recurring-bill-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the recurring bill line: value: ia::result: key: '1' description: DNO Recurringf Bill audit: createdDateTime: '2024-03-20T00:00:00Z' modifiedDateTime: '2024-03-20T11:38:13Z' createdBy: '1' modifiedBy: '1' term: key: '8' id: N15 href: /objects/accounts-payable/term/8 id: Invoice totalEntered: '337.02' referenceNumber: DNO Recurr bill moduleKey: 3.AP status: active recurringSchedule: id: '1' key: '1' href: /objects/core/schedule/1 contract: id: '128' description: DNO contract vendor: id: 1099 Int name: 1099 Int key: '43' href: /objects/accounts-payable/vendor/43 currency: txnCurrency: USD baseCurrency: AUD txnTotalEntered: '220.00' schedule: startDate: '2024-03-21' endDate: null nextExecutionDate: '2024-03-21' lastExecutionDate: null recurringDueDate: '2024-03-21' frequency: days executionCount: 0 repeatCount: 10 repeatBy: days repeatInterval: '1' lines: - id: '1' key: '1' recurringBill: id: '1' key: '1' href: /objects/accounts-payable/recurring-bill/1 memo: DNO Recurringf Bill glAccount: key: '246' id: '6000' name: G&A Salaries href: /objects/general-ledger/account/246 baseAmount: '183.83' dimensions: location: id: '1' name: United States of America department: id: '11' name: Accounting project: key: '8' id: '8' name: Client Services - Power Aerospace Materials href: /objects/projects/project/8 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 class: key: '1' id: '3' name: Heath Care href: /objects/company-config/class/1 lineNumber: 0 hasForm1099: 'false' form1099: type: null box: null accountLabel: id: null currency: txnCurrency: USD baseCurrency: AUD txnAmount: '120.00' allocation: id: null key: null name: null isBillable: null audit: createdDateTime: '2024-03-20T11:38:13Z' modifiedDateTime: '2024-03-20T11:38:13Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-payable/recurring-bill-line/1 - id: '2' key: '2' recurringBill: id: '1' key: '1' href: /objects/accounts-payable/recurring-bill/1 memo: DNO Recurringf Bill glAccount: key: '246' id: '6000' name: G&A Salaries href: /objects/general-ledger/account/246 baseAmount: '153.19' dimensions: location: id: '1' name: United States of America department: id: '11' name: Accounting project: key: '8' id: '8' name: Client Services - Power Aerospace Materials href: /objects/projects/project/8 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 class: key: '1' id: '3' name: Heath Care href: /objects/company-config/class/1 lineNumber: 1 form1099: isForm1099: 'false' type: null box: null accountLabel: id: null currency: txnCurrency: USD baseCurrency: AUD txnAmount: '100.00' allocation: id: null key: null name: null isBillable: null audit: createdDateTime: '2024-03-20T11:38:13Z' modifiedDateTime: '2024-03-20T11:38:13Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-payable/recurring-bill-line/2 href: /objects/accounts-payable/recurring-bill/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/vendor-contact: get: summary: List vendor contacts description: >- Returns a collection with a key, ID, and link for each vendor contact. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. operationId: list-accounts-payable-vendor-contact tags: - Accounts_Payable_Vendor contacts responses: '200': description: OK content: application/json: schema: type: object title: List of vendor-contact objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Example 1: value: ia::result: - key: '17' id: '17' href: /objects/accounts-payable/vendor-contact/17 - key: '18' id: '18' href: /objects/accounts-payable/vendor-contact/18 - key: '19' id: '19' href: /objects/accounts-payable/vendor-contact/19 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 101 previous: null security: - OAuth2: [] post: summary: Create a vendor contact operationId: create-accounts-payable-vendor-contact-key description: Creates a new vendor contact. tags: - Accounts_Payable_Vendor contacts responses: '200': description: OK requestBody: content: application/json: schema: type: object properties: {} examples: Example 1: value: categoryName: home8 vendor: key: '43' contact: key: '202' description: '' security: - OAuth2: [] /objects/accounts-payable/vendor-contact/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the vendor contact. example: '1' get: summary: Get a vendor contact description: Returns detailed information for a specified vendor contact. operationId: get-accounts-payable-vendor-contact-key tags: - Accounts_Payable_Vendor contacts responses: '200': description: OK content: application/json: schema: type: object title: Details of the vendor-contact properties: ia::result: $ref: '#/components/schemas/accounts-payable-vendor-contact' ia::meta: $ref: '#/components/schemas/metadata' examples: Example 1: value: ia::result: key: '1' id: '1' categoryName: Main Office contact: key: '197' id: Jeffrey Palms audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' vendor: key: '15' id: VPACBELL ia::meta: totalCount: 1 security: - OAuth2: [] patch: summary: Update a vendor contact operationId: update-accounts-payable-vendor-contact-key description: >- Updates an existing vendor contact by setting field values. Any fields not provided remain unchanged. Changing a vendor contact only affects future transactions. tags: - Accounts_Payable_Vendor contacts responses: '200': description: OK requestBody: content: application/json: schema: type: object properties: {} examples: Example 1: value: contact: key: '202' security: - OAuth2: [] delete: summary: Delete a vendor contact operationId: delete-accounts-payable-vendor-contact-key description: Deletes a vendor contact. tags: - Accounts_Payable_Vendor contacts responses: '200': description: OK security: - OAuth2: [] /objects/accounts-payable/vendor-email-template: get: summary: List vendor email templates description: >- Returns a collection with a key, ID, and link for each vendor email template. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. operationId: list-accounts-payable-vendor-email-template tags: - Accounts_Payable_Vendor email templates responses: '200': description: OK content: application/json: schema: type: object title: List of vendor-email-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List vendor email templates: value: ia::result: - key: '2' id: '2' href: /objects/accounts-payable/vendor-email-template/2 - key: '3' id: '3' href: /objects/accounts-payable/vendor-email-template/3 - key: '4' id: '4' href: /objects/accounts-payable/vendor-email-template/4 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a vendor email template operationId: create-accounts-payable-vendor-email-template description: Creates a vendor email template. tags: - Accounts_Payable_Vendor email templates requestBody: required: true content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/accounts-payable-vendor-email-template' - $ref: '#/components/schemas/accounts-payable-vendor-email-templateRequiredProperties' examples: Create a vendor-email-template: value: vendor: key: '127' txnDefinitionName: Vendor Invoice emailTemplate: key: '1' name: Vendor Trial responses: '200': description: OK content: application/json: schema: type: object title: Creates a new vendor email template. properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a vendor-email-template: value: ia::result: key: '1' id: V0504 href: /objects/accounts-payable/vendor-email-template/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/vendor-email-template/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned unique key for the vendor email template. example: '2' get: summary: Get a vendor email template description: Returns detailed information for a specified vendor email template. operationId: get-accounts-payable-vendor-email-template-key tags: - Accounts_Payable_Vendor email templates responses: '200': description: OK content: application/json: schema: type: object title: Details of the vendor-email-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a vendor email template: value: ia::result: id: '1' key: '1' vendor: key: '127' id: '014' href: /objects/accounts-payable/vendor/127 txnDefinitionName: Vendor Invoice emailTemplate: id: '1' key: '1' name: Vendor Trial href: /objects/company-config/email-template/1 href: /objects/accounts-payable/vendor-email-template/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a vendor email template operationId: update-accounts-payable-vendor-email-template-key description: >- Updates an existing vendor email template by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Payable_Vendor email templates requestBody: content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/accounts-payable-vendor-email-template' examples: Update a vendor-email-template: value: vendor: key: '127' txnDefinitionName: PO Return emailTemplate: key: '2' name: Purchasing Trial responses: '200': description: OK content: application/json: schema: type: object title: Updates a vendor email template. properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a vendor-email-template: value: ia::result: key: '1' id: '014' href: /objects/accounts-payable/vendor-email-template/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a vendor email template operationId: delete-accounts-payable-vendor-email-template-key responses: '200': description: OK description: Deletes a vendor email template. tags: - Accounts_Payable_Vendor email templates security: - OAuth2: [] /objects/accounts-payable/vendor-account-group/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the vendor account group. example: 1 get: summary: Get a vendor account group description: Returns detailed information for a specified vendor account group. tags: - Accounts_Payable_Vendor account groups responses: '200': description: OK content: application/json: schema: type: object title: Details of the vendor account group properties: ia::result: $ref: '#/components/schemas/accounts-payable-vendor-account-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a vendor account group: value: ia::result: id: HW VGL Group key: '1' groupType: vendor status: inactive href: /objects/accounts-payable/vendor-account-group/1 ia::meta: totalCount: 1 '404': description: vendor-account-group Not Found operationId: get-accounts-payable-vendor-account-group-key security: - OAuth2: [] delete: summary: Delete a vendor account group description: Deletes a vendor account group. tags: - Accounts_Payable_Vendor account groups operationId: delete-accounts-payable-vendor-account-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a vendor account group operationId: update-accounts-payable-vendor-account-group-key description: >- Updates an existing vendor account group by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Payable_Vendor account groups responses: '200': description: OK content: application/json: schema: type: object title: Updated vendor-account-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a vendor account group: value: ia::result: key: '18' id: 1099 Vendor Group href: /objects/accounts-payable/vendor-account-group/18 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-vendor-account-group' - type: object properties: id: readOnly: true examples: Update a vendor account group: value: status: inactive security: - OAuth2: [] /objects/accounts-payable/vendor-account-group: get: summary: List vendor account groups tags: - Accounts_Payable_Vendor account groups responses: '200': description: OK content: application/json: schema: type: object title: List of vendor-account-group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List vendor account groups: value: ia::result: - key: '1' id: HW VGL Group href: /objects/accounts-payable/vendor-account-group/1 - key: '2' id: OS VGL Group href: /objects/accounts-payable/vendor-account-group/2 - key: '3' id: Stationary VGL Group href: /objects/accounts-payable/vendor-account-group/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' operationId: list-accounts-payable-vendor-account-group description: >- Returns a collection with a key, ID, and link for each vendor account group. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. security: - OAuth2: [] post: summary: Create a vendor account group tags: - Accounts_Payable_Vendor account groups operationId: create-accounts-payable-vendor-account-group responses: '201': description: Created content: application/json: schema: type: object title: New vendor-account-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a vendor account group: value: ia::result: key: '18' id: 1099 Vendor Group href: /objects/accounts-payable/vendor-account-group/18 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' description: Creates a new vendor account group. requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-payable-vendor-account-group' - $ref: '#/components/schemas/vendorAccountGroupRequiredProperties' examples: example-create-vendor-account-group: value: id: 1099 Vendor Group groupType: vendor status: active security: - OAuth2: [] /objects/accounts-payable/vendor-account-number: get: summary: List vendor account numbers description: >- Returns up to 100 object references from the collection with a key, ID, and link for each vendor account number. 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: - Accounts_Payable_Vendor account numbers operationId: list-accounts-payable-vendor-account-number responses: '200': description: OK content: application/json: schema: type: object title: List vendor-account-number objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Example 1: value: ia::result: - key: '1' id: '1' href: /objects/accounts-payable/vendor-account-number/1 - key: '2' id: '2' href: /objects/accounts-payable/vendor-account-number/2 - key: '3' id: '3' href: /objects/accounts-payable/vendor-account-number/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a vendor account number operationId: create-accounts-payable-vendor-account-number description: Creates a new vendor account number. tags: - Accounts_Payable_Vendor account numbers requestBody: required: true content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/accounts-payable-vendor-account-number' - $ref: '#/components/schemas/accounts-payable-vendor-account-numberRequiredProperties' examples: Example 1: value: location: key: '2' vendor: key: '127' vendorAccountNumber: '1234567555' responses: '200': description: OK security: - OAuth2: [] /objects/accounts-payable/vendor-account-number/{key}: parameters: - name: key description: System-assigned key for the vendor account number. in: path required: true schema: type: string example: '1' get: summary: Get a vendor account number description: Returns detailed information for a specified vendor account number. tags: - Accounts_Payable_Vendor account numbers operationId: get-accounts-payable-vendor-account-number-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the vendor-account-number properties: ia::result: $ref: '#/components/schemas/accounts-payable-vendor-account-number' ia::meta: $ref: '#/components/schemas/metadata' examples: Example 1: value: ia::result: key: '7' id: '7' location: key: '11' id: '11' name: United States of America href: /objects/company-config/location/1 vendorAccountNumber: VAN-5134986722 href: /objects/accounts-payable/vendor-account-number/1 vendor: key: '33' id: '33' href: /objects/accounts-payable/vendor/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a vendor account number description: >- Updates an existing vendor account number by setting field values. Any fields not provided remain unchanged. operationId: update-accounts-payable-vendor-account-number tags: - Accounts_Payable_Vendor account numbers requestBody: content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/accounts-payable-vendor-account-number' - type: object properties: id: readOnly: true examples: Example 1: value: vendorAccountNumber: '1234567888' responses: '200': description: OK content: application/json: schema: type: object title: Updated vendor-account-number properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Example 1: value: ia::result: key: '2' id: '2' href: /objects/accounts-payable/vendor-account-number/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a vendor account number description: Deletes a vendor account number. operationId: delete-accounts-payable-vendor-account-number tags: - Accounts_Payable_Vendor account numbers responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/vendor-bank-file-setup: get: summary: List vendor bank file setup objects description: >- Returns a collection with a key, ID, and link for each vendor bank file setup. This operation is mostly for use in testing. Use query to fnd objects that meet certain criteria and to specify properties that are returned. tags: - Accounts_Payable_Vendor bank file setups operationId: list-accounts-payable-vendor-bank-file-setup responses: '200': description: OK content: application/json: schema: type: object title: List of vendor-bank-file-setup objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List vendor bank file payments: value: ia::result: - key: '25' id: '25' href: /objects/accounts-payable/vendor-bank-file-setup/25 - key: '85' id: '85' href: /objects/accounts-payable/vendor-bank-file-setup/85 - key: '60' id: '60' href: /objects/accounts-payable/vendor-bank-file-setup/60 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-payable/vendor-bank-file-setup/{key}: parameters: - name: key description: System-assigned key for the vendor bank file setup. in: path required: true schema: type: string get: summary: Get a vendor bank file setup description: Returns detailed information for a specified vendor bank file setup. tags: - Accounts_Payable_Vendor bank file setups operationId: get-accounts-payable-vendor-bank-file-setup-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the vendor-bank-file-setup properties: ia::result: $ref: '#/components/schemas/accounts-payable-vendor-bank-file-setup' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bank file setup for South Africa (ZA): value: ia::result: key: '25' id: '25' vendor: key: '202' id: SAVendor href: /objects/accounts-payable/vendor/202 bsbNumber: null paymentReference: Supplier Inc sortCode: null branchCode: '123433' bankAccountType: '1' bankAccountCode: '345678' proofOfPayment: true bankAccountNumber: '87402896' bankAccountName: Jane Blogs Corp businessIdCode: null href: /objects/accounts-payable/vendor-bank-file-setup/25 ia::meta: totalCount: 1 Get a bank file setup for Australia (AU): value: ia::result: key: '2' id: '2' vendor: key: '162' id: AUVendor href: /objects/accounts-payable/vendor/162 bsbNumber: 163-821 paymentReference: Supplier Inc sortCode: null branchCode: null bankAccountType: null bankAccountCode: null proofOfPayment: null bankAccountNumber: '87402896' bankAccountName: Au Bank Corp businessIdCode: null href: /objects/accounts-payable/vendor-bank-file-setup/2 ia::meta: totalCount: 1 Get a bank file setup for United Kingdom (GB): value: ia::result: key: '26' id: '26' vendor: key: '203' id: UKVendor href: /objects/accounts-payable/vendor/203 bsbNumber: null paymentReference: BACS HSBC corp sortCode: '849571' branchCode: null bankAccountType: null bankAccountCode: null proofOfPayment: null bankAccountNumber: '87402896' bankAccountName: UK Bank Corp. businessIdCode: null href: /objects/accounts-payable/vendor-bank-file-setup/26 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice: get: summary: List invoices description: >+ Returns a collection with a key, ID, and link for each invoice. 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
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsList, View Invoices
tags: - Accounts_Receivable_Invoices operationId: list-accounts-receivable-invoice responses: '200': description: OK content: application/json: schema: type: object title: List of invoice objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List invoices: value: ia::result: - key: '498' id: '498' href: /objects/accounts-receivable/invoice/498 - key: '501' id: '501' href: /objects/accounts-receivable/invoice/501 - key: '978' id: '978' href: /objects/accounts-receivable/invoice/978 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an invoice description: >+ Creates a new invoice. For the invoice to be posted, you must specify at least the account and an amount for each line item.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsAdd Invoices
tags: - Accounts_Receivable_Invoices operationId: create-accounts-receivable-invoice requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-invoice' - $ref: '#/components/schemas/accounts-receivable-invoiceRequiredProperties' examples: Create an invoice: value: invoiceNumber: SI-0034 customer: id: C-00019 customerMessageId: Greeting01 referenceNumber: B9R456 description: Regular invoice term: id: N15 invoiceDate: '2022-12-06' dueDate: '2022-12-31' currency: txnCurrency: USD exchangeRate: date: '2022-12-06' typeId: Intacct Daily Rate rate: 0.05112 contacts: payTo: id: Power Aerospace Materials(C1) returnTo: id: Power Aerospace Materials(C1) lines: - txnAmount: '100.40' glAccount: id: '5004' accountLabel: id: SWL001 dimensions: department: id: SA location: id: CA customer: id: '1652' - txnAmount: '-10' glAccount: id: '5004' accountLabel: id: SWL001 dimensions: department: id: SA location: id: CA customer: id: '1652' responses: '201': description: Created content: application/json: schema: type: object title: New invoice properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New invoice: value: ia::result: id: '2091' key: '2091' href: /objects/accounts-receivable/invoice/2091 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice/{key}: parameters: - name: key description: System-assigned key for the invoice. in: path required: true schema: type: string get: summary: Get an invoice description: >+ Returns detailed information for a specified invoice.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsList, View Invoices
tags: - Accounts_Receivable_Invoices operationId: get-accounts-receivable-invoice-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the invoice properties: ia::result: $ref: '#/components/schemas/accounts-receivable-invoice' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an invoice: value: ia::result: id: '2091' key: '2091' recordType: ri invoiceNumber: newInv10 state: posted customer: id: C-00019 key: '14' name: Power Aerospace Materials emailOption: false customerDue: '20106.8' deliveryOptions: print href: /objects/accounts-receivable/customer/14 customerMessageId: Greeting01 customerMessage: Thank your for your business. referenceNumber: B9R456 description: Regular invoice orderEntry: documentId: Sales Invoice B9-R456 term: id: N15 key: '1' href: /objects/accounts-receivable/term/1 invoiceDate: '2022-12-06' audit: createdDateTime: '2022-12-06T00:00:00Z' modifiedDateTime: '2023-04-18T16:59:05Z' createdBy: '1' modifiedBy: '1' invoiceSummary: glPostingDate: '2022-12-06' title: 'Invoices: 2023/03/21 22:04:36:8980 Batch' key: '854' id: '854' isSummaryOpen: open isSummaryPosted: 'false' discountCutOffDate: '2022-12-13' dueDate: '2022-12-31' paymentInformation: fullyPaidDate: null totalBaseAmountSelectedForPayment: '0' totalBaseAmountPaid: '0' totalTxnAmountSelectedForPayment: '0' totalTxnAmountPaid: '0' currency: baseCurrency: USD txnCurrency: MXN exchangeRate: date: '2022-12-06' typeId: Intacct Daily Rate rate: 0.05112 totalBaseAmount: '4.62' totalBaseAmountDue: '4.62' totalTxnAmount: '90.4' totalTxnAmountDue: '90.4' contacts: payTo: id: Power Aerospace Materials(C1) key: '725' returnTo: id: Power Aerospace Materials(C1) key: '725' moduleKey: accountsReceivable recurringSchedule: key: '20' isSystemGeneratedDocument: false billbackTemplate: id: BBT-error5 key: '18' dueInDays: 108 attachment: id: '11' key: '11' dunningCount: 0 lines: - id: '4338' key: '4338' invoice: id: '2091' key: '2091' href: /objects/accounts-receivable/invoice/2091 glAccount: key: '218' id: '5004' name: Commissions Paid href: /objects/gl-account/218 overrideOffsetGLAccount: key: '36' id: '1200' name: Accounts Receivable href: /objects/general-ledger/account/36 accountLabel: name: Commissions Paid key: '14' id: Accounts Receivable - Microcomputer createdDate: '2022-12-06' baseAmount: '5.13' txnAmount: '100.40' dimensions: department: key: '31' id: SA name: Sales href: /objects/company-config/department/31 location: key: '10' id: North America name: North America href: /objects/company-config/location/10 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/company-config/customer/1 baseLocation: name: North America key: '10' href: /objects/company-config/location/10 memo: hello line 1 currency: exchangeRate: date: '2022-06-12' typeId: '-1' rate: 0.05112 txnCurrency: MXN baseCurrency: USD allocation: id: '22' key: '22' name: Premium allocation lineNumber: 1 paymentInformation: totalBaseAmountPaid: '.51' totalTxnAmountPaid: '10' totalBaseAmountSelectedForPayment: '0' totalTxnAmountSelectedForPayment: '0' isSubtotal: null audit: createdDateTime: '2023-04-18T16:54:13Z' modifiedDateTime: '2023-04-18T16:59:05Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/invoice-line/4338 - id: '4340' key: '4340' invoice: id: '2091' key: '2091' href: /objects/accounts-receivable/invoice/2091 glAccount: key: '218' id: '5004' name: Commissions Paid href: /objects/gl-account/218 overrideOffsetGLAccount: key: '36' id: '1200' name: Accounts Receivable href: /objects/gl-account/36 accountLabel: name: Commissions Paid key: '14' id: Accounts Receivable - Microcomputer createdDate: '2022-12-06' baseAmount: '-.51' txnAmount: '-10.00' dimensions: department: key: '31' id: SA name: Sales href: /objects/department/31 location: key: '10' id: North America name: North America href: /objects/location/10 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/customer/1 baseLocation: name: North America key: '10' href: /objects/location/10 memo: Current Q1 charges currency: exchangeRate: date: '2022-06-12' typeId: '-1' rate: 0.05112 txnCurrency: MXN baseCurrency: USD allocation: id: '22' key: '22' name: Premium allocation lineNumber: 2 paymentInformation: totalBaseAmountPaid: '-.51' totalTxnAmountPaid: '-10' totalBaseAmountSelectedForPayment: '0' totalTxnAmountSelectedForPayment: '0' isSubtotal: null audit: createdDateTime: '2023-04-18T16:54:13Z' modifiedDateTime: '2023-04-18T16:59:05Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/invoice-line/4340 href: /objects/accounts-receivable/invoice/2091 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an invoice description: >+ Updates an existing invoice by setting field values. Any fields not provided remain unchanged. Allowed edits depend on the state an invoice is in. For more information, see [About editing invoices](https://www.intacct.com/ia/docs/en_US/help_action/Accounts_Receivable/Invoices/Tasks/edit-an-invoice-overview.htm).
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsEdit Invoices
tags: - Accounts_Receivable_Invoices operationId: update-accounts-receivable-invoice-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-invoice' - type: object properties: id: readOnly: true examples: Update a single value: value: description: Special off-cycle order responses: '200': description: OK content: application/json: schema: type: object title: Updated invoice properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: id: '2091' key: '2091' href: /objects/accounts-receivable/invoice/2091 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an invoice description: >+ Deletes an invoice. Only invoices with a `draft` or `posted` state can be deleted.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsDelete Invoices
tags: - Accounts_Receivable_Invoices operationId: delete-accounts-receivable-invoice-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice-line: get: summary: List invoice lines description: >+ Returns a collection with a key, ID, and link for each invoice line item. 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
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsList, View Invoices
tags: - Accounts_Receivable_Invoice lines operationId: list-accounts-receivable-invoice-line responses: '200': description: OK content: application/json: schema: type: object title: List of invoice line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List invoice lines: value: ia::result: - key: '1' id: '1' href: /objects/accounts-receivable/invoice-line/1 - key: '3' id: '3' href: /objects/accounts-receivable/invoice-line/3 - key: '19' id: '19' href: /objects/accounts-receivable/invoice-line/19 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice-line/{key}: parameters: - name: key description: System-assigned unique key for the invoice line item. in: path required: true schema: type: string get: summary: Get an invoice line description: >+ Returns detailed information for a specified invoice line item.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsList, View Invoices
tags: - Accounts_Receivable_Invoice lines operationId: get-accounts-receivable-invoice-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the invoice line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-invoice-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an invoice line: value: ia::result: id: '1' key: '1' invoice: id: '6' key: '6' href: /objects/accounts-receivable/invoice/6 glAccount: key: '194' id: '4000' name: Sales href: /objects/general-ledger/account/194 overrideOffsetGLAccount: key: '36' id: '1200' name: Accounts Receivable href: /objects/general-ledger/account/36 accountLabel: name: Sales key: '35' id: Sales href: /objects/accounts-receivable/account-label/35 createdDate: '2022-04-20' baseAmount: '24115.65' txnAmount: '16740.00' dimensions: department: key: '1' id: '01' name: Sales href: objects/company-config/department/1 location: key: '19' id: CA name: California href: /objects/company-config/location/19 customer: key: '11' id: '11' name: Power Aerospace Materials href: /objects/company-config/customer/11 baseLocation: name: United States of America key: '1' href: /objects/company-config/location/1 memo: Replaces discontinued part currency: exchangeRate: date: '2022-01-23' typeId: '-1' rate: 1.4406 txnCurrency: EUR baseCurrency: USD allocation: id: null key: null name: null lineNumber: 1 paymentInformation: totalBaseAmountPaid: '35' totalTxnAmountPaid: '35' totalBaseAmountSelectedForPayment: '0' totalTxnAmountSelectedForPayment: '0' isSubtotal: null audit: createdDateTime: '2022-04-21T09:37:41Z' modifiedDateTime: '2022-11-22T05:11:50Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/invoice-line/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/account-label: get: summary: List account labels description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each label. 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
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View AR Account Labels
tags: - Accounts_Receivable_Account labels operationId: list-accounts-receivable-account-label responses: '200': description: OK content: application/json: schema: type: object title: List of ar-account-label objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List account labels: value: ia::result: - key: '9' id: Retail Sales href: /objects/accounts-receivable/account-label/9 - key: '41' id: Retail Sales 2 href: /objects/accounts-receivable/account-label/41 - key: '10' id: Sales href: /objects/accounts-receivable/account-label/10 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an account label description: >+ Creates a new AR account label.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Add AR Account Labels
tags: - Accounts_Receivable_Account labels operationId: create-accounts-receivable-account-label requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-account-label' - $ref: '#/components/schemas/accounts-receivable-account-labelRequiredProperties' examples: Create an account label: value: id: Wholesale Sales description: Wholesale sales north america glAccount: id: '2050' status: active offsetGLAccount: id: '1200.01' responses: '201': description: Created content: application/json: schema: type: object title: New ar-account-label properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create an account label: value: ia::result: key: '110' id: Wholesale Sales href: /objects/accounts-receivable/account-label/110 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/account-label/{key}: parameters: - name: key description: System-assigned key for the account label. in: path required: true schema: type: integer example: 110 get: summary: Get an account label description: >+ Returns detailed information for a specified AR account label.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View AR Account Labels
tags: - Accounts_Receivable_Account labels operationId: get-accounts-receivable-account-label-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the ar-account-label properties: ia::result: $ref: '#/components/schemas/accounts-receivable-account-label' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an account label: value: ia::result: key: '110' id: Wholesale Sales description: Wholesale Sales north america glAccount: id: 2050--Accured Compensation key: '197' href: /objects/account/197 status: active offsetGLAccount: id: 1200.01--Accounts Receivable - a/c label offset key: '168' href: /objects/account/168 href: /objects/accounts-receivable/account-label/110 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an account label description: >+ Updates an existing AR account label by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Edit AR Account Labels
tags: - Accounts_Receivable_Account labels operationId: update-accounts-receivable-account-label-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-account-label' - type: object properties: id: readOnly: true examples: Update a single value: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Updated account label properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated label: value: ia::result: key: '110' id: Test_AR_Account_Label href: /objects/accounts-receivable/account-label/110 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an account label description: >+ Deletes an AR account label.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Delete AR Account Labels
tags: - Accounts_Receivable_Account labels operationId: delete-accounts-receivable-account-label-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/term: get: summary: List terms description: >- Returns a collection with a key, ID, and link for each AR term. 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: - Accounts_Receivable_Terms operationId: list-accounts-receivable-term responses: '200': description: OK content: application/json: schema: type: object title: List of ar-term objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List terms: value: ia::result: - key: '5' id: N15 href: /objects/accounts-receivable/term/5 - key: '8' id: N30 href: /objects/accounts-receivable/term/8 - key: '9' id: NET15 href: /objects/accounts-receivable/term/9 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a term description: Creates a new AR term. tags: - Accounts_Receivable_Terms operationId: create-accounts-receivable-term requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-term' - $ref: '#/components/schemas/accounts-receivable-termRequiredProperties' examples: Create a term: value: ia::result: key: '29' id: arterm3 href: /objects/accounts-receivable/term/29 ia::meta: totalCount: 1 responses: '201': description: Created content: application/json: schema: type: object title: New term properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a term: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/term/{key}: parameters: - name: key description: System-assigned key for the term. in: path required: true schema: type: string get: summary: Get a term description: Returns detailed information for a specified AR term. tags: - Accounts_Receivable_Terms operationId: get-accounts-receivable-term-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the term properties: ia::result: $ref: '#/components/schemas/accounts-receivable-term' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a term: value: ia::result: id: arterm5 description: desc5 status: active key: '24' audit: modifiedDateTime: '2021-04-30T20:37:48Z' createdDateTime: '2021-04-30T20:37:48Z' modifiedBy: '1' createdBy: '1' due: days: 2 from: of5thMonthFromBillDate discount: days: 1 from: of3rdMonthFromBillDate amount: 10 unit: amount graceDays: 15 calculateOn: billTotal penalty: cycle: quarterly amount: 101 unit: amount graceDays: 16 href: /objects/accounts-receivable/term/24 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a term description: >- Updates an existing AR term by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Receivable_Terms operationId: update-accounts-receivable-term-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-term' - type: object properties: id: readOnly: true examples: Update a term: {} responses: '200': description: OK content: application/json: schema: type: object title: Updated ar-term properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated term: value: ia::result: key: '26' id: arterm1 href: /objects/accounts-receivable/term/26 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a term description: Deletes an AR term. tags: - Accounts_Receivable_Terms operationId: delete-accounts-receivable-term-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer: get: summary: List customers description: >+ Returns a collection with a key, ID, and link for each customer. 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
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Customers
tags: - Accounts_Receivable_Customers operationId: list-accounts-receivable-customer responses: '200': description: OK content: application/json: schema: type: object title: List of customer objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List customers: value: ia::result: - key: '68' id: CUST-100 href: /objects/accounts-receivable/customer/68 - key: '69' id: CUST-200 href: /objects/accounts-receivable/customer/69 - key: '73' id: CUST-300 href: /objects/accounts-receivable/customer/73 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a customer description: >+ Creates a new customer.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Add Customers
tags: - Accounts_Receivable_Customers operationId: create-accounts-receivable-customer requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer' - $ref: '#/components/schemas/accounts-receivable-customerRequiredProperties' examples: Create a customer: value: id: CUST-002 name: Starluck taxId: 12-3456789 creditLimit: 50000 status: active responses: '201': description: Created content: application/json: examples: Create a customer: value: ia::result: key: '32' id: CUST-200 href: /objects/accounts-receivable/customer/32 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 schema: type: object title: New customer properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer/{key}: parameters: - schema: type: string example: '81' name: key in: path required: true description: System-assigned key for the customer. get: summary: Get a customer description: |+ Returns detailed information for a specified customer.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Customers
tags: - Accounts_Receivable_Customers operationId: get-accounts-receivable-customer-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the customer properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a customer: value: ia::result: key: '1' id: PAMats name: Power Aerospace Materials parent: key: '2055' id: '12' name: '12' href: /objects/accounts-receivable/customer/2055 contacts: default: mailingAddress: addressLine1: 1120 Harbor Bay Pkwy addressLine2: St John's street addressLine3: Double cross road city: Sacramento country: United States postCode: 95119-1208 state: CA tax: isTaxable: true URL1: www.google.com URL2: www.google.com companyName: Logic Solutions email1: user@domain.com email2: user2@domain.com fax: (925) 123-4567 firstName: Sandy id: Test customer 1(CtestCust1) lastName: Tieber middleName: E mobile: (925) 123-4567 pager: (925) 123-4567 phone1: (408) 395-2539 phone2: (408) 395-2540 printAs: Mr. Sandy Tieber key: '394' hideContactList: false href: /objects/company-config/contact/394 primary: id: Aron key: '106' href: /objects/company-config/contact/106 shipTo: id: Alex key: '107' href: /objects/company-config/contact/107 billTo: id: Ben key: '108' href: /objects/company-config/contact/108 term: id: 15DaysExtToEOM key: '26' href: /objects/accounts-receivable/term/26 salesRepresentative: id: EM M name: Aaron key: '89' href: /objects/company-config/employee/89 resaleNumber: 123456789 taxId: '123456803' creditLimit: 20000 totalDue: '99999.99' notes: Sample Notes accountLabel: id: Pledges key: '9' defaultRevenueGLAccount: id: '2080.06' name: Germany(France) - Inter Entity Payable key: '136' href: /objects/general-ledger/account/136 lastInvoiceCreatedDate: '2021-10-12' lastStatementGeneratedDate: '2023-02-28' deliveryOptions: print territory: id: '23456' name: North East key: '23456' shippingMethod: id: Fedex key: '3' href: /objects/accounts-receivable/shipping-method/3 customerType: id: DOCS key: '13' href: /objects/accounts-receivable/customer-type/13 accountGroup: key: '10' id: Auto CGL Group href: /objects/accounts-receivable/customer-account-group/10 priceSchedule: id: '101' key: '101' href: /objects/purchasing/price-schedule/101 discountPercent: '10' priceList: id: Base Price List key: '1' href: /objects/order-entry/price-list/1 currency: USD status: active isOneTimeUse: false customerMessageId: test abhi isOnHold: false overridePriceList: Customer enableOnlineCardPayment: true enableOnlineACHPayment: true audit: modifiedDateTime: '2023-12-14T11:31:06Z' createdDateTime: '2018-07-28T19:22:31Z' createdBy: '1' modifiedBy: '1' restrictions: restrictionType: restricted locations: - North America--North America - GM--Gulf of Mexico - BG--Bangalore - NY--New York departments: - 1st Level Depts--Level 1 Departments - 2nd Level Depts--Level 2 Departments overrideOffsetGLAccount: id: '1120' name: Pledges Receivable emailOptIn: false contactList: - id: '150' key: '150' categoryName: ship audit: modifiedDateTime: '2023-12-14T11:31:06Z' createdDateTime: '2022-06-07T12:37:37Z' createdBy: '1' modifiedBy: '1' customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 contact: key: '106' id: Aron href: /objects/company-config/contact/106 href: /objects/accounts-receivable/customer-contact/150 customerEmailTemplates: - id: '8' key: '8' customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 txnDefinitionName: Sales Quote emailTemplate: id: '4' key: '4' name: OETemplate href: /objects/company-config/email-template/4 templateType: soDocument href: '/objects/accounts-receivable/customer-email-template/8' href: /objects/accounts-receivable/customer/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a customer description: >+ Updates an existing customer by setting field values. Any fields not provided remain unchanged. Customers included in posted transactions will not be updated. Only new transactions and records will refer to the updated customer information.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Edit Customers
tags: - Accounts_Receivable_Customers operationId: update-accounts-receivable-customer-key responses: '200': description: OK content: application/json: schema: type: object title: Updated customer properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated customer: value: ia::result: key: '34' id: CUST-100 href: /objects/accounts-receivable/payment/34 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer' - type: object properties: id: readOnly: true examples: Update a single value: value: creditLimit: 10000 security: - OAuth2: [] delete: summary: Delete a customer description: >+ Deletes a customer. Customers that have already been used in a transaction cannot be deleted. Instead, you can update customers that have already been used to make them inactive.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Delete Customers
tags: - Accounts_Receivable_Customers operationId: delete-accounts-receivable-customer-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-type: get: summary: List customer types description: >+ Returns a collection with a key, ID, and link for each customer type. 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
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Project Manager, and Warehouse
PermissionsList, View Customer Types
tags: - Accounts_Receivable_Customer types responses: '200': description: OK content: application/json: schema: type: object title: List of customer-type objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List customer types: value: ia::result: - key: '1' id: Account Manager href: /objects/accounts-receivable/customer-type/1 - key: '2' id: Auto ACH href: /objects/accounts-receivable/customer-type/2 - key: '3' id: Auto CC Payment href: /objects/accounts-receivable/customer-type/3 - key: '4' id: Credit Card href: /objects/accounts-receivable/customer-type/4 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' operationId: list-accounts-receivable-customer-type security: - OAuth2: [] post: summary: Create a customer type description: >+ Creates a new customer type.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Add Customer Types
tags: - Accounts_Receivable_Customer types operationId: create-accounts-receivable-customer-type responses: '201': description: Created content: application/json: schema: type: object title: New customer-type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a customer type: value: ia::result: key: '9' id: Client Start Trial href: /objects/accounts-receivable/customer-type/9 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-type' - $ref: '#/components/schemas/accounts-receivable-customer-typeRequiredProperties' examples: Create a customer type: value: id: Top Level Customer status: active security: - OAuth2: [] /objects/accounts-receivable/customer-type/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the customer type. example: '4' get: summary: Get a customer type description: >+ Returns detailed information for a specified customer type.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Customer Types
tags: - Accounts_Receivable_Customer types responses: '200': description: OK content: application/json: schema: type: object title: Details of the customer-type properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a customer type: value: ia::result: id: Client Start Trial parent: key: '1' id: Account Manager status: active key: '9' audit: createdDateTime: '2022-01-07T06:18:51Z' modifiedDateTime: '2022-01-07T06:18:51Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/customer-type/9 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' operationId: get-accounts-receivable-customer-type-key security: - OAuth2: [] patch: summary: Update a customer type description: >+ Updates an existing customer type by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Edit Customer Types
tags: - Accounts_Receivable_Customer types operationId: update-accounts-receivable-customer-type-key responses: '200': description: OK content: application/json: schema: type: object title: Updated customer-type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a customer type: value: ia::result: key: '2' id: Auto ACH href: /objects/accounts-receivable/customer-type/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-type' - type: object properties: id: readOnly: true examples: Update a customer type: value: status: inactive Update a parent customer type: value: parent: id: Top Level Customer status: inactive security: - OAuth2: [] delete: summary: Delete a customer type description: >+ Deletes a customer type.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Delete Customer Types
tags: - Accounts_Receivable_Customer types operationId: delete-accounts-receivable-customer-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-email-template: get: summary: List customer email templates description: >- Returns a collection with a key, ID, and link for each customer email template. 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: - Accounts_Receivable_Customer email templates operationId: list-accounts-receivable-customer-email-template responses: '200': description: OK content: application/json: schema: type: object title: List of customer-email-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List customer email templates: value: ia::result: - key: '1' id: '1' href: /objects/accounts-receivable/customer-email-template/1 - key: '6' id: '6' href: /objects/accounts-receivable/customer-email-template/6 - key: '8' id: '8' href: /objects/accounts-receivable/customer-email-template/8 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a customer email template description: Creates a new customer email template. tags: - Accounts_Receivable_Customer email templates operationId: create-accounts-receivable-customer-email-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-email-template' - $ref: '#/components/schemas/accounts-receivable-customer-email-templateRequiredProperties' examples: Example 1: value: customer: key: '127' emailTemplate: key: '4' responses: '201': description: Created content: application/json: schema: type: object title: New customer-email-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a customer email template: value: ia::result: key: '10' id: '10' href: /objects/accounts-receivable/customer-email-template/10 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-email-template/{key}: parameters: - name: key description: System-assigned key for the customer email template. in: path required: true schema: type: string example: '2' get: summary: Get a customer email template description: Returns detailed information for a specified customer email template. tags: - Accounts_Receivable_Customer email templates operationId: get-accounts-receivable-customer-email-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the customer-email-template properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer-email-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a customer email template: value: ia::result: key: '10' id: '10' customer: key: '127' id: Cust_Dif_Con_PnEtmp href: /objects/accounts-receivable/customer/127 txnDefinition: key: '12' id: Customer Sales Invoice emailTemplate: id: '4' key: '4' name: SimpleARInvTemp href: /objects/company-config/email-template/4 templateType: arInvoice href: /objects/accounts-receivable/customer-email-template/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a customer email template description: >- Updates an existing customer email template by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Receivable_Customer email templates operationId: update-accounts-receivable-customer-email-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-email-template' - type: object properties: id: readOnly: true examples: Change email template: value: emailTemplate: key: '10' responses: '200': description: OK content: application/json: schema: type: object title: Updated customer-email-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a customer email template: value: ia::result: key: '10' id: '10' href: /objects/accounts-receivable/customer-email-template/10 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a customer email template description: Deletes a customer email template. tags: - Accounts_Receivable_Customer email templates operationId: delete-accounts-receivable-customer-email-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/adjustment: get: summary: List adjustments description: >+ Returns a collection with a key, ID, and link for each adjustment. 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
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Adjustments
tags: - Accounts_Receivable_Adjustments operationId: list-accounts-receivable-adjustment responses: '200': description: OK content: application/json: schema: type: object title: List of adjustment objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List adjustments: value: ia::result: - key: '259' id: '259' href: /objects/accounts-receivable/adjustment/259 - key: '295' id: '295' href: /objects/accounts-receivable/adjustment/295 - key: '296' id: '296' href: /objects/accounts-receivable/adjustment/296 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an adjustment description: >+ Creates a new adjustment.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, and Add Adjustments
tags: - Accounts_Receivable_Adjustments operationId: create-accounts-receivable-adjustment requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-adjustment' - $ref: '#/components/schemas/accounts-receivable-adjustmentRequiredProperties' examples: Create an adjustment: value: customer: id: C-00005 createdDate: '2023-06-28' description: Lyon USD Adj baseCurrency: paidDate: '2022-11-15' currency: USD txnCurrency: currency: USD lines: - txnCurrency: amount: '120.03' currency: USD glAccount: id: '2990' dimensions: location: id: CA responses: '201': description: Created content: application/json: schema: type: object title: New adjustment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new adjustment: value: ia::result: id: '270' key: '270' href: /objects/accounts-receivable/adjustment/270 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/adjustment/{key}: parameters: - name: key description: System-assigned unique key for the adjustment. in: path required: true schema: type: string get: summary: Get an adjustment description: >+ Returns detailed information for a specified adjustment.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Adjustments
tags: - Accounts_Receivable_Adjustments operationId: get-accounts-receivable-adjustment-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the adjustment properties: ia::result: $ref: '#/components/schemas/accounts-receivable-adjustment' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an adjustment: value: ia::result: id: '7' key: '7' txnType: ra adjustmentNumber: null state: posted customer: id: C-00003 key: '14' name: Lyon Worldwide totalDue: '1344041.29' href: /objects/accounts-receivable/customer/14 documentNumber: SI-00183 description: null createdDate: '2023-12-18' audit: createdDateTime: '2023-12-18T00:00:00Z' modifiedDateTime: '2023-02-08T11:16:19Z' createdBy: null modifiedBy: null glPostingDate: '2023-12-18' attachment: id: null key: null baseCurrency: paidDate: null currency: USD totalSelected: '0' totalPaid: '0' totalAmountEntered: '295.00' totalDue: '295.00' txnCurrency: currency: USD totalEntered: '295.00' totalSelected: '0' totalPaid: '0' totalDue: '295.00' exchangeRate: date: null typeId: null rate: null contacts: billTo: id: Power Aerospace Materials (C1) key: '916' href: /objects/company-config/contact/916 shipTo: id: Power Aerospace Materials (C1) key: '312' href: /objects/company-config/contact/312 moduleKey: 4.AR lines: - id: '115' key: '115' arAdjustment: id: '7' key: '7' href: /objects/accounts-receivable/adjustment/7 glAccount: key: '153' id: '2995' name: Deferred Revenue Maintenance href: /objects/general-ledger/account/153 accountLabel: key: null id: null baseCurrency: amount: '295.00' currency: USD txnCurrency: amount: '295.00' currency: USD dimensions: department: key: 1 id: '01' name: Sales href: /objects/company-config/department/1 location: key: 1 id: CA name: California href: /objects/company-config/location/1 class: key: null id: null name: null item: key: '1' id: MTN01-12 name: Maintenance 12 month Contract href: /objects/inventory-control/item/1 customer: key: null id: null name: null vendor: key: '1' id: C-00003V name: BT Corp of America href: /objects/accounts-payable/vendor/1 project: key: null id: null name: null employee: key: null id: null name: null warehouse: key: null id: null name: null contract: key: null id: null name: null task: key: null id: null name: null memo: null exchangeRate: date: null typeId: null rate: '1' lineNumber: '1' adjustmentType: null isTax: false audit: createdDateTime: '2023-03-23T13:10:29Z' modifiedDateTime: '2023-03-24T10:45:23Z' createdBy: 1 modifiedBy: 1 href: /objects/accounts-receivable/adjustment-line/115 href: /objects/accounts-receivable/adjustment/7 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an adjustment description: >+ Updates an existing adjustment by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Edit Adjustments
tags: - Accounts_Receivable_Adjustments operationId: update-accounts-receivable-adjustment-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-adjustment' - type: object properties: id: readOnly: true examples: Update an adjustment: value: description: May 2023 Refund responses: '200': description: OK content: application/json: schema: type: object title: Updated adjustment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated adjustment: value: ia::result: id: '16855' key: '16855' href: /objects/accounts-receivable/adjustment/16855 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an adjustment description: >+ Deletes an adjustment. An adjustment can be deleted if it has not yet been applied to an invoice.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View, Delete Adjustments
tags: - Accounts_Receivable_Adjustments operationId: delete-accounts-receivable-adjustment-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/adjustment-line: get: summary: List adjustment lines description: >- Returns a collection with a key, ID, and link for each adjustment line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Accounts_Receivable_Adjustment lines operationId: list-accounts-receivable-adjustment-line responses: '200': description: OK content: application/json: schema: type: object title: List of adjustment-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get adjustments: value: ia::result: - key: '2651' id: '2651' href: /objects/accounts-receivable/adjustment-line/2651 - key: '2563' id: '2563' href: /objects/accounts-receivable/adjustment-line/2563 - key: '3481' id: '3481' href: /objects/accounts-receivable/adjustment-line/3481 ia::meta: totalCount: 3 start: 1 ageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/adjustment-line/{key}: parameters: - name: key description: System-assigned key for the adjustment line. in: path required: true schema: type: string get: summary: Get an adjustment line description: Returns detailed information for a specified adjustment line. tags: - Accounts_Receivable_Adjustment lines operationId: get-accounts-receivable-adjustment-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the adjustment-line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-adjustment-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an adjustment line: value: ia::result: id: '625' key: '625' arAdjustment: id: '270' key: '270' href: /objects/accounts-receivable/adjustment/270 glAccount: key: '348' id: '7510' name: Other Expense href: /objects/general-ledger/account/348 accountLabel: key: '36' id: InterCompany Sales href: /objects/accounts-receivable/account-label/36 department: key: '9' id: 11 name: Accounting href: /objects/company-config/department/9 location: key: '1' id: 1 name: United States of America href: /objects/company-config/location/1 description: null baseCurrency: currency: USD amount: '95' exchangeRate: date: '2023-01-23' typeId: '1' rate: '1' txnCurrency: currency: USD amount: '95' lineNumber: '1' state: approved adjustmentType: ra isTax: false audit: createdDateTime: '2023-03-23T13:10:29Z' modifiedDateTime: '2023-03-31T09:33:03Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/adjustment-line/625 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/advance: get: summary: List advances description: Returns a collection with a key, ID, and link for each advance. tags: - Accounts_Receivable_Advances operationId: list-accounts-receivable-advance responses: '200': description: OK content: application/json: schema: type: object title: List of advance objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of advances: value: ia::result: - key: '621' id: '621' href: /objects/accounts-receivable/advance/621 - key: '777' id: '777' href: /objects/accounts-receivable/advance-line/777 - key: '802' id: '802' href: /objects/accounts-receivable/advance-line/802 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an advance description: Creates a new advance. tags: - Accounts_Receivable_Advances operationId: create-accounts-receivable-advance requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-advance' - $ref: '#/components/schemas/accounts-receivable-advanceRequiredProperties' examples: Creates an advance: value: customer: id: '0203' paymentDate: '2023-04-25' receiptDate: '2023-04-25' advanceSummary: name: Divya summary paymentMethod: cash items: - glAccount: id: '2200' txnAmount: '10' dimensions: location: id: '1' responses: '201': description: Created content: application/json: schema: type: object title: New advance properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New advance: value: ia::result: key: '799' id: '799' href: /objects/accounts-receivable/advance/799 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/advance/{key}: parameters: - name: key description: system-assigned unique key for the advance. in: path required: true schema: type: string get: summary: Get an advance description: Returns detailed information for a particular advance. tags: - Accounts_Receivable_Advances operationId: get-accounts-receivable-advance-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the advance properties: ia::result: $ref: '#/components/schemas/accounts-receivable-advance' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the advance: value: ia::result: key: '799' id: '799' advanceSummary: key: 239 id: '239' name: Divya summary isSummaryOpen: open href: /objects/accounts-receivable/summary/239 glAccount: undepositedAccountNumber: '' paymentMethod: cash paymentMethodKey: 6 customer: id: '0203' key: '0203' name: Divya H href: /objects/accounts-receivable/customer/0203 referenceNumber: Text description: '' currency: baseCurrency: USD txnCurrency: USD exchangeRateDate: '2023-04-25' exchangeRateTypeId: '' exchangeRate: 1 receiptDate: '2023-04-25' paymentDate: '2023-04-25' recordType: rr state: posted totalEntered: '10.00' txnTotalEntered: '10.00' paymentInformation: totalBaseAmountPaid: '0.00' txnTotalPaid: '0.00' paidDate: '2023-04-25' totalDue: '10.00' totalTxnAmountDue: '10.00' audit: modifiedDateTime: '2023-06-13T07:31:51Z' createdBy: '1' modifiedBy: '1' createdDateTime: '2023-04-25T00:00:00Z' reconciliationGroup: cleared: 'false' clearingdDate: '' isSystemGenerated: false attachment: key: '' items: - key: '2067' id: '2067' advance: id: '799' key: '799' recordType: rr href: /objects/accounts-receivable/advance/799 glAccount: key: '156' id: '2200' name: Customer Advances href: /objects/general-ledger/account/156 accountLabel: name: Customer Advances id: '' baseAmount: '10.00' txnAmount: '10.00' dimensions: department: key: '' id: '' name: '' location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 project: key: '' id: '' name: '' customer: key: '' id: '' name: '' vendor: key: '' id: '' name: '' employee: key: '' id: '' name: '' item: key: '' id: '' name: '' class: key: '' id: '' name: '' baseLocation: name: United States of America key: '1' href: /objects/company-config/location/1 createdDate: '2023-04-25' memo: '' currency: exchangeRate: date: '2023-04-25' typeId: '' rate: 1 baseCurrency: USD txnCurrency: USD lineItem: t lineNumber: 1 paymentInformation: totalPaid: '0.00' txnTotalPaid: '0.00' totalSelected: '0.00' txnTotalSelected: '0.00' audit: createdDateTime: '2023-06-13T06:42:36Z' modifiedDateTime: '2023-06-13T07:31:51Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/advance-line/2067 href: /objects/accounts-receivable/advance/799 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an advance description: >- Updates an existing advance by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Receivable_Advances operationId: update-accounts-receivable-advance-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-advance' - type: object properties: id: readOnly: true examples: Updates an advance: value: referenceNumber: DOC1234 responses: '200': description: OK content: application/json: schema: type: object title: Updated advance properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated advance: value: ia::result: key: '799' id: '799' href: /objects/accounts-receivable/advance/799 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/advance-line: get: summary: List advance lines description: >- Returns a collection with a key, ID, and link for each advance line item. 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: - Accounts_Receivable_Advance lines operationId: list-accounts-receivable-advance-line responses: '200': description: OK content: application/json: schema: type: object title: List advance lines properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List advance lines: value: ia::result: - key: '2031' id: '2031' href: /objects/accounts-receivable/advance-line/2031 - key: '2067' id: '2067' href: /objects/accounts-receivable/advance-line/2067 - key: '856' id: '856' href: /objects/accounts-receivable/advance-line/856 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/advance-line/{key}: parameters: - name: key description: System-assigned unique key for the advance line. in: path required: true schema: type: string get: summary: Get an advance line description: Returns detailed information for a specified advance line. tags: - Accounts_Receivable_Advance lines operationId: get-accounts-receivable-advance-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the advance line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-advance-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an advance line: value: ia::result: key: '2067' id: '2067' advance: id: '799' key: '799' recordType: rr href: /objects/accounts-receivable/advance/799 glAccount: key: '156' id: '2200' name: Customer Advances href: /objects/general-ledger/account/156 accountLabel: name: Customer Advances id: '' baseAmount: '100.00' txnAmount: '100.00' dimensions: department: key: '' id: '' name: '' location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 project: key: '' id: '' name: '' customer: key: '36' id: C-00045 name: MetroArtic, Inc. href: /objects/accounts-receivable/customer/36 vendor: key: '' id: '' name: '' employee: key: '' id: '' name: '' item: key: '' id: '' name: '' class: key: '' id: '' name: '' baseLocation: name: United States of America key: '1' href: /objects/company-config/location/1 createdDate: '2023-04-25' memo: New contract down payment currency: exchangeRate: date: '2023-04-25' typeId: '' rate: 1 baseCurrency: USD txnCurrency: USD lineNumber: 1 paymentInformation: totalPaid: '100.00' txnTotalPaid: '100.00' totalSelected: '100.00' txnTotalSelected: '100.00' audit: createdDateTime: '2023-06-13T06:42:36Z' modifiedDateTime: '2023-06-13T07:31:51Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/advance-line/2067 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/billback-template: get: summary: List billback templates description: >- Returns a collection with a key, ID, and link for each billback template. tags: - Accounts_Receivable_Billback templates operationId: list-accounts-receivable-billback-template responses: '200': description: OK content: application/json: schema: type: object title: List of billback-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of billback templates: value: ia::result: - key: '11' id: BBT-NextGen-2 href: /objects/accounts-receivable/billback-template/11 - key: '14' id: BBT-NextGen-5 href: /objects/accounts-receivable/billback-template/14 - key: '25' id: BBT-NextGen-8 href: /objects/accounts-receivable/billback-template/25 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a billback template description: Creates a new billback template. tags: - Accounts_Receivable_Billback templates operationId: create-accounts-receivable-billback-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-billback-template' - $ref: '#/components/schemas/accounts-receivable-billback-templateRequiredProperties' examples: Creates a billback template: value: id: BBT-NextGen-9 description: BBT Next Gen template-9 enableInterEntityPostings: true lines: - invoiceGLAccount: key: '194' billGLAccount: key: '109' department: key: '9' memo: line 1 responses: '201': description: Created content: application/json: schema: type: object title: New billback-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New billback template: value: ia::result: key: '26' id: BBT-NextGen-9 href: /objects/accounts-receivable/billback-template/26 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/billback-template/{key}: parameters: - name: key description: System-assigned key for the billback template. in: path required: true schema: type: string get: summary: Get a billback template description: Returns detailed information for a particular billback template. tags: - Accounts_Receivable_Billback templates operationId: get-accounts-receivable-billback-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the billback-template properties: ia::result: $ref: '#/components/schemas/accounts-receivable-billback-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the billback template: value: ia::result: key: '1' id: bbt1 description: Billback template 2 status: active enableInterEntityPostings: true lines: - key: '1' id: '1' billbackTemplate: id: '1' key: '1' href: /objects/accounts-receivable/billback-template/1 lineNumber: '0' invoiceGLAccount: key: '194' id: '4000' name: Sales href: /objects/general-ledger/account/194 billGLAccount: key: '207' id: '5001' name: Construction href: /objects/general-ledger/account/207 department: key: '9' id: '11' name: Accounting href: /objects/company-config/department/9 memo: line 1 href: '/objects/accounts-receivable/billback-template-line/1' href: /objects/accounts-receivable/billback-template/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a billback template description: >- Updates an existing billback template by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Receivable_Billback templates operationId: update-accounts-receivable-billback-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-billback-template' - type: object properties: id: readOnly: true examples: Updates a billback template: value: status: active lines: - invoiceGLAccount: key: '194' billGLAccount: key: '109' department: key: '9' memo: line 1-1 - invoiceGLAccount: key: '194' billGLAccount: key: '109' department: key: '9' memo: line 1-2 responses: '200': description: OK content: application/json: schema: type: object title: Updated billback-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated billback template: value: ia::result: key: '5' id: BBT-NextGen-1 href: /objects/accounts-receivable/billback-template/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a billback template description: Deletes a billback template. tags: - Accounts_Receivable_Billback templates operationId: delete-accounts-receivable-billback-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/billback-template-line: get: summary: List billback template lines description: >- Returns a collection with a key, ID, and link for each billback template line. tags: - Accounts_Receivable_Billback template lines operationId: list-accounts-receivable-billback-template-line responses: '200': description: OK content: application/json: schema: type: object title: List of billback-template-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of billback template lines: value: ia::result: - key: '1' id: '1' href: /objects/accounts-receivable/billback-template-line/1 - key: '8' id: '8' href: /objects/accounts-receivable/billback-template-line/8 - key: '9' id: '9' href: /objects/accounts-receivable/billback-template-line/9 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/billback-template-line/{key}: parameters: - name: key description: System-assigned key for the billback template line. in: path required: true schema: type: string get: summary: Get a/an billback template line description: Returns detailed information for a particular billback template line. tags: - Accounts_Receivable_Billback template lines operationId: get-accounts-receivable-billback-template-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the billback-template-line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-billback-template-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the billback template line: value: ia::result: key: '1' id: '1' billbackTemplate: id: '1' key: '1' href: /objects/accounts-receivable/billback-template/1 lineNumber: '0' invoiceGLAccount: key: '194' id: '4000' name: Sales href: /objects/general-ledger/account/194 billGLAccount: key: '207' id: '5001' name: Construction href: /objects/general-ledger/account/207 department: key: '9' id: '11' name: Accounting href: /objects/company-config/department/9 memo: line 1 href: /objects/accounts-receivable/billback-template-line/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice-summary: get: summary: List invoice summaries description: >+ Returns a collection with a key, ID, and link for each AR invoice summary. 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
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Summaries
tags: - Accounts_Receivable_Invoice summaries operationId: list-accounts-receivable-invoice-summary responses: '200': description: OK content: application/json: schema: type: object title: List invoice summaries properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List invoice summaries: value: ia::result: - key: '9' id: '9' href: /objects/accounts-receivable/invoice-summary/9 - key: '13' id: '13' href: /objects/accounts-receivable/invoice-summary/13 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice-summary/{key}: parameters: - name: key description: System-assigned unique key for the invoice summary. in: path required: true schema: type: string get: summary: Get an invoice summary description: |+ Returns detailed information for a specified AR invoice summary.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Summaries
tags: - Accounts_Receivable_Invoice summaries operationId: get-accounts-receivable-invoice-summary-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the ar-invoice-summary properties: ia::result: $ref: '#/components/schemas/accounts-receivable-invoice-summary' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an invoice summary: value: ia::result: key: '13' id: '13' name: Contract Invoice April Summary glPostingDate: '2023-05-06' status: active recordType: ri totalAmount: '0' state: open parent: key: '13' id: '13' preventGLPosting: false bankAccount: key: '1' id: '1' summaryCreationType: manual isQuickPaymentSummary: false href: /objects/accounts-receivable/invoice-summary/13 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment: get: summary: List payments description: >+ Returns a collection with a key, ID, and link for each payment. 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
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View payments
tags: - Accounts_Receivable_Payments operationId: list-accounts-receivable-payment responses: '200': description: OK content: application/json: schema: type: object title: List of payment objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List payments: value: ia::result: - key: '212' id: '212' href: /objects/accounts-receivable/payment/212 - key: '201' id: '201' href: /objects/accounts-receivable/payment/201 - key: '289' id: '289' href: /objects/accounts-receivable/payment/289 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a payment description: >+ Creates a new payment. To successfully create a payment, you must include either the `entityId` for a `financialEntity` or the `id` for an `undepositedGLAccount` in your request.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Add payments
tags: - Accounts_Receivable_Payments operationId: create-accounts-receivable-payment requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-payment' - $ref: '#/components/schemas/accounts-receivable-paymentRequiredProperties' examples: Create a payment: value: financialEntity: entityId: BOA paymentMethod: cash customer: id: Cust-00064 documentNumber: '1567' paymentSummary: id: '1259' receiptDate: '2023-03-23' paidDate: '2023-03-23' baseCurrency: currency: USD amountToPay: '0.06' txnCurrency: currency: USD amountToPay: '1' paymentDetails: - arInvoice: id: '2085' - arInvoiceLine: id: '4313' responses: '201': description: Created content: application/json: schema: type: object title: New payment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new payment: value: ia::result: id: '2096' key: '2096' href: /objects/accounts-receivable/payment/2096 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment/{key}: parameters: - name: key description: System-assigned unique key for the payment. in: path required: true schema: type: string get: summary: Get a payment description: |+ Returns detailed information for a specified payment.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View payments
tags: - Accounts_Receivable_Payments operationId: get-accounts-receivable-payment-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the payment properties: ia::result: $ref: '#/components/schemas/accounts-receivable-payment' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a payment: value: ia::result: id: '464' key: '464' paymentSummary: key: '281' id: '281' title: 'Receipts(Bank-BOA): 2022/10/10 Batch' receiptDate: '2022-10-10' name: 'Receipts(Bank-BOA): 2022/10/10 Batch' undepositedGLAccount: key: null id: null recordType: rp financialEntity: entityId: BOA entityType: ba name: Bank of America currency: USD state: null paymentMethod: cash customer: key: '8' id: C-000012 name: Power Aerospace Materials href: objects/customer/8 documentNumber: '1567' description: Regular payment for services audit: createdDateTime: '2022-10-10T00:00:00Z' modifiedDateTime: '2022-12-12T06:51:22Z' createdBy: '39' modifiedBy: '39' paidDate: '2022-11-20' baseCurrency: currency: USD totalAmount: '250' totalSelected: '0' totalPaid: '250' totalDue: '0' txnCurrency: currency: USD totalAmount: '250' totalSelected: '0' totalPaid: '250' totalDue: '0' exchangeRate: date: '2020-08-01' typeId: null rate: 1 contacts: payTo: id: Klay Vanderbilt key: '8' bankReconciliationStatus: 'false' bankReconciliationDate: null referenceNumber: null attachment: id: '123' key: '123' multiEntityPayment: key: '1077' id: PAY-00136 href: /objects/accounts-receivable/payment/1077 lines: - id: '1011' key: '1011' arPayment: key: '464' href: /objects/accounts-receivable/payment/464 glAccount: key: '36' id: '1200' name: Accounts Receivable href: /objects/general-ledger/account/36 baseCurrency: amount: '10' currency: USD totalPaid: '10' totalSelected: '0' txnCurrency: amount: '10' currency: USD totalPaid: '10' totalSelected: '0' dimensions: department: key: null id: null name: null location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 project: key: null id: null name: null customer: key: C-00013 id: C-00013 name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 vendor: key: null id: null name: null employee: key: null id: null name: null item: key: null id: null name: null class: key: null id: null name: null memo: Regular payment for services exchangeRate: date: 10/10/2022 typeId: null rate: 1 lineNumber: '1' recordType: rp offsetGLAccount: key: '9' href: /objects/general-ledger/account/9 audit: createdDateTime: '2022-12-12T06:51:21Z' modifiedDateTime: '2022-12-12T06:51:22Z' createdBy: '38' modifiedBy: '38' href: /objects/accounts-receivable/payment-line/1011 paymentDetails: - id: '127' key: '127' baseCurrency: paymentAmount: '10' inlineAmount: null postedAdvanceAmount: null postedOverPaymentAmount: null negetiveInvoiceAmount: null adjustmentAmount: null txnCurrency: inlineAmount: null postedAdvanceAmount: null postedOverPaymentAmount: null negetiveInvoiceAmount: null adjustmentAmount: null paymentAmount: '10.00' currency: USD arInvoice: id: '406' key: '406' href: /objects/accounts-receivable/invoice/406 arInvoiceLine: id: '886' key: '886' href: /objects/accounts-receivable/invoice-line/886 positiveAdjustment: key: null id: null positiveAdjustmentLine: id: null key: null inlineTxn: key: null id: null inlineTxnLine: id: null key: null postedAdvance: key: null id: null postedAdvanceLine: id: null key: null postedOverPayment: key: null id: null postedOverPaymentLine: id: null key: null arAdjustment: key: null id: null arAdjustmentLine: id: null key: null arPayment: id: '464' key: '464' href: /objects/accounts-receivable/payment/464 arPaymentLine: id: '1011' key: '1011' href: /objects/accounts-receivable/payment-line/1011" paymentDate: '2019-03-20' audit: createdDateTime: '2022-12-12T06:51:21Z' modifiedDateTime: '2022-12-12T06:51:21Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/payment-detail/127 href: /objects/accounts-receivable/payment/464 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment-line: get: summary: List payment lines description: >+ Returns a collection with a key, ID, and link for each payment 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
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Manage payments
tags: - Accounts_Receivable_Payment lines operationId: list-accounts-receivable-payment-line responses: '200': description: OK content: application/json: schema: type: object title: List of payment line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List payment lines: value: ia::result: - key: '7' id: '7' href: /objects/accounts-receivable/payment-line/7 - key: '13' id: '13' href: /objects/accounts-receivable/payment-line/13 - key: '28' id: '28' href: /objects/accounts-receivable/payment-line/28 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment-line/{key}: parameters: - name: key description: System-assigned key for the payment line. in: path required: true schema: type: string get: summary: Get a payment line description: >+ Returns detailed information for a specified payment line.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Manage payments
tags: - Accounts_Receivable_Payment lines operationId: get-accounts-receivable-payment-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the payment line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-payment-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a payment line: value: ia::result: id: '1369' key: '1369' arPayment: key: '121' id: '121' href: /objects/accounts-receivable/payment/121 glAccount: key: '263' id: '1103' name: Accounts Receivable - Microcomputer href: /objects/general-ledger/account/263 dimensions: department: key: '1' id: '01' name: Sales href: /objects/company-config/department/1 location: key: '2' id: TX name: Texas href: /objects/company-config/location/2 customer: key: '13' id: C-00019 name: sForce href: /objects/accounts-receivable/customer/13 vendor: key: '512' id: V-00008 name: SF Seals href: /objects/accounts-payable/vendor/512 item: key: '6' id: LIC02-06 name: License 6 month contract href: /objects/inventory-control/item/6 memo: null, exchangeRate: date: '2022-04-15' typeId: '-1' rate: 1 baseCurrency: amount: '100' currency: USD totalPaid: '0' totalSelected: '100' txnCurrency: amount: '100' currency: USD totalPaid: '0' totalSelected: '100' lineNumber: 1 offsetGLAccount: key: '9' href: /objects/general-ledger/account/9 audit: createdDateTime: '2022-04-21T12:34:02Z' modifiedDateTime: '2022-07-04T08:18:29Z' createdBy: '39' modifiedBy": '39' href: /objects/accounts-receivable/payment-line/1369 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment-detail: get: summary: List payment details description: >- Returns a collection with a key, ID, and link for each payment 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. tags: - Accounts_Receivable_Payment details operationId: list-accounts-receivable-payment-detail responses: '200': description: OK content: application/json: schema: type: object title: List payment detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List payment details: value: ia::result: - key: '117' id: '117' href: /objects/accounts-receivable/payment-detail/117 - key: '118' id: '118' href: /objects/accounts-receivable/payment-detail/118 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment-detail/{key}: parameters: - name: key description: System-assigned key for the payment details. in: path required: true schema: type: string get: summary: Get payment details description: Returns detailed information for a specified payment details object. tags: - Accounts_Receivable_Payment details operationId: get-accounts-receivable-payment-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the payment detail properties: ia::result: $ref: '#/components/schemas/accounts-receivable-payment-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get payment details: value: ia::result: id: '117' key: '117' arInvoice: id: '426' key: '426' href: /objects/accounts-receivable/invoice/426 arInvoiceLine: id: '929' key: '929' href: /objects/accounts-receivable/invoice-line/929 positiveAdjustment: key: null id: null positiveAdjustmentLine: id: null key: null inlineTxn: key: '428' id: '428' href: /objects/accounts-receivable/invoice/428 inlineTxnLine: id: '933' key: '933' href: /objects/accounts-receivable/invoice-line/933 postedAdvance: key: null id: null postedAdvanceLine: id: null key: null postedOverPayment: key: null id: null postedOverPaymentLine: id: null key: null arAdjustment: key: null id: null arAdjustmentLine: id: null key: null arPayment: id: '433' key: '433' href: /objects/accounts-receivable/payment/433 arPaymentLine: id: '1011' key: '1011' href: /objects/accounts-receivable/payment-line/1011 paymentDate: '2022-11-25' baseCurrency: paymentAmount: '50' inlineAmount: '10' postedAdvanceAmount: null postedOverPaymentAmount: null negativeInvoiceAmount: null adjustmentAmount: null txnCurrency: inlineAmount: '10.10' postedAdvanceAmount: null postedOverPaymentAmount: null negativeInvoiceAmount: null adjustmentAmount: null paymentAmount: '50.00' currency: USD audit: createdDateTime: '2022-11-25T07:09:13Z' modifiedDateTime: '2022-11-25T07:09:13Z' createdBy: '39' modifiedBy: '39' href: /objects/accounts-receivable/payment-detail/117 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment-summary: get: summary: List payment summaries description: Returns a collection with a key, ID, and link for each payment summary. tags: - Accounts_Receivable_Payment summaries operationId: list-accounts-receivable-payment-summary responses: '200': description: OK content: application/json: schema: type: object title: List of ar-payment-summary objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of payment summaries: value: ia::result: - key: '4' id: '4' href: /objects/accounts-receivable/payment-summary/4 - key: '5' id: '5' href: /objects/accounts-receivable/payment-summary/5 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment-summary/{key}: parameters: - name: key description: System-assigned unique key for the payment summary. in: path required: true schema: type: string get: summary: Get a payment summary description: Returns detailed information for a particular payment summary. tags: - Accounts_Receivable_Payment summaries operationId: get-accounts-receivable-payment-summary-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the ar-payment-summary properties: ia::result: $ref: '#/components/schemas/accounts-receivable-payment-summary' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the payment summary: value: ia::result: key: '5' id: '5' name: 'Reversed Receipts(Bank-BOA): 2023/04/12 Batch' glPostingDate: '2023-04-12' status: active recordType: rp totalAmount: '200' state: open parent: key: '13' id: '13' preventGLPosting: false bankAccount: key: '1' id: BOA summaryCreationType: manual isQuickPaymentSummary: false href: /objects/accounts-receivable/payment-summary/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/summary: get: summary: List summaries description: >- Returns a collection with a key, ID, and link for each AR summary. 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: - Accounts_Receivable_Summaries operationId: list-accounts-receivable-summary responses: '200': description: OK content: application/json: schema: type: object title: List of ar-summary objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List summaries: value: ia::result: - key: '2' id: '2' href: /objects/accounts-receivable/summary/2 - key: '6' id: '6' href: /objects/accounts-receivable/summary/6 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a summary description: Creates a new AR summary. tags: - Accounts_Receivable_Summaries operationId: create-accounts-receivable-summary requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-summary' - $ref: '#/components/schemas/accounts-receivable-summaryRequiredProperties' examples: Create a summary: value: name: batch2 glPostingDate: '2023-05-10' status: active recordType: ri state: open preventGLPosting: false isQuickPaymentSummary: false responses: '201': description: Created content: application/json: schema: type: object title: New ar-summary properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New summary: value: ia::result: key: '14' id: '14' href: /objects/accounts-receivable/summary/14 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/summary/{key}: parameters: - name: key description: System-assigned key for the summary. in: path required: true schema: type: string get: summary: Get a summary description: Returns detailed information for a specified AR summary. tags: - Accounts_Receivable_Summaries operationId: get-accounts-receivable-summary-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the ar-summary properties: ia::result: $ref: '#/components/schemas/accounts-receivable-summary' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a summary: value: ia::result: key: '14' id: '14' name: batch5 glPostingDate: '2023-05-10' status: active recordType: ra totalAmount: '100' state: open parent: id: '11' key: '11' preventGLPosting: false bankAccount: id: '13' key: '13' summaryCreationType: manual isQuickPaymentSummary: false href: /objects/accounts-receivable/summary/14 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a summary description: >- Updates an existing AR summary by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Receivable_Summaries operationId: update-accounts-receivable-summary-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-summary' - type: object properties: id: readOnly: true examples: Update a summary: value: name: batch4 glPostingDate: '2023-05-10' status: active recordType: ra state: open preventGLPosting: false isQuickPaymentSummary: false responses: '200': description: OK content: application/json: schema: type: object title: Updated ar-summary properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated summary: value: ia::result: key: '14' id: '14' href: /objects/accounts-receivable/summary/14 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a summary description: Deletes an AR summary. tags: - Accounts_Receivable_Summaries operationId: delete-accounts-receivable-summary-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/territory: get: summary: List territories description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each territory. 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
SubscriptionCompany
User ypeBusiness
PermissionsList, View Territories
tags: - Accounts_Receivable_Territories operationId: list-accounts-receivable-territory responses: '200': description: OK content: application/json: schema: type: object title: List of territory objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List territories: value: ia::result: - key: '10' id: PNW href: /objects/accounts-receivable/territory/10 - key: '11' id: SW href: /objects/accounts-receivable/territory/11 - key: '12' id: ESB href: /objects/accounts-receivable/territory/12 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a territory description: >+ Creates a new territory.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsList, View, Add Territories
tags: - Accounts_Receivable_Territories operationId: create-accounts-receivable-territory requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-territory' examples: Create a territory: value: id: T-12 name: Territory India parent: id: '12755' manager: id: Raser status: active responses: '201': description: Created content: application/json: schema: type: object title: New territory properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New Territory: value: ia::result: key: '19' id: T-12 href: /objects/accounts-receivable/territory/19 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/territory/{key}: parameters: - schema: type: string example: '81' name: key in: path required: true description: System-assigned key for the territory. get: summary: Get a territory description: |+ Returns detailed information for a specified territory.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsList, View Territories
tags: - Accounts_Receivable_Territories responses: '200': description: OK content: application/json: schema: type: object title: Details of the territory properties: ia::result: $ref: '#/components/schemas/accounts-receivable-territory' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a territory: value: ia::result: key: '17' id: TT-SW name: Southwest parent: id: TT-US key: '14' href: /objects/accounts-receivable/territory/14 manager: key: '5' id: dwilson href: /objects/company-config/employee/5 status: active href: /objects/accounts-receivable/territory/17 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' operationId: get-accounts-receivable-territory-key security: - OAuth2: [] patch: summary: Update a territory description: >+ Updates an existing territory by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsList, View, Edit Territories
tags: - Accounts_Receivable_Territories operationId: update-accounts-receivable-territory-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-territory' - type: object properties: id: readOnly: true examples: Update a single value: value: name: Southwest United States responses: '200': description: OK content: application/json: schema: type: object title: Updated territory properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: key: '17' id: TT-SW href: /objects/accounts-receivable/territory/17 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a territory description: >+ Deletes a territory. A territory can be deleted if it hasn't been associated with a customer, transaction, or other record.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsList, View, Delete Territories
tags: - Accounts_Receivable_Territories operationId: delete-accounts-receivable-territory-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/territory-group: get: summary: List territory groups description: Returns a collection with a key, ID, and link for each territory group. tags: - Accounts_Receivable_Territory groups operationId: list-accounts-receivable-territory-group responses: '200': description: OK content: application/json: schema: type: object title: List of territory-group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List territory groups: value: ia::result: - key: '8' id: TG-1 href: /objects/accounts-receivable/territory-group/8 - key: '9' id: TG-2 href: /objects/accounts-receivable/territory-group/9 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a territory group description: Creates a new territory group. tags: - Accounts_Receivable_Territory groups operationId: create-accounts-receivable-territory-group requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-territory-group' - $ref: '#/components/schemas/accounts-receivable-territory-groupRequiredProperties' examples: Create a territory group: value: id: TG-1 name: Territory Group NG-1 description: Territory group NG-1 members: - territory: id": TT-NG2 - territory: id: TT-NG1 responses: '201': description: Created content: application/json: schema: type: object title: New territory-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New territory group: value: ia::result: key: '8' id: TG-1 href: /objects/accounts-receivable/territory-group/8 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/territory-group/{key}: parameters: - name: key description: System-assigned unique key for the territory group. in: path required: true schema: type: string get: summary: Get a territory group description: Returns detailed information for a specified territory group. tags: - Accounts_Receivable_Territory groups operationId: get-accounts-receivable-territory-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the territory-group properties: ia::result: $ref: '#/components/schemas/accounts-receivable-territory-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a territory group: value: ia::result: key: '9' id: TG-2 name: Territory Group NG-3 Updated description: This description is updated via Nextgen API audit: createdDateTime: '2023-09-18T10:53:14Z' modifiedDateTime: '2023-09-18T15:53:36Z' createdBy: '1' modifiedBy: '1' members: - id: '30' key: '30' territoryGroup: key: '9' id: TG-2 href: /objects/accounts-receivable/territory-group/9 territory: key: '11' id: '6345' name: South Central href: /objects/accounts-receivable/territory/11 sortOrder: '0' audit: createdDateTime: '2023-09-18T15:53:36Z' modifiedDateTime: '2023-09-18T15:53:36Z' createdBy: '1' modifiedBy: '1' href: '/objects/accounts-receivable/territory-group-member/30' href: /objects/accounts-receivable/territory-group/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a territory group description: >- Updates an existing territory group by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Receivable_Territory groups operationId: update-accounts-receivable-territory-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-territory-group' - type: object properties: id: readOnly: true examples: Update a territory group: value: name: Territory Group NG-3 Updated description: This description is updated via Nextgen API members: - ia::operation: delete id: '23' - ia::operation": delete id: '24' - territory: id: '6345' responses: '200': description: OK content: application/json: schema: type: object title: Updated territory-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated territory group: value: ia::result: key: '9' id: TG-2 href: /objects/accounts-receivable/territory-group/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a territory group description: Deletes a territory group. tags: - Accounts_Receivable_Territory groups operationId: delete-accounts-receivable-territory-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/territory-group-member: get: summary: List territory group members description: >- Returns a collection with a key, ID, and link for each territory group member. tags: - Accounts_Receivable_Territory group members operationId: list-accounts-receivable-territory-group-member responses: '200': description: OK content: application/json: schema: type: object title: List of territory-group-member objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List territory group members: value: ia::result: - key: '20' id: '20' href: /objects/accounts-receivable/territory-group-member/20 - key: '25' id: '25' href: /objects/accounts-receivable/territory-group-member/25 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/territory-group-member/{key}: parameters: - name: key description: System-assigned unique key for the territory group member. in: path required: true schema: type: string get: summary: Get a territory group member description: Returns detailed information for a specified territory group member. tags: - Accounts_Receivable_Territory group members operationId: get-accounts-receivable-territory-group-member-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the territory-group-member properties: ia::result: $ref: '#/components/schemas/accounts-receivable-territory-group-member' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a territory group member: value: ia::result: id: '2' key: '2' territoryGroup: key: '1' id: TG-1 href: /objects/accounts-receivable/territory-group/1 territory: key: '8' id: T-8 name: Central href: /objects/accounts-receivable/territory/8 sortOrder: '1' audit: createdDateTime: '2016-05-02T21:49:11Z' modifiedDateTime: '2016-05-02T21:49:11Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/territory-group-member/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-item-cross-reference: get: summary: List customer item cross references description: >- Returns a collection with a key, ID, and link for each customer item cross reference. tags: - Accounts_Receivable_Customer item cross references operationId: list-accounts-receivable-customer-item-cross-reference responses: '200': description: OK content: application/json: schema: type: object title: List of customer-item-cross-reference objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List customer item cross references: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a customer item cross reference description: Creates a new customer item cross reference. tags: - Accounts_Receivable_Customer item cross references operationId: create-accounts-receivable-customer-item-cross-reference requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-item-cross-reference' - $ref: '#/components/schemas/accounts-receivable-customer-item-cross-referenceRequiredProperties' examples: Create a customer item cross reference: {} responses: '201': description: Created content: application/json: schema: type: object title: New customer-item-cross-reference properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New customer item cross reference: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-item-cross-reference/{key}: parameters: - name: key description: System-assigned unique key for the customer item cross reference. in: path required: true schema: type: string get: summary: Get a customer item cross reference description: >- Returns detailed information for a specified customer item cross reference. tags: - Accounts_Receivable_Customer item cross references operationId: get-accounts-receivable-customer-item-cross-reference-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the customer-item-cross-reference properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer-item-cross-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a customer item cross reference: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a customer item cross reference description: >- Updates an existing customer item cross reference by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Receivable_Customer item cross references operationId: update-accounts-receivable-customer-item-cross-reference-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-item-cross-reference' - type: object properties: id: readOnly: true examples: Update a customer item cross reference: {} responses: '200': description: OK content: application/json: schema: type: object title: Updated customer-item-cross-reference properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated customer item cross reference: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a customer item cross reference description: Deletes a customer item cross reference. tags: - Accounts_Receivable_Customer item cross references operationId: delete-accounts-receivable-customer-item-cross-reference-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-contact: get: summary: List customer contacts description: >- Returns a collection with a key, ID, and link for each customer contact. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. operationId: list-accounts-receivable-customer-contact tags: - Accounts_Receivable_Customer contacts responses: '200': description: OK content: application/json: schema: type: object title: List of customer contact objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Example 1: value: ia::result: - key: '17' id: ALEX href: /objects/accounts-receivable/customer-contact/17 - key: '18' id: Ashly href: /objects/accounts-receivable/customer-contact/18 - key: '19' id: Lisa href: /objects/accounts-receivable/customer-contact/19 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null security: - OAuth2: [] /objects/accounts-receivable/customer-contact/{key}: parameters: - name: key description: System-assigned key for the customer contact. in: path required: true schema: type: string example: '1' get: summary: Get a customer contact description: Returns detailed information for a specified customer contact. operationId: get-accounts-receivable-customer-contact-key tags: - Accounts_Receivable_Customer contacts responses: '200': description: OK content: application/json: schema: type: object title: Details of the customer contact properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer-contact' ia::meta: $ref: '#/components/schemas/metadata' examples: Example 1: value: ia::result: key: '1' id: '1' categoryName: Main Office contact: key: '197' id: Jeffrey Palms audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' customer: key: '15' id: CPACBELL ia::meta: totalCount: 1 security: - OAuth2: [] /objects/accounts-receivable/customer-account-group: get: summary: List customer account groups tags: - Accounts_Receivable_Customer account groups responses: '200': description: OK content: application/json: schema: type: object title: List of customer-account-group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List customer account groups: value: ia::result: - key: '1' id: HW VGL Group href: /objects/accounts-receivable/customer-account-group/1 - key: '2' id: OS VGL Group href: /objects/accounts-receivable/customer-account-group/2 - key: '3' id: Stationary VGL Group href: /objects/accounts-receivable/customer-account-group/3 - key: '4' id: Electronic VGL Group href: /objects/accounts-receivable/customer-account-group/4 - key: '5' id: Gardening VGL Group href: /objects/accounts-receivable/customer-account-group/5 - key: '6' id: Auto VGL Group href: /objects/accounts-receivable/customer-account-group/6 - key: '7' id: Inactive VGL Group href: /objects/accounts-receivable/customer-account-group/7 ia::meta: totalCount: 7 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' operationId: list-accounts-receivable-customer-account-group description: >- Returns a collection with a key, ID, and link for each customer account group. security: - OAuth2: [] post: summary: Create a customer account group tags: - Accounts_Receivable_Customer account groups operationId: create-accounts-receivable-customer-account-group responses: '201': description: Created content: application/json: schema: type: object title: New customer-account-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New customer account group: value: ia::result: key: '18' id: 1099 Customer Group href: /objects/accounts-receivable/customer-account-group/18 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' description: Creates a new customer account group. requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-account-group' - $ref: '#/components/schemas/customerAccountGroupRequiredProperties' examples: Create a customer account group: value: id: 1099 Customer Group groupType: customer status: active security: - OAuth2: [] /objects/accounts-receivable/customer-account-group/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned unique key for the customer account group. get: summary: Get a customer account group tags: - Accounts_Receivable_Customer account groups responses: '200': description: customer-account-group Found content: application/json: schema: type: object title: Details of the customer account group properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer-account-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a customer account group: value: ia::result: id: HW VGL Group key: '1' groupType: customer status: inactive href: /objects/accounts-receivable/customer-account-group/1 ia::meta: totalCount: 1 '404': description: customer-account-group Not Found operationId: get-accounts-receivable-customer-account-group-key description: Returns detailed information for a specified customer account group. security: - OAuth2: [] patch: summary: Update a customer account group operationId: update-accounts-receivable-customer-account-group-key description: >- Updates an existing customer account group by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Receivable_Customer account groups responses: '200': description: OK content: application/json: schema: type: object title: Updated customer-account-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated customer account group: value: ia::result: key: '18' id: 1099 Customer Group href: /objects/accounts-receivable/customer-account-group/18 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-account-group' - type: object properties: id: readOnly: true examples: Update a customer account group: value: status: inactive description: '' security: - OAuth2: [] delete: summary: Delete a customer account group description: Deletes a customer account group. tags: - Accounts_Receivable_Customer account groups operationId: delete-accounts-receivable-customer-account-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/recurring-invoice: get: summary: List recurring invoices description: >- Returns a collection with a key, ID, and link for each recurring invoice. 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: - Accounts_Receivable_Recurring invoices operationId: list-accounts-receivable-recurring-invoice responses: '200': description: OK content: application/json: schema: type: object title: List of recurring invoice objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List recurring invoices: value: ia::result: - key: '3' id: '3' href: /objects/accounts-receivable/recurring-invoice/3 - key: '4' id: '4' href: /objects/accounts-receivable/recurring-invoice/4 - key: '7' id: '7' href: /objects/accounts-receivable/recurring-invoice/7 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a recurring invoice description: Creates a new recurring invoice. tags: - Accounts_Receivable_Recurring invoices operationId: create-accounts-receivable-recurring-invoice requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-recurring-invoice' - $ref: '#/components/schemas/accounts-receivable-recurring-invoiceRequiredProperties' examples: Create a recurring invoice: value: description: Reccurring invoice 1 term: key: '25' invoiceNumber: Invoice referenceNumber: ARRecur2 status: active customer: key: '1' contacts: shipTo: id: Abhilash currency: txnCurrency: USD baseCurrency: USD payment: paymentMethod: cash payInFull: true accountType: bank bankAccountID: BOA schedule: startDate: '2024-03-11' repeatCount: '2' repeatBy: day repeatInterval: '1' lines: - description: line 1 glAccount: key: '194' amount: '100.00' txnAmount: '100.00' responses: '201': description: Created content: application/json: schema: type: object title: New recurring invoice properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New recurring invoice: value: ia::result: id: '4' key: '4' href: /objects/accounts-receivable/recurring-invoice/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/recurring-invoice/{key}: parameters: - name: key description: System-assigned key for the recurring invoice. in: path required: true schema: type: string get: summary: Get an recurring invoice description: Returns detailed information for a specified recurring invoice. tags: - Accounts_Receivable_Recurring invoices operationId: get-accounts-receivable-recurring-invoice-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the recurring invoice properties: ia::result: $ref: '#/components/schemas/accounts-receivable-recurring-invoice' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a recurring invoice: value: ia::result: id: '3' key: '3' description: null audit: createdDateTime: '2021-08-24T00:00:00Z' modifiedDateTime: '2021-08-24T10:52:33Z' createdBy: '1' modifiedBy: '1' term: key: '25' id: 15DaysAfterEOM href: /objects/accounts-receivable/term/25 invoiceNumber: Invoice totalEntered: '100.00' referenceNumber: ARRecur1 status: active customer: name: Power Aerospace Materials key: '1' id: '1' href: /objects/accounts-receivable/customer/1 contract: id: contract 1 description: first contract contacts: shipTo: id: Abhilash currency: txnCurrency: USD baseCurrency: USD txnTotalEntered: '100.00' customerMessage: message 1 payment: paymentMethod: cash payInFull: true paymentAmount: '100.00' customerCreditCard: key: null creditCardType: null accountType: null bankAccountID: null undepositFundsAccountId: null schedule: startDate: '2021-08-22' endDate: null nextExecutionDate: '2021-08-25' lastExecutionDate: '2021-08-24' repeatCount: null repeatBy: day repeatInterval: '1' attachment: key: '5' id: Attach1 lines: - recurringInvoice: id: '3' key: '3' offsetGLAccount: key: '10' description: Line 1 glAccount: key: '194' id: '4000' name: Sales amount: '100.00' lineNumber: 0 accountLabel: id: Accounting Fees currency: txnCurrency: USD baseCurrency: USD exchangeRateDate: '2021-08-24' exchangeRateTypeId: Intacct Daily Rate exchangeRate: 1 txnAmount: '100.00' allocation: key: '2' id: Alloc50-50 isBillable: false audit: createdDateTime: '2021-08-24T10:52:33Z' modifiedDateTime: '2021-08-24T10:52:33Z' createdBy: '1' modifiedBy: '1' isSubTotal: false href: /objects/accounts-receivable/recurring-invoice/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a recurring invoice description: >- Updates an existing recurring invoice by setting field values. Any fields not provided remain unchanged. tags: - Accounts_Receivable_Recurring invoices operationId: update-accounts-receivable-recurring-invoice-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-recurring-invoice' - type: object properties: id: readOnly: true examples: Update a recurring invoice: value: description: updated description status: active responses: '200': description: OK content: application/json: schema: type: object title: Updated recurring invoice properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated recurring invoice: value: ia::result: id: '4' key: '4' href: /objects/accounts-receivable/recurring-invoice/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a recurring invoice description: Deletes a recurring invoice. tags: - Accounts_Receivable_Recurring invoices operationId: delete-accounts-receivable-recurring-invoice-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/recurring-invoice-line: get: summary: List recurring invoice lines description: >- Returns a collection with a key, ID, and link for each recurring invoice line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Accounts_Receivable_Recurring invoice lines operationId: list-accounts-receivable-recurring-invoice-line responses: '200': description: OK content: application/json: schema: type: object title: List of recurring invoice line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List recurring invoice lines: value: ia::result: - key: '9' id: '9' href: /objects/accounts-receivable/recurring-invoice-line/9 - key: '10' id: '10' href: /objects/accounts-receivable/recurring-invoice-line/10 - key: '13' id: '13' href: /objects/accounts-receivable/recurring-invoice-line/13 - key: '14' id: '14' href: /objects/accounts-receivable/recurring-invoice-line/14 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/recurring-invoice-line/{key}: parameters: - name: key description: System-assigned key for the recurring invoice line. in: path required: true schema: type: string get: summary: Get a recurring invoice line description: >- Returns detailed information for a specified line item in a recurring invoice. tags: - Accounts_Receivable_Recurring invoice lines operationId: get-accounts-receivable-recurring-invoice-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the recurring-invoice-line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-recurring-invoice-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a recurring invoice line: value: ia::result: id: '9' key: '9' recurringInvoice: id: '2' key: '2' href: /objects/accounts-receivable/recurring-invoice/2 description: Line 1 glAccount: key: '194' id: '4000' name: Sales href: /objects/general-ledger/account/194 amount: '50.00' dimensions: location: key: '19' id: '1' name: United States of America href: /objects/company-config/location/19 department: key: '1' id: '11' name: Accounting href: objects/company-config/department/1 customer: key: '11' id: '1' name: Power Aerospace Materials href: /objects/company-config/customer/11 lineNumber: 0 accountLabel: id: Accounting Fees currency: txnCurrency: USD baseCurrency: USD exchangeRateDate: '2021-08-24' exchangeRateTypeId: Intacct Daily Rate exchangeRate: 1 txnAmount: '50.00' allocation: key: '2' id: Alloc50-50 href: /objects/general-ledger/txn-allocation-template/2 isBillable: false audit: createdDateTime: '2021-08-24T10:24:19Z' modifiedDateTime: '2021-08-24T10:24:19Z' createdBy: '1' modifiedBy: '1' isTax: false isSubTotal: false href: /objects/accounts-receivable/recurring-invoice-line/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/posted-over-payment: get: summary: List posted overpayments description: >- Returns a collection with a key, ID, and link for each posted overpayment. tags: - Accounts_Receivable_Posted overpayments operationId: list-accounts-receivable-posted-over-payment responses: '200': description: OK content: application/json: schema: type: object title: List of ar-posted-over-payment objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List posted overpayments: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/posted-over-payment/{key}: parameters: - name: key description: System-assigned unique key for the posted overpayment. in: path required: true schema: type: string get: summary: Get a posted overpayment description: Returns detailed information for a specified posted overpayment. tags: - Accounts_Receivable_Posted overpayments operationId: get-accounts-receivable-posted-over-payment-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the ar-posted-over-payment properties: ia::result: $ref: '#/components/schemas/accounts-receivable-posted-over-payment' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a posted overpayment: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/posted-over-payment-line: get: summary: List posted overpayment lines description: >- Returns a collection with a key, ID, and link for each posted overpayment line. tags: - Accounts_Receivable_Posted overpayment lines operationId: list-accounts-receivable-posted-over-payment-line responses: '200': description: OK content: application/json: schema: type: object title: List of ar-posted-over-payment-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List posted overpayment lines: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/posted-over-payment-line/{key}: parameters: - name: key description: System-assigned unique key for the posted overpayment line. in: path required: true schema: type: string get: summary: Get a posted overpayment line description: Returns detailed information for a specified posted overpayment line. tags: - Accounts_Receivable_Posted overpayment lines operationId: get-accounts-receivable-posted-over-payment-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the posted overpayment line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-posted-over-payment-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an overpayment line: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/revenue-recognition-template/{key}: parameters: - schema: type: string name: key in: path required: true example: '1' description: System-assigned key for the revenue recognition template. get: summary: Get a revenue recognition template description: >- Returns detailed information for a specified revenue recognition template. tags: - Accounts_Receivable_Revenue recognition templates responses: '200': description: OK content: application/json: schema: type: object title: Details of the revenue recognition template properties: ia::result: $ref: '#/components/schemas/accounts-receivable-revenue-recognition-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a revenue recognition template: value: ia::result: key: '1' id: '1001' href: '/objects/accounts-receivable/revenue-recognition-template/1' status: active audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' operationId: get-accounts-receivable-revenue-recognition-template-key security: - OAuth2: [] /objects/accounts-receivable/revenue-recognition-template: get: summary: List revenue recognition templates description: >- Returns a collection with a key, ID, and link for each revenue recognition template. This operation is mostly for use in testing. Use query to fnd objects that meet certain criteria and to specify properties that are returned. tags: - Accounts_Receivable_Revenue recognition templates responses: '200': description: OK content: application/json: schema: type: object title: List of revenue-recognition-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List revenue recognition templates: value: ia::result: - key: '1' id: '1001' href: '/objects/accounts-receivable/revenue-recognition-template/1' - key: '2' id: '1001.01' href: '/objects/accounts-receivable/revenue-recognition-template/2' ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' operationId: list-accounts-receivable-revenue-recognition-template security: - OAuth2: [] /objects/accounts-receivable/revenue-recognition-template-line: get: summary: List revenue recognition template lines description: >- Returns a collection with a key, ID, and link for each revenue recognition template line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Accounts_Receivable_Revenue recognition template lines operationId: list-accounts-receivable-revenue-recognition-template-line responses: '200': description: OK content: application/json: schema: type: object title: List of revenue-recognition-template-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List revenue recognition template lines: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/REVRECTEMPLENTRY/{key}: parameters: - name: key description: System-assigned key for the revenue recognition template line. in: path required: true schema: type: string get: summary: Get a revenue recognition template line description: >- Returns detailed information for a specified revenue recognition template line. tags: - Accounts_Receivable_Revenue recognition template lines operationId: get-accounts-receivable-revenue-recognition-template-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the revenue-recognition-template-line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-revenue-recognition-template-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a revenue recognition template line: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/revenue-recognition-template-milestone: get: summary: List revenue recognition template milestones description: >- Returns a collection with a key, ID, and link for each revenue recognition template milestone. 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: - Accounts_Receivable_Revenue recognition template milestones operationId: list-accounts-receivable-revenue-recognition-template-milestone responses: '200': description: OK content: application/json: schema: type: object title: List of revenue-recognition-template-milestone objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List revenue recognition template milestones: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/revenue-recognition-template-milestone/{key}: parameters: - name: key description: System-assigned key for the revenue recognition template milestone. in: path required: true schema: type: string get: summary: Get a revenue recognition template milestone description: >- Returns detailed information for a specified revenue recognition template milestone. tags: - Accounts_Receivable_Revenue recognition template milestones operationId: get-accounts-receivable-revenue-recognition-template-milestone-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the revenue-recognition-template-milestone properties: ia::result: $ref: '#/components/schemas/accounts-receivable-revenue-recognition-template-milestone' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a revenue recognition template milestone: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/financial-institution: get: summary: List financial institutions description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each financial institution. 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
SubscriptionCash Management, Sage Cloud Services
User ypeBusiness user with admin permissions
PermissionsList, View Financial Institutions
tags: - Cash_Management_Financial institutions operationId: list-cash-management-financial-institution responses: '200': description: OK content: application/json: schema: type: object title: List of Financial Institutions objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List financial institutions: value: ia::result: - key: '1' id: FinInst1 href: /objects/cash-management/financial-institution/1 - key: '2' id: FinInst2 href: /objects/cash-management/financial-institution/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a financial institution description: >+ Creates a new financial institution.
Permissions and other requirements
SubscriptionCash Management, Sage Cloud Services
User ypeBusiness user with admin permissions
PermissionsAdd Financial Institution
tags: - Cash_Management_Financial institutions operationId: create-cash-management-financial-institution requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-financial-institution' - $ref: '#/components/schemas/cash-management-financial-institutionRequiredProperties' examples: Create a financial institution: summary: Create a financial institution value: id: FinInst-BOA name: FinOn4ss5e addOnServices: - name: MAL serviceContract: key: '129' accountType: checking checkingAccounts: - key: '72' externalBankAccount: id: a421d6c8-ed48-454d-a60e-7b697c67b956 name: Plaid Saving requestedStartDate: '2021-01-23' - key: '69' externalBankAccount: id: 412f0837-c236-4917-9796-84ec52cd3edb name: Plaid CD requestedStartDate: '2021-01-23' savingsAccounts: - key: '33' externalBankAccount: id: d6c05270-66f0-4d1b-8c1e-d35b4914e991 name: Plaid IRA requestedStartDate: '2021-01-23' - key: '30' externalBankAccount: id: 11dd5715-2585-43e5-8a6c-501923ca72ec name: Plaid 401k requestedStartDate: '2021-01-23' creditCards: - key: '60' externalBankAccount: id: be157d12-d181-4409-958f-1d8fb95b504f name: Plaid Credit Card requestedStartDate: '2021-01-23' - key: '7' externalBankAccount: id: 41650f07-0f3f-432d-9d57-e56a6286bdf0 name: Plaid Money Market requestedStartDate: '2021-01-23' responses: '201': description: Created content: application/json: schema: type: object title: New financial-institution properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a financial institution: value: ia::result: key: '103' href: /objects/cash-management/financial-institution/103 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/financial-institution/{key}: parameters: - name: key description: System-assigned key for the financial institution. in: path required: true schema: type: string get: summary: Get a financial institution description: >+ Returns detailed information for a specified financial institution.
Permissions and other requirements
SubscriptionCash Management, Sage Cloud Services
User ypeBusiness user with admin permissions
PermissionsList, View Financial Institutions
tags: - Cash_Management_Financial institutions operationId: get-cash-management-financial-institution-key responses: '200': description: OK content: application/json: schema: type: object title: Detail of the financial institutions properties: ia::result: $ref: '#/components/schemas/cash-management-financial-institution' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get a financial institution: value: ia::result: key: '1' id: FinInst1 name: FinOn4ddss5e totalAccounts: 7 checkingAccounts: - key: '129' href: /objects/cash-management/checking-account/129 - key: '72' href: /objects/cash-management/checking-account/72 - key: '69' href: /objects/cash-management/checking-account/69 savingsAccounts: - key: '33' href: /objects/cash-management/savings-account/33 - key: '30' href: /objects/cash-management/savings-account/30 creditCards: - key: '7' href: /objects/cash-management/credit-card-account/7 - key: '60' href: /objects/cash-management/credit-card-account/60 addOnServices: - name: MAL serviceContract: primaryAccountKey: '129' primaryAccountType: checking href: /objects/cash-management/financial-institution/96 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a financial institution description: >+ Updates an existing financial institution by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCash Management, Sage Cloud Services
User ypeBusiness user with admin permissions
PermissionsMap accounts, List, View, Add, Edit Financial Institution
tags: - Cash_Management_Financial institutions operationId: update-cash-management-financial-institution-key requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-financial-institution' - $ref: '#/components/schemas/cash-management-financial-institutionRequiredProperties' examples: Update a financial institution: value: id: FinInst-BOA checkingAccounts: - key: '99' externalBankAccount: id: a532e7d9-ed59-565d-a71e-8b718c7c167 name: Corp Saving requestedStartDate: '2021-01-23' responses: '200': description: OK content: application/json: schema: type: object title: Updated financial-institution properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a financial institution: value: ia::result: key: '96' href: /objects/cash-management/financial-institution/96 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-account/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the bank account. get: summary: Get a bank account description: Returns detailed information for a specified bank account. tags: - Cash_Management_Bank accounts operationId: get-cash-management-bank-account-key responses: '200': description: OK content: application/json: schema: type: object title: Detail of the bank account properties: ia::result: $ref: '#/components/schemas/cash-management-bank-account' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get a bank account: value: ia::result: key: '29' referenceKey: '90' id: CITI name: CitiBank12 currency: USD accountType: checking connectionStatus: inProgress supportMultiAccountLinking: true financialInstitution: id: '8' key: '8' href: /objects/cash-management/financial-institution/8 href: /objects/cash-management/bank-account/29 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/checking-account/{key}: parameters: - name: key description: System-assigned key for the checking account. in: path required: true schema: type: string get: summary: Get a checking account description: >+ Returns detailed information for a specified checking account.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness, Employee, Project Manager
PermissionsList, View Checking Accounts
tags: - Cash_Management_Checking accounts operationId: get-cash-management-checking-account-key responses: '200': description: OK content: application/json: schema: type: object title: Checking account details properties: ia::result: $ref: '#/components/schemas/cash-management-checking-account' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get a checking account: value: ia::result: id: BOA-000987g bankAccountDetails: accountNumber: '890000088' bankName: Bank of America routingNumber: '123456789' branchId: 00-1355 phoneNumber: '9007780000' bankAddress: addressLine1: '40714' addressLine2: Grimmer Blvd addressLine3: null city: Fremont country: United States postCode: '98765' state: CA currency: GBP accountHolderName: ACME Software accounting: glAccount: id: 9090.09.90--RestNextGenGL key: '584' href: /objects/general-ledger/account/584 apJournal: id: AR ADJ--AR Adjustment Journal key: '17' href: /objects/general-ledger/journal/17 arJournal: id: CHASE D--CHASE BANK DISB key: '12' href: /objects/general-ledger/journal/12 bankingTimeZone: GMT+05:30 Bombay, Calcutta, Madras, New Delhi serviceChargeGLAccount: key: null id: null serviceChargeAccountLabel: key: '15' id: Car Payment href: /objects/accounts-payable/account-label/15 interestGLAccount: key: null id: null interestAccountLabel: key: null id: null disableInterEntityTransfer: false checkPrinting: addressSettings: addressToPrint: company printAddress: true printLogo: true address: addressLine1: 75688 Post st addressLine2: '456' addressLine3: null city: San Jose country: United States countryCode: US postCode: '94536' state: CA phone: '6609336532' name: Zine Inc. micrSettings: regionalSettings: positionOfOnUsSymbol: position31 printCode45: true printOnUsSymbol: true printUSFundsUnderCheckAmount: false accountNumberAlignment: right accountNumberPositioning: 1 minCheckNumberLength: '6' printSettings: additionalText: Pay to check holder paperFormat: top printLineItems: true printLocation: id printingFormat: standard nextCheckNumber: '1012' numberOfChecksInPreview: one printOn: blankCheckStock signatures: firstSignature: sigimg1_g.gif limitForFirstSignatureAmount: null limitForSecondSignatureAmount: null secondSignature: sigimg2_g.gif thresholdForSecondSignatureAmount: '99.00' disablePrinting: false reconciliation: matchSequence: key: '48' id: 48--bankseq-1 href: /objects/company-config/document-sequence/48 useMatchSequenceForAutoMatch: true useMatchSequenceForManualMatch: true lastReconciledBalance: null lastReconciledDate: null cutOffDate: null inProgressBalance: null inProgressDate: null department: key: '9' id: 11--Accounting href: /objects/company-config/department/9 location: key: '1' id: 1--United States of America href: /objects/company-config/location/1 status: active audit: createdDateTime: '2024-03-07T19:39:43Z' modifiedDateTime: '2024-03-07T19:39:43Z' createdBy: '1' modifiedBy: '1' key: '291' ach: bankId: null companyName: null companyIdentification: null originatingFinancialInstitution: null companyEntryDescription: null companyDiscretionaryData: null recordTypeCode: '5' serviceClassCode: '220' originatorStatusCode: '1' batchId: null traceNumberSequence: null paymentNumberSequence: null useTraceNumber: useAsPayment enableACH: null useRecommendedSetup: null bankingCloudConnection: status: notConnected bankName: null name: null lastBankTxnDateTime: null lastRefreshedDateTime: null refreshStatus: null supportMultiAccountLinking: null bankFile: enableBankFile: null bankFileFormat: null bankCode: null apcaNumber: null sunNumber: null bsbNumber: null sortCode: null seedValue: null userReference: null clientCode: null serviceType: null originatorId: null businessIdCode: null processingDataCenterCode: null debtorBankNumber: null returnAccountNumber: null branchTransitNumber: null messageIdPrefix: null financialInstitution: key: null id: null ruleSet: id: null key: null paymentProviderBankAccounts: [] href: /objects/cash-management/checking-account/291 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a checking account description: Creates a new checking account. tags: - Cash_Management_Checking accounts operationId: post-objects-checking-account requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-checking-account' - $ref: '#/components/schemas/cash-management-checking-accountRequiredProperties' examples: Create checking account: value: id: BOA bankAccountDetails: accountNumber: '890000088' bankName: Bank of America routingNumber: '123456789' branchId: 00-1355 phoneNumber: '9007780000' bankAddress: addressLine1: '40714' addressLine2: Grimmer Blvd addressLine3: West Cameron city: Fremont country: United States postCode: '98765' state: CA currency: USD accountHolderName: ACME Software accounting: glAccount: id: 9090.09.90--RestNextGenGL apJournal: id: AR ADJ--AR Adjustment Journal arJournal: id: RCPT--Receipts Journal bankingTimeZone: GMT+02:00 Central Europe Summer Time serviceChargeAccountLabel: key: '15' interestAccountLabel: id: Sales disableInterEntityTransfer: false checkPrinting: addressSettings: addressToPrint: company printAddress: true printLogo: true address: addressLine1: 75688 Post st addressLine2: '456' addressLine3: West Cameron city: San Jose country: United States countryCode: US postCode: '94536' state: CA phone: '6609336532' name: Zine Inc. micrSettings: regionalSettings: positionOfOnUsSymbol: position31 printCode45: true printOnUsSymbol: true printUSFundsUnderCheckAmount: false accountNumberAlignment: right accountNumberPositioning: 1 minCheckNumberLength: '6' printSettings: additionalText: Pay to check holder paperFormat: top printLineItems: true printLocation: id printingFormat: standard nextCheckNumber: '1012' numberOfChecksInPreview: One printOn: blankCheckStock signatures: firstSignature: sigimg1_g.gif limitForFirstSignatureAmount: '20' limitForSecondSignatureAmount: '30' secondSignature: sigimg2_g.gif thresholdForSecondSignatureAmount: '99.00' disablePrinting: false reconciliation: matchSequence: key: '48' useMatchSequenceForAutoMatch: true useMatchSequenceForManualMatch: true ach: bankId: ACH-1 companyName: origin companyIdentification: originid originatingFinancialInstitution: '8909' companyEntryDescription: entry desc companyDiscretionaryData: disc serviceClassCode: '220' batchId: BOA_ACH_BatchNo traceNumberSequence: BOA_ACH_TraceNo paymentNumberSequence: CONTINVOICE useTraceNumber: T enableACH: true useRecommendedSetup: true ruleSet: key: '53' id: MatchDateAmountGrpbyDateRuleSet restrictions: restrictionType: restricted locations: - 1--United States of America - 200--My New Entity location: key: '1' id: 1--United States of America responses: '201': description: Created checking account content: application/json: schema: type: object title: New checking-account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New checking account: value: id: BOA-000987g bankAccountDetails: accountNumber: '890000088' bankName: Bank of America routingNumber: '123456789' branchId: 00-1355 phoneNumber: '9007780000' bankAddress: addressLine1: '40714' addressLine2: Grimmer Blvd addressLine3: null city: Fremont country: United States postCode: '98765' state: CA currency: GBP accountHolderName: ACME Software accounting: glAccount: id: 9090.09.90--RestNextGenGL apJournal: id: AR ADJ--AR Adjustment Journal arJournal: id: CHASE D--CHASE BANK DISB bankingTimeZone: GMT+05:30 Bombay, Calcutta, Madras, New Delhi serviceChargeAccountLabel: key: '15' interestAccountLabel: id: Sales disableInterEntityTransfer: false checkPrinting: addressSettings: addressToPrint: company printAddress: true printLogo: true address: addressLine1: 75688 Post st addressLine2: '456' addressLine3: null city: San Jose country: United States countryCode: US postCode: '94536' state: CA phone: '6609336532' name: Zine Inc. micrSettings: regionalSettings: positionOfOnUsSymbol: position31 printCode45: true printOnUsSymbol: true printUSFundsUnderCheckAmount: false accountNumberAlignment: right accountNumberPositioning: 1 minCheckNumberLength: '6' printSettings: additionalText: Pay to check holder paperFormat: top printLineItems: true printLocation: id printingFormat: standard nextCheckNumber: '1012' // "printPreview": One printOn: blankCheckStock signatures: firstSignature: sigimg1_g.gif limitForFirstSignatureAmount: null limitForSecondSignatureAmount: null secondSignature: sigimg2_g.gif thresholdForSecondSignatureAmount: '99.00' disablePrinting: false reconciliation: matchSequence: key: '48' useMatchSequenceForAutoMatch: true useMatchSequenceForManualMatch: true department: id: 11--Accounting location: id: 1--United States of America security: - OAuth2: [] patch: summary: Update a checking account description: >- Updates an existing checking account by setting field values. Any fields not provided remain unchanged. tags: - Cash_Management_Checking accounts operationId: patch-objects-checking-account requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-checking-account' - type: object properties: id: readOnly: true examples: Modifying a few fields: value: bankAccountDetails: bankName: Bank of America New ruleSet: key: '53' id: MatchDateAmountGrpbyDateRuleSet restrictions: restrictionType: unrestricted locations: [] reconciliation: matchSequence: key: '48' useMatchSequenceForAutoMatch: true useMatchSequenceForManualMatch: true responses: '201': description: Updated checking account content: application/json: schema: type: object title: New checking-account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' security: - OAuth2: [] delete: summary: Delete a checking account description: Deletes a checking account. tags: - Cash_Management_Checking accounts operationId: delete-objects-checking-account responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/checking-account: get: summary: List checking accounts description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each checking account. 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
SubscriptionCash Management
User ypeBusiness, Employee, Project Manager
PermissionsList, View Checking Accounts
tags: - Cash_Management_Checking accounts operationId: list-cash-management-checking-account responses: '200': description: OK content: application/json: schema: type: object title: List of Checking accounts properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List checking accounts: value: ia::result: - key: '84' id: AUDCHK href: /objects/cash-management/checking-account/84 - key: '85' id: BDF href: /objects/cash-management/checking-account/85 - key: '60' id: BOA href: /objects/cash-management/checking-account/60 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposit: get: summary: List deposits description: >+ Returns a collection with a key, ID, and link for each deposit. 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
SubscriptionCash Management
User ypeBusiness
PermissionsList, View Deposits
tags: - Cash_Management_Deposits operationId: list-cash-management-deposit responses: '200': description: OK content: application/json: schema: type: object title: List of deposit objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List deposits: value: ia::result: - key: '1718' id: '1718' href: /objects/cash-management/deposit/1718 - key: '1717' id: '1717' href: /objects/cash-management/deposit/1717 - key: '3228' id: '3228' href: /objects/cash-management/deposit/3228 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a deposit description: |+ Creates a new deposit.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness
PermissionsList, Add Deposits
tags: - Cash_Management_Deposits operationId: create-cash-management-deposit requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-deposit' - $ref: '#/components/schemas/cash-management-depositRequiredProperties' examples: Create a deposit: value: txnDate: '2024-01-22' description: Monday Deposit 0314-001 depositId: Deposit slip 01/22/2023 bankAccount: id: BOA attachment: id: '18' details: - id: '123' responses: '201': description: Created content: application/json: schema: type: object title: New deposit properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New deposit object: value: ia::result: key: '500' id: '500' href: /objects/cash-management/deposit/500 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposit/{key}: parameters: - name: key description: System-assigned unique key for the deposit. in: path required: true schema: type: string get: summary: Get a deposit description: |+ Returns detailed information for a specified deposit.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness
PermissionsList, View Deposits
tags: - Cash_Management_Deposits operationId: get-cash-management-deposit-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the deposit properties: ia::result: $ref: '#/components/schemas/cash-management-deposit' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a deposit: value: ia::result: id: '628' key: '628' bankAccount: id: BOA name: Bank of America txnDate: '2023-11-15' depositId: Deposit Slip 2023-11-15 description: Deposit for pay-go online services baseCurrency: USD txnCurrency: USD totalEntered: '120.50' txnTotalEntered: '120.50' voidPaymentKey: null reversalDate: null reversedVoidPaymentKey: null reversedDate: null state: null reconciliationState: uncleared audit: createdDateTime: '2023-11-15T20:55:20Z' modifiedDateTime: '2023-11-15T20:55:25Z' createdBy: '1' modifiedBy: '1' attachment: key: '18' id: Attach-01 href: /objects/company-config/attachment/18 lines: - id: '1253' key: '1253' deposit: id: '628' key: '628' depositType: cd href: /objects/cash-management/deposit/628 glAccount: id: '33' key: '33' accountNumber: '1070' name: Undeposited Funds href: /objects/general-ledger/account/33 arAccountLabel: label: null id: null key: null amount: '120.50' txnAmount: '120.50' dimensions: department: key: null id: null name: null location: key: '1' name: United States of America href: /objects/company-config/location/1 baseLocation: key: '1' name: United States of America href: /objects/company-config/location/1 description: null currency: exchangeRate: date: '2022-01-23' typeId: '-1' rate: 1 txnCurrency: USD baseCurrency: USD status: active audit: createdDateTime: '2023-11-15T20:55:20Z' modifiedDateTime: '2023-11-15T20:55:25Z' createdBy: '1' modifiedBy: '1' href: /objects/cash-management/deposit-line/1253 details: - id: '624' key: '624' undepositedFund: key: '624' id: '624' href: /objects/cash-management/undeposited-fund/624 depositedFund: key: '624' id: '624' href: /objects/cash-management/deposited-fund/624 summary: 'Cash Management Transactions: 2023/12/20 Batch' customerID: null customerName: null payee: Toulouse - 03 totalEntered: '120.50' txnTotalEntered: '120.50' currency: USD paymentMethod: cash documentNumber: null deposit: id: '628' key: '628' href: /objects/cash-management/deposit/628 href: /objects/cash-management/deposit-detail/624 href: /objects/cash-management/deposit/628 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposit-line: get: summary: List deposit lines description: >+ Returns a collection with a key, ID, and link for each deposit 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
SubscriptionCash Management
User ypeBusiness
PermissionsList, View Deposits
tags: - Cash_Management_Deposit lines operationId: list-cash-management-deposit-line responses: '200': description: OK content: application/json: schema: type: object title: List of deposit line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List deposit lines: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/deposit-line/1 - key: '3' id: '3' href: /objects/cash-management/deposit-line/3 - key: '5' id: '5' href: /objects/cash-management/deposit-line/5 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposit-line/{key}: parameters: - name: key description: System-assigned unique key for the deposit line. in: path required: true schema: type: string get: summary: Get a deposit line description: |+ Returns detailed information for a specified deposit line.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness
PermissionsList, View Deposits
tags: - Cash_Management_Deposit lines operationId: get-cash-management-deposit-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the deposit-line properties: ia::result: $ref: '#/components/schemas/cash-management-deposit-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a deposit line: value: ia::result: id: '1253' key: '1253' deposit: id: '628' key: '628' depositType: cd href: /objects/cash-management/deposit/628 glAccount: id: '33' key: '33' accountNumber: '1070' name: Undeposited Funds href: /objects/general-ledger/account/33 arAccountLabel: label: null id: null key: null amount: '12.50' txnAmount: '12.50' dimensions: department: key: '' id: '' name: '' location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 baseLocation: name: United States of America key: '1' description: Deposit from other receipt for Convivia grapes inc currency: exchangeRate: date: '2023-04-25' typeId: '-1' rate: '1.0' baseCurrency: USD txnCurrency: USD status: active audit: createdDateTime: '2023-11-15T20:55:20Z' modifiedDateTime: '2023-11-15T20:55:25Z' createdBy: '1' modifiedBy: '1' href: /objects/cash-management/deposit-line/1253 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposit-detail: get: summary: List deposit details description: >- Returns a collection with a key, ID, and link for each deposit detail. 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: - Cash_Management_Deposit details operationId: list-cash-management-deposit-detail responses: '200': description: OK content: application/json: schema: type: object title: List of deposit-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List deposit details: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/deposit-detail/1 - key: '3' id: '3' href: /objects/cash-management/deposit-detail/3 - key: '5' id: '5' href: /objects/cash-management/deposit-detail/5 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposit-detail/{key}: parameters: - name: key description: System-assigned unique key for the deposit detail. in: path required: true schema: type: string get: summary: Get a deposit detail description: Returns detailed information for a specified deposit detail. tags: - Cash_Management_Deposit details operationId: get-cash-management-deposit-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the deposit-detail properties: ia::result: $ref: '#/components/schemas/cash-management-deposit-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a deposit detail: value: ia::result: id: '587' key: '587' deposit: id: '291' key: '291' depositType: cd href: /objects/cash-management/deposit/291 glAccount: id: '33' key: '33' accountNumber: '1070' name: Undeposited Funds href: /objects/general-ledger/account/33 arAccountLabel: label: null id: null key: null amount: '1002.00' txnAmount: '1002.00' department: key: null id: null name: null location: key: '1' name: United States of America href: /objects/company-config/location/1 baseLocation: name: United States of America key: '1' description: Depisted from undeposited fund from GPay invoice exchangeRate: date: '2022-01-23' typeId: '-1' rate: 1 currency: USD baseCurrency: USD status: active state: deposited audit: createdDateTime: '2021-04-16T00:57:25Z' modifiedDateTime: '2021-04-16T00:57:43Z' createdBy: '1' modifiedBy: '1' href: /objects/cash-management/deposit-detail/587 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/other-receipt: get: summary: List other receipt objects description: >+ Returns up to 100 objects from the collection with a key, ID, and link for each other receipts 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
SubscriptionCash Management
User ypeBusiness
PermissionsList, View Other receipts
tags: - Cash_Management_Other receipts operationId: list-cash-management-other-receipt responses: '200': description: OK content: application/json: schema: type: object title: List of other-receipt objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List other receipts: value: ia::result: - key: '182' id: '182' href: /objects/cash-management/other-receipt/182 - key: '193' id: '193' href: /objects/cash-management/other-receipt/193 - key: '501' id: '501' href: /objects/cash-management/other-receipt/501 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an other receipts object description: |+ Creates a new other receipts object.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness
PermissionsAdd Other receipts
tags: - Cash_Management_Other receipts operationId: create-cash-management-other-receipt requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-other-receipt' - $ref: '#/components/schemas/cash-management-other-receiptRequiredProperties' examples: Create an other receipts object: value: payer: Benson Hugo txnDate: '2022-01-23' txnPaidDate: '2022-01-23' txnNumber: '22365' description: Refund for overpayment baseCurrency: USD currency: USD state: approved reconciliationState: uncleared isInclusiveTax: false bankAccount: id: BOA-REC-01 depositDate: '2022-01-23' exchangeRate: date: '2022-01-23' typeId: null rate: 1 paymentMethod: eft reversalDate: '2022-01-23' reversedDate: '2022-01-23' reversedVoidPaymentKey: '1400' voidPaymentKey: '1923' lines: - status: active amount: '100.00' txnAmount: '100.00' description: description lineNumber: 1 baseCurrency: USD currency: USD isTax: false arAccountLabel: key: '35' glAccount: id: '5008' dimensions: location: id: CAG department: id: OPEE responses: '201': description: Created content: application/json: schema: type: object title: New other-receipt properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create an other receipts object: value: ia::result: key: '500' id: '500' href: /objects/cash-management/other-receipt/500 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/other-receipt/{key}: parameters: - name: key description: System-assigned unique key for the other receipts object. in: path required: true schema: type: string get: summary: Get an other receipts object description: >+ Returns detailed information for a specified other receipts object.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness
PermissionsList, View Other receipts
tags: - Cash_Management_Other receipts operationId: get-cash-management-other-receipt-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the other-receipt properties: ia::result: $ref: '#/components/schemas/cash-management-other-receipt' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an other receipts object: value: ia::result: key: '557' id: '557' txnDate: '2022-01-23' recordType: cr payer: Smith Jones txnPaidDate: '2022-01-23' paymentMethod: creditCard txnNumber: '2251' description: Conference booth fee bankAccount: key: '45' id: BOA-REC-01 name: BOA-REC currency: USD href: /objects/cash-management/bank-account/45 depositDate: '2022-01-23' arSummary: key: '315' id: '315' date: '2022-01-01' href: /objects/accounts-receivable/summary/315 baseCurrency: USD currency: USD exchangeRate: date: null typeId: null rate: null totalEntered: '150.00' txnTotalEntered: '150.00' reconciliationDate: null state: approved reconciliationState: uncleared parentDeposit: key: null id: null audit: createdDateTime: '2023-09-07T21:44:43Z' modifiedDateTime: '2023-09-07T21:44:44Z' createdBy: '1' modifiedBy: '1' isInclusiveTax: false taxSolution: key: null id: null enableMultilineTax: null taxCalculationMethod: null voidPaymentKey: null reversalDate: null reversedVoidPaymentKey: null reversedDate: null lines: - key: '1101' id: '1101' otherReceipts: key: '557' id: '557' recordType: cr href: /objects/cash-management/other-receipt/557 glAccount: key: '222' id: '5008' title: Payments - Contract href: /objects/general-ledger/account/222 arAccountLabel: key: '35' id: '35' label: Sales href: /objects/accounts-receivable/account-label/35 amount: '150.00' txnAmount: '150.00' dimensions: department: number: '21' id: OPEE name: Operations key: '21' href: /objects/company-config/department/21 location: id: CAG name: Calgary key: '30' href: /objects/company-config/location/30 description: Logo display exchangeRate: date: null typeId: null rate: 1 lineNumber: 1 currency: USD baseCurrency: USD status: active audit: createdDateTime: '2023-09-07T21:44:43Z' modifiedDateTime: '2023-09-07T21:44:44Z' createdBy: '1' modifiedBy: '1' isTax: false orderEntryTaxDetail: key: null taxRate: null id: null href: /objects/cash-management/other-receipt-line/1101 href: /objects/cash-management/other-receipt/557 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an other receipts object description: >+ Updates an existing other receipts object by setting field values. Any fields not provided remain unchanged. Only transactions in an open sub-ledger period, which have not yet been deposited, can be updated.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness
PermissionsList, Edit Other receipts
tags: - Cash_Management_Other receipts operationId: update-cash-management-other-receipt-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-other-receipt' - type: object properties: id: readOnly: true examples: Update an other receipts object: value: description: 2023 Conference booth fee description: '' responses: '200': description: OK content: application/json: schema: type: object title: Updated other-receipt properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update an other receipts object: value: ia::result: key: '500' id: '500' href: /objects/cash-management/other-receipt/500 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an other receipts object description: >+ Deletes an other receipts object. Only those receipts that have not yet been deposited or reconciled that are in an open period can be deleted.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness
PermissionsList, View, Delete Other receipts
tags: - Cash_Management_Other receipts operationId: delete-cash-management-other-receipt-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/other-receipt-line: get: summary: List other receipts lines description: >+ Returns a collection with a key, ID, and link for each other receipts line item. 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
SubscriptionCash Management
User ypeBusiness
PermissionsList, View Other receipts
tags: - Cash_Management_Other receipts lines operationId: list-cash-management-other-receipt-line responses: '200': description: OK content: application/json: schema: type: object title: List of other-receipt-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List other receipts lines: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/other-receipt-line/1 - key: '3' id: '3' href: /objects/cash-management/other-receipt-line/3 - key: '5' id: '5' href: /objects/cash-management/other-receipt-line/5 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/other-receipt-line/{key}: parameters: - name: key description: System-assigned key for the other receipts line item. in: path required: true schema: type: string get: summary: Get an other receipts line description: >+ Returns detailed information for a specified other receipts line item.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness
PermissionsList, View Other receipts
tags: - Cash_Management_Other receipts lines operationId: get-cash-management-other-receipt-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the other-receipt-line properties: ia::result: $ref: '#/components/schemas/cash-management-other-receipt-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an other receipts line: value: ia::result: key: '821' id: '821' otherReceipts: key: '415' id: '415' recordType: cr href: /objects/cash-management/other-receipt/415 glAccount: key: '194' id: '4000' title: Accounts Payable href: /objects/general-ledger/account/194 arAccountLabel: key: '35' id: '35' label: Sales href: /objects/accounts-receivable/account-label/35 amount: '101.11' txnAmount: '101.11' dimensions: department: key: null id: null number: null name: null href: null location: number: '1' id: '1' name: United States of America key: '1' href: /objects/company-config/location/1 description: Refund for overpayment exchangeRate: date: '2021-01-15' typeId: null rate: 1 lineNumber: 1 currency: USD baseCurrency: USD status: active audit: createdDateTime: '2022-10-25T22:38:22Z' modifiedDateTime: '2022-10-25T22:38:22Z' createdBy: '1' modifiedBy: '1' isTax: false orderEntryTaxDetail: key: null taxRate: null id: null href: /objects/cash-management/other-receipt-line/821 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn-template: get: summary: List credit card transaction templates description: >- Returns a collection with a key, ID, and link for each credit card txn template. 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: - Cash_Management_Credit card transaction templates operationId: list-cash-management-credit-card-txn-template responses: '200': description: OK content: application/json: schema: type: object title: List of credit-card-txn-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List credit card transaction templates: value: ia::result: - key: '4' id: test-bugfix-top-vat-1 href: /objects/cash-management/credit-card-txn-template/4 - key: '2' id: cc-txntmpl1 href: /objects/cash-management/credit-card-txn-template/2 - key: '3' id: test-ui-cc-txn-vat-1 href: /objects/cash-management/credit-card-txn-template/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a credit card transaction template description: Creates a new credit card transaction template. tags: - Cash_Management_Credit card transaction templates operationId: create-cash-management-credit-card-txn-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-credit-card-txn-template' - $ref: '#/components/schemas/cash-management-credit-card-txn-templateRequiredProperties' examples: Create a credit card transaction template: value: id: cctxn-tmplate-1 name: CC txn template NA description: template to create CC txn for bank txn lines: - lineNumber: 1 isBillable: true glAccount: key: '326' dimensions: location: id: North America Create a CC transaction template with tax: value: id: CC-TXN template inbound-tax-aus name: CC txn template-inbound-tax-aus description: CC txn template-inbound-tax AUS GST taxImplication: inbound taxSolution: id: Australia - GST taxSchedule: id: '77' lines: - lineNumber: 1 isBillable: false glAccount: key: '327' dimensions: location: id: '33' responses: '201': description: Created content: application/json: schema: type: object title: New credit-card-txn-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New credit card transaction template: value: ia::result: key: '78' id: cctxn-tmplate-1 href: /objects/cash-management/credit-card-txn-template/78 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Create a CC transaction template with tax: value: ia::result: key: '79' id: CC-TXN template inbound-tax-aus href: /objects/cash-management/credit-card-txn-template/79 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn-template/{key}: parameters: - name: key description: System-assigned key for the credit card txn template. in: path required: true schema: type: string example: '3' get: summary: Get a credit card transaction template description: Returns detailed information for a specified credit card txn template. tags: - Cash_Management_Credit card transaction templates operationId: get-cash-management-credit-card-txn-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the credit-card-txn-template properties: ia::result: $ref: '#/components/schemas/cash-management-credit-card-txn-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a credit card transaction template: value: ia::result: key: '3' id: test-ui-cc-txn-vat-1 name: test-ui-cc-txn-vat-1 description: test payee: payee-1 numberOfRulesUsingTemplate: 0 status: active audit: createdBy: '1' modifiedBy: '1' modifiedDateTime: '2022-11-29T21:45:22Z' taxImplication: inbound taxSolution: key: '1' id: Australia - GST href: /objects/tax/tax-solution/1 taxSchedule: name: G11 Other Acquisition key: '10' id: '10' href: /objects/tax/purchasing-tax-schedule/10 isInclusiveTax: true lines: - key: '3' id: '3' creditCardTxnTemplate: key: '3' href: '/objects/cash-management/credit-card-txn-template/3' memo: null glAccount: key: '249' id: '6003' name: Workmans Compensation href: /objects/general-ledger/account/249 dimensions: location: id: null name: null project: key: null id: null name: null customer: key: null id: null name: null vendor: key: null id: null name: null employee: key: null id: null name: null item: key: null id: null name: null class: key: null id: null name: null lineNumber: 0 accountLabel: id: null exchangeRate: date: null typeId: null rate: null isBillable: null audit: createdDateTime: '2022-11-29T21:45:22Z' modifiedDateTime: '2022-11-29T21:45:22Z' createdBy: '1' modifiedBy: '1' href: '/objects/cash-management/credit-card-txn-line-template/3' href: /objects/cash-management/credit-card-txn-template/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a credit card transaction template description: >- Updates an existing credit card txn template by setting field values. Any fields not provided remain unchanged. tags: - Cash_Management_Credit card transaction templates operationId: update-cash-management-credit-card-txn-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-credit-card-txn-template' - type: object properties: id: readOnly: true examples: Update a CC transaction template: value: key: '189' lines: - key: '160' lineNumber: 1 isBillable: false responses: '200': description: OK content: application/json: schema: type: object title: Updated credit-card-txn-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated CC transaction template: value: ia::result: key: '189' id: cc-txn-tmpl-api24 href: /objects/cash-management/credit-card-txn-template/189 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a credit card transaction template description: Deletes a credit card transaction template. tags: - Cash_Management_Credit card transaction templates operationId: delete-cash-management-credit-card-txn-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn-line-template: get: summary: List credit card txn line templates description: >- Returns a collection with a key, ID, and link for each credit card transaction line template. 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: - Cash_Management_Credit card transaction line templates operationId: list-cash-management-credit-card-txn-line-template responses: '200': description: OK content: application/json: schema: type: object title: List of credit-card-txn-line-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List line templates: value: ia::result: - key: '3' id: '3' href: '/objects/cash-management/credit-card-txn-line-template/3' - key: '6' id: '6' href: '/objects/cash-management/credit-card-txn-line-template/6' - key: '2' id: '2' href: '/objects/cash-management/credit-card-txn-line-template/2' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn-line-template/{key}: parameters: - name: key description: >- System-assigned unique key for the credit card transaction line template. in: path required: true schema: type: string example: '5' get: summary: Get a credit card transaction line template description: >- Returns detailed information for a specified credit card transaction line template. tags: - Cash_Management_Credit card transaction line templates operationId: get-cash-management-credit-card-txn-line-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the credit-card-txn-line-template properties: ia::result: $ref: '#/components/schemas/cash-management-credit-card-txn-line-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a line template: value: ia::result: key: '98' id: '98' creditCardTxnTemplate: key: '117' href: /objects/cash-management/credit-card-txn-template/117 memo: cc txn line memo glAccount: key: '339' id: '7505' name: Other Marketing href: /objects/general-ledger/account/339 dimensions: location: id: '7' name: Canada project: key: '11' id: CON name: Contract - QuickMedia M C Services href: /objects/projects/project/11 customer: key: '5' id: MR1 name: QuickMedia M C Services href: /objects/accounts-receivable/customer/5 vendor: key: '50' id: '204' name: Yamaguchi Garden Supply href: /objects/accounts-payable/vendor/50 employee: key: '29' id: '234' name: Reyes href: /objects/company-config/employee/29 item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 class: key: '9' id: REES name: Real Estate href: /objects/company-config/class/9 lineNumber: 1 accountLabel: id: null exchangeRate: date: null typeId: null rate: null isBillable: null audit: createdDateTime: '2022-06-22T20:09:18Z' modifiedDateTime: '2022-06-22T20:09:18Z' createdBy: '1' modifiedBy: '1' href: '/objects/cash-management/credit-card-txn-line-template/98' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/journal-entry-template: get: summary: List journal entry templates description: >- Returns a collection with a key, ID, and link for each journal entry template. 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: - Cash_Management_Journal entry templates operationId: list-cash-management-journal-entry-template responses: '200': description: OK content: application/json: schema: type: object title: List of journal-entry-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List journal entry transaction templates: value: ia::result: - key: '1' id: vat-je-tmpl-ui1 href: /objects/cash-management/journal-entry-template/1 - key: '3' id: test-add-je-tmpl-ui-tax href: /objects/cash-management/journal-entry-template/3 - key: '4' id: '1' href: /objects/cash-management/journal-entry-template/4 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a journal entry template description: Creates a new journal entry template. tags: - Cash_Management_Journal entry templates operationId: create-cash-management-journal-entry-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-journal-entry-template' - $ref: '#/components/schemas/cash-management-journal-entry-templateRequiredProperties' examples: Create a journal entry transaction template: value: id: GL-CreateRule-5 name: GL-CreateRule-5 description: GL-CreateRule-5 postingState: draft status: active glJournal: id: APJ lines: - dimensions: location: id: '1' glAccount: key: '316' documentId: null memo: GL-CreateRule-5 responses: '201': description: Created content: application/json: schema: type: object title: New journal-entry-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New journal entry transaction template: value: ia::result: key: '78' id: GL-CreateRule-5 href: /objects/cash-management/journal-entry-template/78 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/journal-entry-template/{key}: parameters: - name: key description: System-assigned key for the journal entry template. in: path required: true schema: type: string example: '3' get: summary: Get a journal entry template description: Returns detailed information for a specified journal entry template. tags: - Cash_Management_Journal entry templates operationId: get-cash-management-journal-entry-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the journal-entry-template properties: ia::result: $ref: '#/components/schemas/cash-management-journal-entry-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a journal entry transaction template: value: ia::result: key: '3' name: test-add-je-tmpl-ui-tax description: null glJournal: id: CCJ key: '9' href: /objects/general-ledger/journal/9 postingState: draft status: active id: test-add-je-tmpl-ui-tax audit: createdDateTime: '2022-11-29T21:27:09Z' modifiedDateTime: '2022-11-29T21:27:09Z' createdBy: '1' modifiedBy: '1' taxImplication: inbound taxSolution: key: '2' id: United Kingdom - VAT href: /objects/tax/tax-solution/2 salesTaxSchedule: name: null key: null id: null purchasingTaxSchedule: name: EC Purchase Goods Exempt Rate key: '76' id: '76' href: /objects/tax/purchasing-tax-schedule/76 vendor: key: '48' id: '202' name: Pac Bell href: /objects/accounts-payable/vendor/48 customer: key: null id: null name: null lines: - key: '3' id: '3' journalEntryTemplate: id: '3' key: '3' href: /objects/cash-management/journal-entry-template/3 dimensions: location: key: null id: null name: null department: id: null project: key: null id: null name: null customer: key: null id: null name: null vendor: key: null id: null name: null employee: key: null id: null name: null item: key: null id: null name: null class: key: null id: null name: null warehouse: key: null id: null name: null glAccount: key: '334' id: '7500' name: Penalties href: /objects/general-ledger/account/334 documentId: null txnType: null memo: null allocation: key: null id: null numberOfUnits: null exchangeRate: date: null typeId: null rate: null isBillable: false href: '/objects/cash-management/journal-entry-line-template/3' href: /objects/cash-management/journal-entry-template/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a journal entry template description: >- Updates an existing journal entry template by setting field values. Any fields not provided remain unchanged. tags: - Cash_Management_Journal entry templates operationId: update-cash-management-journal-entry-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-journal-entry-template' - type: object properties: id: readOnly: true examples: Update a journal entry transaction template: value: postingState: posted responses: '200': description: OK content: application/json: schema: type: object title: Updated journal-entry-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated journal entry transaction template: value: ia::result: key: '6' id: '3' href: /objects/cash-management/journal-entry-template/6 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a journal entry template description: Deletes a journal entry template. tags: - Cash_Management_Journal entry templates operationId: delete-cash-management-journal-entry-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/journal-entry-line-template: get: summary: List journal entry line templates. description: >- Returns a collection with a key, ID, and link for each journal entry line template. 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: - Cash_Management_Journal entry line templates operationId: list-cash-management-journal-entry-line-template responses: '200': description: OK content: application/json: schema: type: object title: List of journal-entry-line-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List line templates: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/journal-entry-line-template/1 - key: '2' id: '2' href: /objects/cash-management/journal-entry-line-template/2 - key: '7' id: '7' href: /objects/cash-management/journal-entry-line-template/7 ia::meta: totalCount: 6 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/journal-entry-line-template/{key}: parameters: - name: key description: System-assigned key for the journal entry line template. in: path required: true schema: type: string example: '5' get: summary: Get a journal entry line template description: >- Returns detailed information for a specified journal entry line template. tags: - Cash_Management_Journal entry line templates operationId: get-cash-management-journal-entry-line-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the journal-entry-line-template properties: ia::result: $ref: '#/components/schemas/cash-management-journal-entry-line-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a line template: value: ia::result: key: '8' id: '8' journalEntryTemplate: id: '9' key: '9' href: /objects/cash-management/journal-entry-template/9 dimensions: location: key: '7' id: '7' name: Canada href: /objects/company-config/location/7 department: id: '8' project: key: null id: null name: null customer: key: null id: null name: null vendor: key: null id: null name: null employee: key: null id: null name: null item: key: null id: null name: null class: key: null id: null name: null glAccount: key: '207' id: '5001' name: Construction href: /objects/general-ledger/account/207 documentId: doc 1 txnType: null memo: null allocation: key: '2' id: alloc-create-gl-from-UI numberOfUnits: null exchangeRate: date: null typeId: null rate: null isBillable: false href: /objects/cash-management/journal-entry-line-template/8 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-set: get: summary: List bank transaction rule sets description: >+ Returns a collection with a key, ID, and link for each rules. 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
SubscriptionCash Management
User ypeBusiness
PermissionsList Bank transaction rule sets
tags: - Cash_Management_Bank transaction rule sets responses: '200': description: OK content: application/json: schema: type: object title: List of Rule set objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bank transaction rule sets: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/bank-txn-rule-set/1 - key: '2' id: '2' href: /objects/cash-management/bank-txn-rule-set/2 - key: '3' id: '3' href: /objects/cash-management/bank-txn-rule-set/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' operationId: list-cash-management-bank-txn-rule-set security: - OAuth2: [] post: summary: Create a bank transaction rule set description: >+ Creates a new bank transaction rule set.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness
PermissionsAdd Bank transaction rule sets
tags: - Cash_Management_Bank transaction rule sets operationId: create-cash-management-bank-txn-rule-set requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-bank-txn-rule-set' - $ref: '#/components/schemas/cash-management-bank-txn-rule-setRequiredProperties' examples: Create a bank transaction rule set: value: ruleSetId: Txn-Rule-Set-004 name: MBB Rule Set description: Primary rule set for MBB accountType: creditcard location: key: '1' status: active responses: '201': description: Created rule set content: application/json: schema: type: object title: New bank-txn-rule-set properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a bank transaction rule set: value: ia::result: key: '5' id: '5' href: /objects/cash-management/bank-txn-rule-set/5 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-set/{key}: parameters: - schema: type: string example: '11' name: key in: path required: true description: System-assigned key for the bank transaction rule set. get: summary: Get a bank transaction rule set description: >+ Returns detailed information for a specified bank transaction rule set.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness
PermissionsList, View Bank transaction rule sets
tags: - Cash_Management_Bank transaction rule sets operationId: get-cash-management-bank-txn-rule-set-key responses: '200': description: OK content: application/json: schema: type: object title: Detail of the rule set properties: ia::result: $ref: '#/components/schemas/cash-management-bank-txn-rule-set' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get a bank transaction rule set: value: ia::result: id: '2' key: '2' ruleSetId: BankRuleSetChase name: Rule set for chase bank description: Primary rule set for CB accountType: bank numberOfAccounts: 7 numberOfRules: 1 status: active location: key: '5' audit: createdDateTime: '2022-01-26T00:15:14Z' modifiedDateTime: '2023-03-24T21:41:10Z' createdBy: '68' modifiedBy: '68' rules: - id: '26' key: '26' bankTxnRule: id: '11' key: '11' ruleId: gl-create-rule-2 name: gl-create-rule-2 ruleType: create href: /objects/cash-management/bank-txn-rule/11 bankTxnRuleSet: id: '2' key: '2' href: /objects/cash-management/bank-txn-rule-set/2 ruleOrder: 1 audit: createdDateTime: '2023-03-24T00:00:00Z' modifiedDateTime: '2023-03-24T00:00:00Z' createdBy: '68' modifiedBy: '68' href: /objects/cash-management/bank-txn-rule-map/26 href: /objects/cash-management/bank-txn-rule-set/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a bank transaction rule set description: >+ Updates an existing bank transaction rule set by setting field values. Any fields not provided remain unchanged. Updating a rule set affects matches for incoming transactions going forward for every associated account that uses the rule set. Updating a rule set does not affect transactions that have already been matched.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness
PermissionsList, Edit Bank transaction rule sets
tags: - Cash_Management_Bank transaction rule sets operationId: update-cash-management-bank-txn-rule-set-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-bank-txn-rule-set' - type: object properties: id: readOnly: true examples: Update a single value: value: status: inactive description: '' responses: '200': description: OK content: application/json: schema: type: object title: Updated bank-txn-rule-set properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a bank transaction rule set: value: ia::result: key: '4' id: '4' href: /objects/cash-management/bank-txn-rule-set/4 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a bank transaction rule set description: >+ Deletes a bank transaction rule set.
Permissions and other requirements
SubscriptionCash Management
User ypeBusiness
PermissionsList, Delete Bank transaction rule sets
tags: - Cash_Management_Bank transaction rule sets operationId: delete-cash-management-bank-txn-rule-set-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule: get: summary: List bank transaction rules description: >- Returns a collection with a key, ID, and link for each bank transaction rule. 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: - Cash_Management_Bank transaction rules operationId: list-cash-management-bank-txn-rule responses: '200': description: OK content: application/json: schema: type: object title: List of bank-txn-rule objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bank transaction rules: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/bank-txn-rule/1 - key: '3' id: '3' href: /objects/cash-management/bank-txn-rule/3 - key: '4' id: '4' href: /objects/cash-management/bank-txn-rule/4 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a bank transaction rule description: Creates a new bank transaction rule. tags: - Cash_Management_Bank transaction rules operationId: create-cash-management-bank-txn-rule requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-bank-txn-rule' - $ref: '#/components/schemas/cash-management-bank-txn-ruleRequiredProperties' examples: Create a bank transaction rule to add JE: value: ruleId: JE rule description: Rule to create journal entry name: 'Create GL rule ' ruleType: create createRuleObject: objectType: journalEntry journalEntryTemplate: id: '1' filterAttributes: - dataSource: bankTransaction bankTxnAttribute: postingDate operator: greaterThan value: 11/10/2023 - dataSource: bankTransaction bankTxnAttribute: transactionType operator: equals value: withdrawal Create a match bank transaction rule: value: ruleId: boa-document-amount-match-3 description: Match rule for boa accounts by doc number name: Match by amount and doc number ruleType: match matchRuleAttributes: - intacctTxnAttribute: amount bankTxnAttribute: amount operator: equals order: 2 - intacctTxnAttribute: documentNumber bankTxnAttribute: documentNumber operator: equals order: 1 filterAttributes: - dataSource: intacctTransaction intacctTxnAttribute: documentNumber operator: equals value: doc1002 Create a bank transaction rule to add CC txn: value: ruleId: cctxn_rule_1 name: Create CC txn from bank txn description: 'Rule to create CC txn from bank txn ' ruleType: create location: id: '1' createRuleObject: objectType: cctransaction creditCardTxnTemplate: id: '2' filterAttributes: - dataSource: bankTransaction bankTxnAttribute: postingDate operator: greaterThan value: 07/04/2022 responses: '201': description: Created content: application/json: schema: type: object title: New bank-txn-rule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a bank transaction rule: value: ia::result: key: '15' id: '15' href: /objects/cash-management/bank-txn-rule/15 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule/{key}: parameters: - name: key description: System-assigned key for the bank transaction rule. in: path required: true schema: type: string example: '11' get: summary: Get a bank transaction rule description: Returns detailed information for a specified bank transaction rule.. tags: - Cash_Management_Bank transaction rules operationId: get-cash-management-bank-txn-rule-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bank-txn-rule properties: ia::result: $ref: '#/components/schemas/cash-management-bank-txn-rule' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bank transaction create rule: value: ia::result: id: '79' key: '79' ruleId: gl-boa-create-rule-1 name: Create-GL-credit-card-rule-1 description: Create GL rule for bank account BOA ruleType: create createRuleObject: objectType: journalEntry journalEntryTemplate: id: '1' key: '1' href: /objects/cash-management/journal-entry-template/1 creditCardTxnTemplate: id: null key: null status: active location: key: null rulesetCount: 0 audit: createdDateTime: '2023-08-03T16:38:31Z' modifiedDateTime: '2023-08-03T16:38:31Z' createdBy: '1' modifiedBy: '1' filterAttributes: - id: '81' key: '81' bankTransactionRule: id: '79' key: '79' href: /objects/cash-management/bank-txn-rule/79 dataSource: bankTransaction intacctTxnAttribute: null bankTxnAttribute: postingDate operator: greaterThan value: 01/10/2022 order: 0 href: /objects/cash-management/bank-txn-rule-filter/81 - id: '82' key: '82' bankTransactionRule: id: '79' key: '79' href: /objects/cash-management/bank-txn-rule/79 dataSource: bankTransaction intacctTxnAttribute: null bankTxnAttribute: transactionType operator: equals value: payment order: 1 href: /objects/cash-management/bank-txn-rule-filter/82 groupAttributes: [] matchRuleAttributes: [] href: /objects/cash-management/bank-txn-rule/79 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Get a match bank transaction rule: value: ia::result: id: '1' key: '1' ruleId: MatchAmountPlusDateRange name: Match amount and 2 days range description: Match amount and 2 days range ruleType: match createRuleObject: objectType: journalEntry journalEntryTemplate: id: null key: null creditCardTxnTemplate: id: null key: null status: active location: key: null rulesetCount: 3 audit: createdDateTime: '2022-01-26T00:12:34Z' modifiedDateTime: '2022-01-26T00:12:34Z' createdBy: '1' modifiedBy: '1' filterAttributes: [] groupAttributes: [] matchRuleAttributes: - id: '1' key: '1' bankTransactionRule: id: '1' key: '1' href: /objects/cash-management/bank-txn-rule/1 intacctTxnAttribute: amount bankTxnAttribute: amount operator: equals value: null order: 1 href: /objects/cash-management/bank-txn-rule-match/1 - id: '2' key: '2' bankTransactionRule: id: '1' key: '1' href: /objects/cash-management/bank-txn-rule/1 intacctTxnAttribute: postingDate bankTxnAttribute: postingDate operator: within value: '2' order: 2 href: /objects/cash-management/bank-txn-rule-match/2 href: /objects/cash-management/bank-txn-rule/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a bank transaction rule description: >- Updates an existing bank transaction rule by setting field values. Any fields not provided remain unchanged. tags: - Cash_Management_Bank transaction rules operationId: update-cash-management-bank-txn-rule-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-bank-txn-rule' - type: object properties: id: readOnly: true examples: Update a bank transaction rule: value: matchRuleAttributes: - key: '7' order: 5 - key: '11' intacctTxnAttribute: description bankTxnAttribute: description operator: contains value: abc1000 order: 10 description: '' responses: '200': description: OK content: application/json: schema: type: object title: Updated bank-txn-rule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a bank transaction rule: value: ia::result: key: '4' id: '4' href: /objects/cash-management/bank-txn-rule/4 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a bank transaction rule description: Deletes a bank transaction rule. tags: - Cash_Management_Bank transaction rules operationId: delete-cash-management-bank-txn-rule-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-filter: get: summary: List Bank transaction rule filter attributes description: >- Returns a collection with a key, ID, and link for each bank transaction rule filter attribute. tags: - Cash_Management_Bank transaction rule filter attributes operationId: list-cash-management-bank-txn-rule-filter responses: '200': description: OK content: application/json: schema: type: object title: List of bank transaction rule filter objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bank transaction rule filter attributes: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/bank-txn-rule-filter/1 - key: '2' id: '2' href: /objects/cash-management/bank-txn-rule-filter/2 - key: '3' id: '3' href: /objects/cash-management/bank-txn-rule-filter/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-filter/{key}: parameters: - name: key description: >- System-assigned unique key for the bank transaction rule filter attribute. in: path required: true schema: type: string example: '8' get: summary: Get a bank transaction rule filter attribute description: >- Returns detailed information for a specified bank transaction rule filter attribute. tags: - Cash_Management_Bank transaction rule filter attributes operationId: get-cash-management-bank-txn-rule-filter-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bank transaction rule filter attribute properties: ia::result: $ref: '#/components/schemas/cash-management-bank-txn-rule-filter' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bank transaction rule filter attribute: value: ia::result: key: '110' id: '110' bankTransactionRule: id: '3' key: '3' href: /objects/cash-management/bank-txn-rule/3 dataSource: intacctTransaction intacctTxnAttribute: postingDate bankTxnAttribute: null operator: equals value: 10/11/2023 href: /objects/cash-management/bank-txn-rule-filter/110 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-group: get: summary: List bank transaction rule group attributes description: >- Returns a collection with a key, ID, and link for each bank transaction rule group attribute. tags: - Cash_Management_Bank transaction rule group attributes operationId: list-cash-management-bank-txn-rule-group responses: '200': description: OK content: application/json: schema: type: object title: List of bank transaction rule group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bank transaction rule group attributes: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/bank-txn-rule-group/1 - key: '2' id: '2' href: /objects/cash-management/bank-txn-rule-group/2 - key: '3' id: '3' href: /objects/cash-management/bank-txn-rule-group/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-group/{key}: parameters: - name: key description: System-assigned key for the bank transaction rule group attribute. in: path required: true schema: type: string example: '9' get: summary: Get a bank transaction rule group attribute description: >- Returns detailed information for a specified bank transaction rule group attribute. tags: - Cash_Management_Bank transaction rule group attributes operationId: get-cash-management-bank-txn-rule-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bank-txn-rule-group properties: ia::result: $ref: '#/components/schemas/cash-management-bank-txn-rule-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bank transaction rule group attribute: value: ia::result: key: '110' id: '110' bankTransactionRule: id: '3' key: '3' href: /objects/cash-management/bank-txn-rule/3 dataSource: intacctTransaction intacctTxnAttribute: postingDate bankTxnAttribute: null href: /objects/cash-management/bank-txn-rule-group/110 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-map: get: summary: List bank transaction rule maps description: >- Returns a collection with a key, ID, and link for each bank transaction rule map. tags: - Cash_Management_Bank transaction rule maps operationId: list-cash-management-bank-txn-rule-map responses: '200': description: OK content: application/json: schema: type: object title: List bank transaction rule map objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bank transaction rule maps: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/bank-txn-rule-map/1 - key: '26' id: '26' href: /objects/cash-management/bank-txn-rule-map/26 - key: '182' id: '182' href: /objects/cash-management/bank-txn-rule-map/182 ia::meta: totalCount: 25 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-map/{key}: parameters: - name: key description: System-assigned unique key for the bank transaction rule map. in: path required: true schema: type: string example: '6' get: summary: Get a bank transaction rule map description: Returns detailed information for a specified bank transaction rule map. tags: - Cash_Management_Bank transaction rule maps operationId: get-cash-management-bank-txn-rule-map-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bank-txn-rule-map properties: ia::result: $ref: '#/components/schemas/cash-management-bank-txn-rule-map' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bank transaction rule map: value: ia::result: id: '11' key: '11' bankTxnRule: id: '11' key: '11' ruleId: gl-create-rule-2 name: gl-create-rule-2 ruleType: create href: /objects/cash-management/bank-txn-rule/11 bankTxnRuleSet: id: '1' key: '1' href: /objects/cash-management/bank-txn-rule-set/1 ruleOrder: 7 audit: createdDateTime: '2023-09-13T00:00:00Z' modifiedDateTime: '2023-09-13T00:00:00Z' createdBy: '1' modifiedBy: '1' href: /objects/cash-management/bank-txn-rule-map/11 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a bank transaction rule map description: Deletes a bank transaction rule map. tags: - Cash_Management_Bank transaction rule maps operationId: delete-cash-management-bank-txn-rule-map-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-match: get: summary: List bank transaction rule match attributes description: >- Returns a collection with a key, ID, and link for each bank transaction rule match attribute. tags: - Cash_Management_Bank transaction rule match attributes operationId: list-cash-management-bank-txn-rule-match responses: '200': description: OK content: application/json: schema: type: object title: List bank transaction rule match objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bank transaction rule match attributes: value: ia::result: - key: '97' id: '97' href: /objects/cash-management/bank-txn-rule-match/97 - key: '100' id: '100' href: /objects/cash-management/bank-txn-rule-match/100 - key: '104' id: '104' href: /objects/cash-management/bank-txn-rule-match/104 ia::meta: totalCount: 70 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-match/{key}: parameters: - name: key description: >- System-assigned unique key for the bank transaction rule match attribute. in: path required: true schema: type: string example: '11' get: summary: Get a bank transaction rule match attribute description: >- Returns detailed information for a specified bank transaction rule match attribute. tags: - Cash_Management_Bank transaction rule match attributes operationId: get-cash-management-bank-txn-rule-match-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bank-txn-rule-match properties: ia::result: $ref: '#/components/schemas/cash-management-bank-txn-rule-match' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bank transaction rule match attribute: value: ia::result: key: '90' id: '90' intacctTxnAttribute: description bankTxnAttribute: description operator: contains value: payee-1 order: 6 href: /objects/cash-management/bank-txn-rule-match/90 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposited-fund: get: summary: List deposited funds description: Returns a collection with a key, ID, and link for each deposited fund. tags: - Cash_Management_Deposited funds operationId: list-cash-management-deposited-fund responses: '200': description: OK content: application/json: schema: type: object title: List of deposited-fund objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of deposited funds: value: ia::result: - key: '201' id: '201' href: /objects/cash-management/deposited-fund/201 - key: '202' id: '202' href: /objects/cash-management/deposited-fund/202 - key: '203' id: '203' href: /objects/cash-management/deposited-fund/203 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposited-fund/{key}: parameters: - name: key description: System-assigned unique key for the deposited fund. in: path required: true schema: type: string get: summary: Get a deposited fund description: Returns detailed information for a specified deposited fund. tags: - Cash_Management_Deposited funds operationId: get-cash-management-deposited-fund-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the deposited fund properties: ia::result: $ref: '#/components/schemas/cash-management-deposited-fund' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a deposited fund: value: ia::result: id: '587' key: '587' deposit: id: '291' key: '291' depositType: cd href: /objects/cash-management/deposit/291 glAccount: id: '33' key: '33' accountNumber: '1070' name: Undeposited Funds href: /objects/general-ledger/account/33 arAccountLabel: label: null id: null key: null amount: '1002.00' txnAmount: '1002.00' department: key: null id: null name: null location: key: '1' name: United States of America href: /objects/company-config/location/1 baseLocation: name: United States of America key: null description: Deposited fund from GoPro sale exchangeRate: date: '2022-01-23' typeId: '-1' rate: 1 currency: USD baseCurrency: USD status: active audit: createdDateTime: '2021-04-16T00:57:25Z' modifiedDateTime: '2021-04-16T00:57:43Z' createdBy: '1' modifiedBy: '1' href: /objects/cash-management/deposit-line/587 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/undeposited-fund: get: summary: List undeposited funds description: Returns a collection with a key, ID, and link for each undeposited fund. tags: - Cash_Management_Undeposited funds operationId: list-cash-management-undeposited-fund responses: '200': description: OK content: application/json: schema: type: object title: List of undeposited-fund objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of undeposited funds: value: ia::result: - key: '182' id: '182' href: /objects/cash-management/undeposited-fund/182 - key: '193' id: '193' href: /objects/cash-management/undeposited-fund/193 - key: '501' id: '501' href: /objects/cash-management/undeposited-fund/501 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/undeposited-fund/{key}: parameters: - name: key description: System-assigned unique key for the undeposited fund. in: path required: true schema: type: string get: summary: Get an undeposited fund description: Returns detailed information for a specified undeposited fund. tags: - Cash_Management_Undeposited funds operationId: get-cash-management-undeposited-fund-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the undeposited-fund properties: ia::result: $ref: '#/components/schemas/cash-management-undeposited-fund' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an undeposited fund: value: ia::result: id: '587' key: '587' deposit: id: '291' key: '291' depositType: cd href: /objects/cash-management/deposit/291 glAccount: id: '33' key: '33' accountNumber: '1070' name: Undeposited Funds href: /objects/general-ledger/account/33 arAccountLabel: label: null id: null key: null amount: '1002.00' txnAmount: '1002.00' department: key: null id: null name: null location: key: '1' name: United States of America href: /objects/company-config/location/1 baseLocation: name: United States of America key: null description: Undeposited receipt from GoPro sales exchangeRate: date: '2022-01-23' typeId: '-1' rate: 1 currency: USD baseCurrency: USD status: active audit: createdDateTime: '2021-04-16T00:57:25Z' modifiedDateTime: '2021-04-16T00:57:43Z' createdBy: '1' modifiedBy: '1' href: /objects/cash-management/undeposited-fund/587 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '201': description: Created '400': $ref: '#/components/responses/400error' '401': description: Unauthorized security: - OAuth2: [] /objects/company-config/attachment: get: summary: List attachments description: >+ Returns up to 100 attachments from the collection with a key, ID, and link for each attachment. This operation is mostly for use in testing; use the query service to find attachments that meet certain criteria and specify the properties that are returned.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Project Manager, Platform, and Warehouse
PermissionsList Attachments
tags: - Company_and_Configuration_Attachments responses: '200': description: OK content: application/json: schema: type: object title: List of attachment objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of attachments: value: ia::result: - key: '8' id: PROJ-159 href: /objects/company-config/attachment/8 - key: '1' id: INVOICES href: /objects/company-config/attachment/1 - key: '2' id: 2022 Taxes href: /objects/company-config/attachment/2 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' operationId: list-company-config-attachment security: - OAuth2: [] post: summary: Create an attachment description: >+ Creates a new attachment in a specified folder. You can add files when you create an attachment, or use a PATCH request to add files later.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsAdd Attachments
tags: - Company_and_Configuration_Attachments operationId: create-company-config-attachment requestBody: description: Attachment to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-attachment' - $ref: '#/components/schemas/company-config-attachmentRequiredProperties' examples: Create an empty attachment: value: id: 2022 Tax name: 2022 Tax Forms folder: key: '27' Create an attachment that contains a file: value: id: attach-02 name: Short text file folder: key: '1' files: - name: short file.txt data: aGVsbG8gd29ybGQhIHRoaXMgaXMgYmFzZTY0IGVuY29kZWQgZGF0YQ== responses: '201': description: Created content: application/json: schema: type: object title: Reference to new attachment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new attachment: value: ia::result: key: '17' id: 2022 Tax href: /objects/company-config/attachment/17 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/attachment/{key}: parameters: - name: key description: System-assigned key for the attachment. in: path required: true example: '43' schema: type: string get: summary: Get an attachment description: >+ Returns detailed information for a specified attachment, including Base64-encoded versions of all files in the attachment.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Project Manager, Platform, and Warehouse
PermissionsList Attachments
tags: - Company_and_Configuration_Attachments operationId: get-company-config-attachment-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the attachment properties: ia::result: $ref: '#/components/schemas/company-config-attachment' ia::meta: $ref: '#/components/schemas/metadata' examples: Attachment details: value: ia::result: key: '17' id: INV-V1 name: Vendor 1 Invoices folder: id: Invoices key: '1' href: /objects/company-config/folder/1 description: null audit: createdBy: matthew.mikawber modifiedBy: matthew.mikawber modifiedDate: '2023-05-25' createdDate: '2023-05-25' files: - id: '29' key: '29' attachment: key: '17' data: >- aGVsbG8gd29ybGQhIHRoaXMgaXMgYmFzZTY0IGVuY29kZWQgZGF0YQ== name: short file.txt size: 40 href: /objects/company-config/attachment/17 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an attachment description: >+ Updates an existing attachment by setting field values. Any fields not provided remain unchanged. Use this operation to add, update, and delete files in attachments.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsEdit Attachments
tags: - Company_and_Configuration_Attachments operationId: update-company-config-attachment-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-attachment' - type: object properties: id: readOnly: true examples: Add a file to an attachment: value: files: - name: short file 2.txt data: aGVsbG8gd29ybGQhIHRoaXMgaXMgYmFzZTY0IGVuY29kZWQgZGF0YQ== Delete a file from an attachment: value: files: - key: '29' ia::operation: delete responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated attachment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated attachment: value: ia::result: key: '17' id: attach-02 href: /objects/company-config/attachment/17 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an attachment description: >+ Deletes a attachment and all files that it contains. You must first remove the attachment from any records or transactions.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Project Manager, Platform, and Warehouse
PermissionsList Attachments
tags: - Company_and_Configuration_Attachments operationId: delete-company-config-attachment-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/folder: get: summary: List folders description: >+ Returns up to 100 folders from the collection with a key, ID, and link for each folder. This operation is mostly for use in testing; use the query service to find folders that meet certain criteria and specify the properties that are returned.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Project Manager, and Warehouse
PermissionsList Attachment Folders
tags: - Company_and_Configuration_Attachment folders operationId: list-company-config-folder responses: '200': description: OK content: application/json: schema: type: object title: List of folder objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Folder list: value: ia::result: - key: '1' id: Bills href: /objects/company-config/folder/1 - key: '2' id: Credits href: /objects/company-config/folder/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a folder description: |+ Creates a new folder for attachments.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsAdd Attachment Folders
tags: - Company_and_Configuration_Attachment folders operationId: create-company-config-folder requestBody: description: Folder to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-folder' - $ref: '#/components/schemas/company-config-folderRequiredProperties' examples: Create a folder: value: id: 2022 Bills description: Annual bills folder status: active responses: '201': description: Created content: application/json: schema: type: object title: New folder properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New folder: value: ia::result: key: '28' id: 2022 Bills href: /objects/company-config/folder/28 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/folder/{key}: parameters: - name: key description: System-assigned key for the attachment folder. in: path required: true example: '28' schema: type: string get: summary: Get a folder description: >+ Returns detailed information for a specified folder.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Project Manager, and Warehouse
PermissionsView Attachment Folders
tags: - Company_and_Configuration_Attachment folders operationId: get-company-config-folder-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the folder properties: ia::result: $ref: '#/components/schemas/company-config-folder' ia::meta: $ref: '#/components/schemas/metadata' examples: Folder details: value: ia::result: key: '28' id: 2022 Bills parent: id: Bills key: '2' href: /objects/company-config/folder/2 description: Annual bills folder audit: createdDate: '2023-04-01' createdBy: Admin modifiedBy: Admin modifiedDate: '2023-04-01' status: active href: /objects/company-config/folder/28 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a folder description: >+ Updates an existing folder by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsEdit Attachment Folders
tags: - Company_and_Configuration_Attachment folders operationId: update-company-config-folder-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-folder' - type: object properties: id: readOnly: true examples: Change folder description: value: description: 2022 bills and dunning notices responses: '200': description: OK content: application/json: schema: type: object title: Folder updated properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Folder updated: value: ia::result: key: '1' id: Bills href: /objects/company-config/folder/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a folder description: >+ Deletes a folder and all of its subfolders and attachments. You must first remove the attachments from any records or transactions.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsDelete Attachment Folders
tags: - Company_and_Configuration_Attachment folders operationId: delete-company-config-folder-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/class: get: summary: List classes description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each object. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Payment Approver
PermissionsList, View Classes
tags: - Company_and_Configuration_Classes operationId: list-company-config-class responses: '200': description: OK content: application/json: schema: type: object title: List of class objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: list classes: value: ia::result: - key: '1' id: Class_1 href: /objects/company-config/class/1 - key: '2' id: Class_2 href: /objects/company-config/class/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a class description: >+ Creates a new class. You can think of this as adding a new value to the dimension that you can use to tag transactions for reporting.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsAdd Classes
tags: - Company_and_Configuration_Classes operationId: create-company-config-class requestBody: description: Class object to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-class' - $ref: '#/components/schemas/company-config-classRequiredProperties' examples: Create a single class: value: id: SW name: Software description: All software titles status: active Create a child class: value: id: SW-Office name: Office Software description: Office productivity software status: active parent: key: '1' responses: '201': description: Created content: application/json: schema: type: object title: New class properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New class created: value: ia::result: key: '1' id: SW href: /objects/company-config/class/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/class/{key}: parameters: - name: key description: System-assigned key for the class. in: path required: true example: '43' schema: type: string get: summary: Get a class description: >+ Returns detailed information for a specified class.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Payment Approver
PermissionsList, View Classes
tags: - Company_and_Configuration_Classes operationId: get-company-config-class-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the class properties: ia::result: $ref: '#/components/schemas/company-config-class' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a class: value: ia::result: key: '9' id: SW-Office name: Office Software description: Office productivity software status: active parent: key: '8' id: SW name: Software audit: createdDateTime: '2022-06-28T23:41:44Z' modifiedDateTime: '2022-06-29T15:52:18Z' createdBy: '68' modifiedBy: '68' href: /objects/company-config/class/9 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a class description: >+ Updates an existing class by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsEdit Classes
tags: - Company_and_Configuration_Classes operationId: update-company-config-class-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-class' - type: object properties: id: readOnly: true examples: Update a single value: value: name: Root one responses: '200': description: OK content: application/json: schema: type: object title: Updated class properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: key: '1' id: Class1 href: /objects/company-config/class/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a class description: >+ Deletes a class. You can delete a class if it is not being used or referenced. Deleted classes cannot be recovered.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsDelete Classes
tags: - Company_and_Configuration_Classes operationId: delete-company-config-class-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/contact: get: summary: List contacts description: >+ Returns up to 100 contacts from the collection with a key, ID, and link for each contact. This operation is mostly for use in testing; use the query service to find contacts that meet certain criteria and specify the properties that are returned.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Payment Approver
PermissionsList, View Contacts
tags: - Company_and_Configuration_Contacts operationId: list-company-config-contact responses: '200': description: OK content: application/json: schema: type: object title: List of contact objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List contacts: value: ia::result: - key: '265' id: Mary Cooper href: /objects/company-config/contact/265 - key: '263' id: John Doe href: /objects/company-config/contact/263 - key: '264' id: Alfred Mike href: /objects/company-config/contact/264 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a contact description: >+ Creates a new contact.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsAdd Contacts
tags: - Company_and_Configuration_Contacts operationId: create-company-config-contact requestBody: description: Contact object to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-contact' - $ref: '#/components/schemas/company-config-contactRequiredProperties' examples: Create a contact: value: id: AMoore prefix: Mr firstName: Andy lastName: Moore middleName: Robert printAs: Andy Moore companyName: Sage phone1: '9134598676' mobile: '9133132299' fax: '9134598677' email1: andy.moore@mycompany.com URL1: http://andy.exampledomain.com mailingAddress: addressLine1: 744 Edgewater Blvd city: Kansas City state: KS postCode: '66104' country: United States tax: isTaxable: true taxId: 123-12-1234 group: id: New York status: active responses: '201': description: Created content: application/json: schema: type: object title: New contact properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New contact created: value: ia::result: key: '312' id: AMoore href: /objects/company-config/contact/312 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/contact/{key}: parameters: - name: key description: System-assigned key for the contact. in: path required: true example: '65' schema: type: string get: summary: Get a contact description: >+ Returns detailed information for a specified contact.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Payment Approver
PermissionsList, View Contacts
tags: - Company_and_Configuration_Contacts responses: '200': description: OK content: application/json: schema: type: object title: Details of the contact properties: ia::result: $ref: '#/components/schemas/company-config-contact' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a contact: value: ia::result: key: '1257' id: AMoore companyName: Sage prefix: Mr firstName: Andy lastName: Moore middleName: Robert printAs: Andy Moore tax: isTaxable: true group: id: New York key: '6' href: /objects/company-config/contact-tax-group/6 taxId: 123-12-1234 phone1: '9134598676' phone2: null mobile: '9133132299' pager: null fax: '9134598677' email1: andy.moore@mycompany.com email2: null URL1: http://andy.exampledomain.com URL2: null showInContactList: true mailingAddress: addressLine1: 744 Edgewater Blvd addressLine2: null addressLine3: null city: Kansas City country: United States isoCountryCode: US postCode: '66104' state: KS status: active priceSchedule: id: null key: null discount: null priceList: id: null key: null href: /objects/company-config/contact/1257 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' operationId: get-company-config-contact-key security: - OAuth2: [] patch: summary: Update a contact description: >+ Updates an existing contact by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsEdit Contacts
tags: - Company_and_Configuration_Contacts operationId: update-company-config-contact-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-contact' - type: object properties: id: readOnly: true examples: Change contact's company name: value: companyName: Google Set a contact as non-taxable: value: tax: isTaxable: false responses: '200': description: OK content: application/json: schema: type: object title: Updated contact properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Contact updated: value: ia::result: key: '312' id: John href: /objects/company-config/contact/312 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a contact description: >+ Deletes a contact. You can delete a contact if it is not being used or referenced. Deleted contacts cannot be recovered.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsDelete Contacts
tags: - Company_and_Configuration_Contacts operationId: delete-company-config-contact-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/department: get: summary: List departments description: >+ Returns up to 100 department references from the collection with a key, ID, and link for each department. This operation is mostly for use in testing; use the query service to find departments that meet certain criteria and to specify the properties that are returned.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Payment Approver
PermissionsList, View Departments
tags: - Company_and_Configuration_Departments operationId: list-company-config-department responses: '200': description: OK content: application/json: schema: type: object title: List of departments properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of departments: value: ia::result: - key: '11' id: Eng href: /objects/company-config/department/1 - key: '2' id: Fin href: /objects/company-config/department/2 - key: '3' id: HR href: /objects/company-config/department/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '201': description: Created '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a department description: >+ Creates a new department.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsAdd Department
tags: - Company_and_Configuration_Departments operationId: create-company-config-department requestBody: description: Department to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-department' - $ref: '#/components/schemas/company-config-departmentRequiredProperties' examples: Create a department: value: id: ENG name: Engineering reportTitle: Engineering status: active supervisor: key: '16' Create a child department: value: id: SW name: Software reportTitle: Software Development status: active parent: key: '28' supervisor: key: '5' responses: '201': description: Created content: application/json: schema: type: object title: New department properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New department created: value: ia::result: key: '12' id: ENG href: /objects/company-config/department/12 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/department/{key}: parameters: - name: key description: System-assigned key for the department. in: path required: true example: '28' schema: type: string get: summary: Get a department description: >+ Returns detailed information for a specified department.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Payment Approver
PermissionsList, View Departments
tags: - Company_and_Configuration_Departments operationId: get-company-config-department-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the department properties: ia::result: $ref: '#/components/schemas/company-config-department' ia::meta: $ref: '#/components/schemas/metadata' examples: Department details: value: ia::result: id: PS key: '28' name: Professional Services parent: key: '7' id: CS--Client Services name: Client Services href: /objects/company-config/department/7 supervisor: key: '5' id: MGR1--PS Dept - Manager name: PS Dept - Manager href: /objects/company-config/employee/5 audit: createdDateTime: '2023-01-08T11:28:12Z' modifiedDateTime: '2023-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' status: active reportTitle: Professional Services href: /objects/company-config/department/28 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a department description: >+ Updates an existing department by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsEdit Departments
tags: - Company_and_Configuration_Departments operationId: update-company-config-department-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-department' - type: object properties: id: readOnly: true examples: Change department supervisor: value: supervisor: key: '99' responses: '200': description: OK content: application/json: schema: type: object title: Updated department properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Department updated: value: ia::result: key: '1' id: SW href: /objects/company-config/department/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a department description: >+ Deletes a department. You can delete a department if it is not being used or referenced. Deleted departments cannot be recovered.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsDelete Departments
tags: - Company_and_Configuration_Departments operationId: delete-company-config-department-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/entity: get: summary: List entities description: >- Returns up to 100 entities from the collection with a key, ID, and link for each entity. This operation is mostly for use in testing; use the query service to find entities that meet specific criteria and to specify the properties that you want in the response. tags: - Company_and_Configuration_Entities operationId: list-company-config-entity responses: '200': description: OK content: application/json: schema: type: object title: List of entity objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of entities: value: ia::result: - key: '195' id: entity1692705208 href: /objects/company-config/entity/195 - key: '196' id: entity21692704288 href: /objects/company-config/entity/196 - key: '197' id: entity11692704288 href: /objects/company-config/entity/196 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an entity description: Creates a new entity. tags: - Company_and_Configuration_Entities operationId: create-company-config-entity requestBody: description: Create entity object required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-entity' - $ref: '#/components/schemas/company-config-entityRequiredProperties' examples: Creates an entity: value: id: Hungary name: Hungary defaultCountryForAddresses: hungary operatingCountry: hungary reportPrintAs: Hungary weekStart: monday contacts: primary: id: '-1-13S(V1-13S)' shipTo: id: 0000-1S(V0000-1S) manager: key: '14' texts: message: >- Superior financial Applications. Real-time business visibility. Open, on-demand platform. marketing: Intacct. A Better Way to Run Your Business footnote: Hungary customTitle: Hungary isRoot: true businessDays: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY weekends: - SATURDAY - SUNDAY taxId: '192354308' startDate: '2023-01-12' openBooksStartDate: '2023-10-01' responses: '201': description: Created content: application/json: schema: type: object title: New entity properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New entity created: value: ia::result: key: '184' id: Hungary href: /objects/company-config/entity/184 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/entity/{key}: parameters: - name: key in: path description: System-assigned unique key for the entity. required: true schema: type: string get: summary: Get an entity description: Returns detailed information for a specified entity. tags: - Company_and_Configuration_Entities operationId: get-company-config-entity-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the entity properties: ia::result: $ref: '#/components/schemas/company-config-entity' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an entity: value: ia::result: id: entity1693567215 key: '601' name: entity1693567215 manager: name: Supervisor id: b.ruth key: '81' href: /objects/company-config/employee/81 contacts: primary: mailingAddress: addressLine1: 744 Edgewater Blvd addressLine2: Suite 10 addressLine3: Industrial area city: Kansas City state: KS postCode: '66104' country: United States id: AMoore lastName: Moore firstName: Andy middleName: Robert prefix: Mr. printAs: Andy Moore email1: andy.moore@mycompany.com email2: andy.moore@personal.com phone1: '9134598676' phone2: '9133459867' mobile: '9133132299' pager: '9133132299' fax: '9134598677' URL1: http://andy.exampledomain.com URL2: http://andy.exampledomainsecond.com companyName: Ecology Corp key: '237' href: /objects/company-config/contact/237 shipTo: mailingAddress: addressLine1: 300 Park Avenue addressLine2: Suite 1400 addressLine3: Western industrial area city: San Jose state: California postCode: '95110' country: United States id: Vendor_A0000001 lastName: Smith firstName: Sara middleName: Sue prefix: Ms. printAs: Sara Smith email1: ssmith@example.com email2: sara@home.com phone1: '14085551212' phone2: '14123321255' mobile: '14085554420' pager: '14085559987' fax: '14085555309' URL1: https://smith.example.com URL2: https://sarasue.example.com companyName: null key: '198' href: /objects/company-config/contact/198 startDate: '2020-01-01' endDate: null status: active audit: createdDateTime: '2023-09-01T11:20:19Z' modifiedDateTime: '2023-09-01T11:20:19Z' createdBy: '99' modifiedBy: '99' federalId: '123456789' firstFiscalMonth: april weekStart: monday interEntityPayableGLAccount: id: null accountNumber: null key: null interEntityReceivableGLAccount: id: '1' accountNumber: 123436 key: '1' texts: message: >- Superior financial Applications. Real-time business visibility. Open, on-demand platform. marketing: Intacct. A Better Way to Run Your Business footnote: Net 30 days reportPrintAs: California isRoot: false vendor: name: Pac bell id: V-00014 customer: id: '15' name: Logic Solutions enableInterEntityRelationships: false customTitle: California businessDays: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY weekends: - FRIDAY - SATURDAY firstTaxMonth: january taxId: '192354308' siret: '01234567890123456789' defaultCountryForAddresses: westernSahara openBooksStartDate: '1990-01-01' legalContact: enableOnTaxForms: false name: Expert Sage Intacct LTD address: address1: 300 Park Avenue address2: Suite 1400 address3: Western industrial area city: San Jose state: California zipCode: '95110' country: United States countryCode: us tpar: contact: name: John Doe phone: '1022223333' fax: '1009288888' email: contact@example.com branchNumber: '001' enableOnTPAR: false operatingCountry: unitedState taxSolution: key: '23' id: '23' taxMethod: Advanced tax href: /objects/tax/tax-solution/23 isPartialExempt: false isDefaultPartialExempt: false unrecoverableTaxAccount: id: null accountingType: entity statutoryReportingPeriodDate: '2021-01-01' href: /objects/company-config/entity/601 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an entity description: >- Updates an existing entity by setting field values. Any fields not provided remain unchanged. tags: - Company_and_Configuration_Entities operationId: update-company-config-entity-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-entity' - type: object properties: id: readOnly: true examples: Mark an entity as out of operation: value: endDate: '2023-12-31' status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Updated entity properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: key: '1' id: entity1693567215 href: /objects/company-config/entity/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an entity description: Deletes an entity. tags: - Company_and_Configuration_Entities operationId: delete-company-config-entity-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/location: get: summary: List locations description: >+ Returns up to 100 locations from the collection with a key, ID, and link for each location. This operation is mostly for use in testing; use the query service to find locations that meet certain criteria and specify the properties that are returned.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Payment Approver
PermissionsList, View Locations
tags: - Company_and_Configuration_Locations operationId: list-company-config-location responses: '200': description: OK content: application/json: schema: type: object title: List of location objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List locations: value: ia::result: - key: '1' id: US-PNW href: /objects/company-config/location/1 - key: '96' id: US-EAST href: /objects/company-config/location/96 - key: '21' id: US-SOUTH href: /objects/company-config/location/21 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a location description: >+ Creates a new location. You can think of this as adding a new value to the dimension that you can use to tag transactions for reporting.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsAdd Location
tags: - Company_and_Configuration_Locations operationId: create-company-config-location requestBody: description: Create location object required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-location' - $ref: '#/components/schemas/company-config-locationRequiredProperties' examples: Create a single location: value: id: loc22 name: 22-India description: All India offices status: active Create a child location: value: id: loc227 name: Bangalore description: Bangalore sales office status: active parent: id: loc22 responses: '201': description: Created content: application/json: schema: type: object title: New location properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New location created: value: ia::result: key: '234' id: 22-India href: /objects/company-config/location/234 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/location/{key}: parameters: - name: key description: System-assigned key for the location. in: path required: true example: '92' schema: type: string get: summary: Get a location description: >+ Returns detailed information for a specified location.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Payment Approver
PermissionsList, View Locations
tags: - Company_and_Configuration_Locations responses: '200': description: OK content: application/json: schema: type: object title: Details of the location properties: ia::result: $ref: '#/components/schemas/company-config-location' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a location: value: ia::result: id: WEN key: '6' name: Wenatchee parent: id: PNW--Pacific Northwest key: '5' href: /objects/company-config/location/5 manager: name: miller, dan id: EE-0000123--miller, dan key: '2' href: /objects/company-config/employee/2 contacts: primary: mailingAddress: addressLine1: '900 Cherry Avenue, #300' addressLine2: null addressLine3: null city: Seattle country: United States postCode: '98066' state: WA URL1: null URL2: null companyName: InsideOut Technologies, Inc email1: null email2: null fax: null firstName: null id: InsideOut Technologies, Inc lastName: null middleName: null mobile: null pager: null phone1: null phone2: null prefix: null printAs: InsideOut Technologies, Inc key: '984' href: /objects/company-config/contact/984 shipTo: mailingAddress: addressLine1: null addressLine2: null addressLine3: null city: null country: null postCode: null state: null URL1: null URL2: null companyName: null email1: null email2: null fax: null firstName: null id: null lastName: null middleName: null mobile: null pager: null phone1: null phone2: null prefix: null printAs: null key: null startDate: null endDate: null status: active audit: createdDateTime: '2022-02-11T09:07:07Z' modifiedDateTime: '2022-02-11T09:07:07Z' createdBy: '110' modifiedBy: '110' locationReportingTitle: Seattle Sales Office taxId: null href: /objects/company-config/location/102 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' operationId: get-company-config-location-key security: - OAuth2: [] patch: summary: Update a location description: >+ Updates an existing location by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsEdit Locations
tags: - Company_and_Configuration_Locations operationId: update-company-config-location-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-location' - type: object properties: id: readOnly: true examples: Update location contacts: value: manager: key: '12' contacts: primary: id: john.doe shipTo: id: jane.daw responses: '200': description: OK content: application/json: schema: type: object title: Updated location properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Location updated: value: ia::result: key: '12' id: SW href: /objects/company-config/location/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a location description: >+ Deletes a location. You can delete a location if it is not being used or referenced. Deleted locations cannot be recovered.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsDelete Locations
tags: - Company_and_Configuration_Locations operationId: delete-company-config-location-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/document-sequence: get: summary: List document sequences description: > Returns up to 100 document sequences from the collection with a key, ID, and link for each sequence. This operation is mostly for use in testing; use the query service to find document sequences that meet certain criteria and to specify the properties that are returned. tags: - Company_and_Configuration_Document sequences operationId: list-company-config-document-sequence responses: '200': description: OK content: application/json: schema: type: object title: List of document-sequence objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of document sequences: value: ia::result: - key: '37' id: BOA_ACH_BatchNo href: /objects/company-config/document-sequence/37 - key: '27' id: Purchase Order href: /objects/company-config/document-sequence/27 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a document sequence description: Creates a new document sequence. tags: - Company_and_Configuration_Document sequences operationId: create-company-config-document-sequence requestBody: description: Document sequence to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-document-sequence' - $ref: '#/components/schemas/company-config-document-sequenceRequiredProperties' examples: Creates a numeric document sequence: value: id: Vendor Invoice printTitle: Vendor Invoice type: numeric fixedPrefix: P fixedSuffix: S prefixSeparator: '-' suffixSeparator: '-' startingNumber: 1 endingNumber: null nextNumber: 1 fixedLength: '4' rollover: isEnabled: true fiscalYearAffixPosition: prefix separator: '-' fiscalYears: - fiscalYear: 2025 nextNumber: 2025 - fiscalYear: 2026 nextNumber: 2026 Creates an alphabetic document sequence: value: id: Vendor Invoice printTitle: Vendor Invoice type: alpha fixedPrefix: P fixedSuffix: S prefixSeparator: '-' suffixSeparator: '-' startingSequence: a endingSequence: c nextSequence: a rollover: isEnabled: true fiscalYears: - fiscalYear: 2023 nextSequence: a - fiscalYear: 2024 nextSequence: a responses: '201': description: Created content: application/json: schema: type: object title: New document-sequence properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New document sequence: value: ia::result: key: '107' id: Vendor Invoice href: /objects/company-config/document-sequence/107 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/document-sequence/{key}: parameters: - name: key description: System-assigned key for the document sequence. in: path required: true schema: type: string get: summary: Get a document sequence description: Returns detailed information for a particular document sequence. tags: - Company_and_Configuration_Document sequences operationId: get-company-config-document-sequence-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the document-sequence properties: ia::result: $ref: '#/components/schemas/company-config-document-sequence' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the document sequence: value: ia::result: key: '107' id: BOA_ACH_BatchNo printTitle: BOA_ACH_BatchNo fixedPrefix: P fixedSuffix: S prefixSeparator: '-' suffixSeparator: '-' startingNumber: 1 endingNumber: null nextNumber: 1 whenModified: '2014-01-08T11:28:12Z' fixedLength: null status: active type: numeric startingSequence: null endingSequence: null nextSequence: null rollover: isEnabled: true enabledDate: '2024-02-14' fiscalYearAffixPosition: prefix separator: '-' audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '109' modifiedBy: '109' fiscalYears: - id: '646' key: '646' documentSequence: key: '405' fiscalYear: 2026 nextNumber: 2026 nextSequence: null audit: createdDateTime: '2024-02-14T12:34:02Z' modifiedDateTime: '2024-02-14T12:34:02Z' createdBy: '109' modifiedBy: '109' - id: '645' key: '645' documentSequence: key: '405' fiscalYear: 2025 nextNumber: 2025 nextSequence: null audit: createdDateTime: '2024-02-14T12:34:02Z' modifiedDateTime: '2024-02-14T12:34:02Z' createdBy: '109' modifiedBy: '109' href: /objects/company-config/document-sequence/107 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a document sequence description: >- Updates an existing document sequence by setting field values. Any fields not provided remain unchanged. tags: - Company_and_Configuration_Document sequences operationId: update-company-config-document-sequence-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-document-sequence' - type: object properties: id: readOnly: true examples: Change the prefix separator: value: prefixSeparator: '-' responses: '200': description: OK content: application/json: schema: type: object title: Updated document-sequence properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated document sequence: value: ia::result: key: '107' id: BOA_ACH_BatchNo href: /objects/company-config/document-sequence/107 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a document sequence description: Deletes a document sequence. tags: - Company_and_Configuration_Document sequences operationId: delete-company-config-document-sequence-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/email-template: get: summary: List email templates description: Returns a collection with a key, ID, and link for each email template. tags: - Company_and_Configuration_Email templates responses: '200': description: OK content: application/json: schema: type: object title: List of email-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of email templates: value: ia::result: - key: '1' id: '1' href: /objects/company-config/email-template/1 - key: '2' id: '2' href: /objects/company-config/email-template/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' operationId: list-company-config-email-template security: - OAuth2: [] post: summary: Create an email template description: Creates a new email template. tags: - Company_and_Configuration_Email templates operationId: create-company-config-email-template requestBody: description: Email template to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-email-template' - $ref: '#/components/schemas/company-config-email-templateRequiredProperties' examples: example-1: value: name: New Email Template description: Test for New Email Template templateType: purchasingTxn email: replyTo: someEmail@co.com to: someEmail@co.com subject: test subject body: test message for all to see responses: '201': description: Created content: application/json: schema: type: object title: Reference to new email template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new email template: value: ia::result: id: '12' key: '12' href: /objects/company-config/email-template/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/email-template/{key}: parameters: - name: key description: System-assigned key for the email-template. in: path required: true schema: type: string get: summary: Get an email template description: Returns detailed information for a specified email-template. tags: - Company_and_Configuration_Email templates operationId: get-company-config-email-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the email template properties: ia::result: $ref: '#/components/schemas/company-config-email-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Email template details: value: id: 23 key: 23 audit: createdDateTime: '2023-10-20T11:31:45Z' modifiedDateTime: '2023-10-20T11:31:45Z' createdBy: '1' modifiedBy: '1' status: active name: New Email Template description: Test for New Email Template templateType: purchasingTxn email: replyTo: someEmail@co.com to: someEmail@co.com cc: someEmail@co.com bcc: someEmail@co.com subject: test subject body: test message for all to see logo: isLogoIncluded: true verticalPosition: bottom horizontalPosition: left includeTxnAttachments: false includeProjectInvoiceTxnAttachments: false useSendersPreferredDateFormat: true href: /objects/company-config/email-template/6 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an email template description: Deletes an email template. tags: - Company_and_Configuration_Email templates operationId: delete-company-config-email-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an email template description: >- Updates an existing email-template by setting field values. Any fields not provided remain unchanged. tags: - Company_and_Configuration_Email templates operationId: update-company-config-email-template-key responses: '200': description: OK content: application/json: schema: type: object title: Updated email-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated email-template: value: ia::result: id: '6' key: '6' href: /objects/company-config/email-template/6 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-email-template' - type: object properties: id: readOnly: true examples: example-1: value: name: New Email Template patched email: to: someEmail@co.com includeTxnAttachments: true security: - OAuth2: [] /objects/company-config/user: get: summary: List users description: >- Returns up to 100 locations from the collection with a key, ID, and link for each user. This operation is mostly for use in testing; use the query service to find users that meet certain criteria and specify the properties that are returned. tags: - Company_and_Configuration_Users responses: '200': description: OK content: application/json: schema: type: object title: List of user objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: example-1: value: ia::result: - key: '1' id: Admin href: /objects/company-config/user/1 - key: '2' id: Jane Doe href: /objects/company-config/user/2 - key: '4' id: Larry Smith href: /objects/company-config/user/4 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' operationId: list-company-config-user security: - OAuth2: [] post: summary: Create a user description: Creates a new user. tags: - Company_and_Configuration_Users operationId: create-company-config-user requestBody: description: User to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-user' - $ref: '#/components/schemas/company-config-userRequiredProperties' examples: New admin user: value: id: Admin userName: Admin userType: business status: active isWebServicesOnlyUser: false contact: id: Smith lastName: Smith firstName: Alex email1: smith.alex@example.com mailingAddress: addressLine1: 300 Park Avenue city: San Jose state: California postCode: '95110' country: United States disableChatter: true permissionAssignments: - permission: key: '404' accessRights: - list - delete - permission: key: '253' accessRights: - list responses: '201': description: Created content: application/json: schema: type: object title: New user properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: example-1: value: ia::result: key: '1' id: Admin href: /objects/company-config/user/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/user/{key}: parameters: - name: key in: path required: true description: System-assigned key for the user. schema: type: string example: '65' get: summary: Get a user description: Returns detailed information for a specified user. tags: - Company_and_Configuration_Users operationId: get-company-config-user-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the user properties: ia::result: $ref: '#/components/schemas/company-config-user' ia::meta: $ref: '#/components/schemas/metadata' examples: User details: value: ia::result: key: '65' id: Admin userName: Admin href: /objects/company-config/user/65 contact: mailingAddress: addressLine1: 744 Edgewater Blvd addressLine2: Apt 104 addressLine3: Western industrial area city: San Jose state: CA postCode: '95110' country: United States id: contact01650967341 lastName: John firstName: E. middleName: Doe prefix: Mr printAs: John E. Doe email1: john.doe@example.com email2: john.e.doe@example.com phone1: '6692248123' phone2: '1222455566' mobile: '1222455566' pager: '12566' fax: '1222455566' URL1: http://john.example.com URL2: http://john.doe.example.com companyName: Sage Inc key: '3446' href: /objects/company-config/contact/3446 adminPrivileges: 'off' userType: business webServices: enabled: true restricted: false status: active password: neverExpires: true requiresReset: false securityQuestion: What is my favorite food? sso: isSSOEnabled: true federatedSSOId: john.doe entity: unrestricted: true allowToplevelAccess: false audit: createdDateTime: '2022-04-26T10:17:12Z' modifiedDateTime: '2022-04-26T11:05:26Z' createdBy: '110' modifiedBy: '109' disableChatter: true locations: - id: '87' name: London href: /objects/company-config/location/87 - id: '92' name: Paris href: /objects/company-config/location/92 departments: - id: '55' name: Sales href: /objects/company-config/department/55 - id: '65' name: Accounting href: /objects/company-config/department/65 territories: - id: '22' name: South href: /objects/accounts-receivable/territory/22 - id: '32' name: West href: /objects/accounts-receivable/territory/32 permissionAssignments: - permission: id: '404' key: '404' href: /objects/company-config/permission/404 accessRights: - list - delete - permission: id: '253' key: '253' href: /objects/company-config/permission/253 accessRights: - list - delete ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a user description: >- Updates an existing user by setting field values. Any fields not provided remain unchanged. tags: - Company_and_Configuration_Users operationId: update-company-config-user-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-user' - type: object properties: id: readOnly: true example: '1' adminPrivileges: readOnly: true example: 'off' examples: Update user: value: userName: Admin status: inactive permissionAssignments: - permission: key: '404' accessRights: - list responses: '200': description: OK content: application/json: schema: type: object title: Updated user properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: example-1: value: ia::result: key: '65' id: Admin href: /objects/company-config/user/65 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a user description: Deletes a user. tags: - Company_and_Configuration_Users operationId: delete-company-config-user-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/role: get: summary: List roles description: >- Returns a collection with a key, ID, and link for each role. This operation is mostly for use in testing; use the query service to find roles that meet certain criteria and specify the properties that are returned. tags: - Company_and_Configuration_Roles operationId: list-company-config-role responses: '200': description: OK content: application/json: schema: type: object title: List of role objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of roles: value: ia::result: - key: '470' id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin' href: /objects/company-config/role/470 - key: '471' id: '::SYS::Multi Entity Shared-ROLE-FOR - BTI' href: /objects/company-config/role/471 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a role description: Creates a new role. tags: - Company_and_Configuration_Roles operationId: create-company-config-role requestBody: description: Role to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-role' - $ref: '#/components/schemas/company-config-roleRequiredProperties' examples: Creates a role: value: id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin' description: Administrator role with permissions roleType: enterprise applyTo: loginAndSlideIn rolePermissionAssignments: - permission: id: '253' accessRights: - list - readonly - permission: id: '207' accessRights: - list - readonly - add - modify - delete responses: '201': description: Created content: application/json: schema: type: object title: New role properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New role: value: ia::result: key: '470' id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin' href: /objects/company-config/role/470 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/role/{key}: parameters: - name: key description: System-assigned unique key for the role. in: path required: true schema: type: string get: summary: Get a role description: Returns detailed information for a specified role. tags: - Company_and_Configuration_Roles operationId: get-company-config-role-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the role properties: ia::result: $ref: '#/components/schemas/company-config-role' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the role: value: ia::result: key: '470' id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin' description: Administrator role with permissions roleType: enterprise applyTo: loginAndSlideIn audit: createdDateTime: '2020-11-16T14:27:51Z' modifiedDateTime: '2020-11-16T14:28:11Z' createdBy: '1' modifiedBy: '1' rolePermissionAssignments: - key: '30' id: '30' role: key: '470' id: '470' href: /objects/company-config/role/470 permission: key: '253' id: '253' name: taxScheduleMap module: purchasing href: /objects/company-config/permission/253 accessRights: - list - readonly - add - modify - delete audit: createdDateTime: '2020-11-16T14:27:51Z' modifiedDateTime: '2020-11-16T14:28:11Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/role-policy-assignment/30 roleUsers: - key: '472' id: '472' role: key: '470' id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin' href: /objects/company-config/role/470 user: key: '189' id: Admin href: /objects/company-config/user/189 audit: createdDateTime: '2020-11-16T14:27:51Z' modifiedDateTime: '2020-11-16T14:28:11Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/role-user-map/472 roleGroups: - key: '761' id: '761' role: key: '470' id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin' href: /objects/company-config/role/470 userGroup: key: '1' id: Bypass group href: /objects/company-config/user-group/1 audit: createdDateTime: '2020-11-16T14:27:51Z' modifiedDateTime: '2020-11-16T14:28:11Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/role-user-group-map/761 href: /objects/company-config/role/470 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a role description: >- Updates an existing role by setting field values. Any fields not provided remain unchanged. tags: - Company_and_Configuration_Roles operationId: update-company-config-role-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-role' - type: object properties: id: readOnly: true examples: Updates a role: value: description: Administrator role with permissions rolePermissionAssignments: - key: '30' accessRights: - list - permission: key: '274' accessRights: - add responses: '200': description: OK content: application/json: schema: type: object title: Updated role properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated role: value: ia::result: key: '470' id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin' href: /objects/company-config/role/470 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a role description: Deletes a role. tags: - Company_and_Configuration_Roles operationId: delete-company-config-role-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/permission: get: summary: List permissions description: Returns a collection with a key, ID, and link for each permission. tags: - Company_and_Configuration_Permissions operationId: list-company-config-permission responses: '200': description: OK content: application/json: schema: type: object title: List of permission objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of permissions: value: ia::result: - key: '1' id: '1' href: /objects/company-config/permission/1 - key: '2' id: '2' href: /objects/company-config/permission/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/permission/{key}: parameters: - name: key description: System-assigned unique key for the permission. in: path required: true schema: type: string get: summary: Get a permission description: Returns detailed information for a specified permission. tags: - Company_and_Configuration_Permissions operationId: get-company-config-permission-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the permission properties: ia::result: $ref: '#/components/schemas/company-config-permission' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the permission: value: ia::result: key: '1' id: '1' module: myAccounting name: switchToMyAccounting permissionGroup: activitiesAndLists allowedAccessRights: - list href: /objects/company-config/permission/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/role-permission-assignment: get: summary: List role permission assignments description: >- Returns a collection with a key, ID, and link for each role permission assignment. tags: - Company_and_Configuration_Role permission assignments operationId: list-company-config-role-permission-assignment responses: '200': description: OK content: application/json: schema: type: object title: List of role-permission-assignment objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of role permission assignments: value: ia::result: - key: '156434' id: '156434' href: '/objects/company-config/role-permission-assignment/156434' - key: '156435' id: '156435' href: '/objects/company-config/role-permission-assignment/156435' ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/role-permission-assignment/{key}: parameters: - name: key description: system-assigned unique key for the role permission assignment. in: path required: true schema: type: string get: summary: Get a role permission assignment description: >- Returns detailed information for a particular role permission assignment. tags: - Company_and_Configuration_Role permission assignments operationId: get-company-config-role-permission-assignment-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the role-permission-assignment properties: ia::result: $ref: '#/components/schemas/company-config-role-permission-assignment' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the role permission assignment: value: ia::result: key: '177748' id: '177748' role: key: '528' id: '::SYS::Multi Entity Shared-ROLE-FOR - EMP4-US' href: /objects/company-config/role/528 permission: key: '3295' id: '3295' name: coverLetters module: company href: /objects/company-config/permission/3295 accessRights: - list - readonly - add - modify - delete audit: createdDateTime: '2023-08-18T09:43:13Z' modifiedDateTime: '2023-08-18T09:43:13Z' createdBy: '1' modifiedBy: '1' href: '/objects/company-config/role-permission-assignment/177748' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a role permission assignment description: Deletes a role permission assignment. tags: - Company_and_Configuration_Role permission assignments operationId: delete-company-config-role-permission-assignment-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-change-order: get: summary: List project change orders description: > Returns up to 100 object references from the collection with a key, ID, and link for each object. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned. tags: - Construction_Project change orders operationId: list-construction-project-change-order responses: '200': description: OK content: application/json: schema: type: object title: List of project-change-order objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: example-list-project-change-orders: value: ia::result: - key: '1' id: PCO-BTI-1 href: /objects/construction/project-change-order/1 - key: '2' id: PCO-BTI-2 href: /objects/construction/project-change-order/2 - key: '3' id: PCO-BTI-3 href: /objects/construction/project-change-order/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a project change order description: Creates a new project change order. tags: - Construction_Project change orders operationId: create-construction-project-change-order requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-project-change-order' - $ref: '#/components/schemas/construction-project-change-orderRequiredProperties' examples: example-create-project-change-order: value: id: PCO-BTI-9 project: id: DIM - BTI projectChangeOrderDate: '2023-12-09' priceEffectiveDate: '2023-12-01' changeRequestStatus: id: Pending state: draft description: Change Oder 9 for BTI Project sendToContact: id: Aaron item: id: Development scope: Planning only inclusions: Design scope exclusions: Maintenance terms: Standard schedule: scheduledStartDate: '2024-01-01' scheduleImpact: NA attachment: id: pco-bti-1-att1 responses: '201': description: Created content: application/json: schema: type: object title: Reference to new project change order properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new project change order: value: ia::result: key: '6' id: PCO-BTI-6 href: /objects/construction/project-change-order/6 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-change-order/{key}: parameters: - name: key description: System-assigned key for the project change order. in: path required: true schema: type: string get: summary: Get a project change order description: Returns detailed information for a specified project change order. tags: - Construction_Project change orders operationId: get-construction-project-change-order-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the project change order properties: ia::result: $ref: '#/components/schemas/construction-project-change-order' ia::meta: $ref: '#/components/schemas/metadata' examples: Change order details: value: ia::result: key: '1' id: PCO-BTI-1 project: key: '1' id: DIM - BTI name: Dimensions - Berkeley Technology Inc href: /objects/projects/project/1 location: key: '1' id: 1 name: United States of America href: /objects/company-config/location/1 customer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 projectChangeOrderDate: '2021-12-15' state: posted changeRequestStatus: key: '2' id: Approved href: /objects/change-request-status/2 description: Change Oder 1 for BTI Project priceEffectiveDate: '2021-12-15' projectContract: key: '3' id: BTI-02 name: BTI - 02 href: /objects/construction/project-contract/3 projectContractLine: key: '28' id: bti-02.1 name: bti-02.1 href: /objects/construction/project-contract-line/28 totalCost: '1000.00' totalPrice: '1500.00' sendToContact: key: '4' id: Chandler href: /objects/company-config/contact/4 item: key: '21' id: Maintenance name: Maintenance href: /objects/inventory-control/item/21 scope: scope inclusions: incl exclusions: excl terms: terms schedule: scheduledStartDate: '2022-01-12' actualStartDate: '2022-01-12' scheduledCompletionDate: '2022-04-30' revisedCompletionDate: '2022-05-30' substantialCompletionDate: '2022-05-30' actualCompletionDate: '2022-05-30' noticeToProceedDate: '2022-05-30' responseDueDate: '2022-05-30' executedOnDate: '2022-05-30' scheduleImpact: None internalReference: referenceNumber: BTI-01-REF-034-M initiatedBy: key: '28' id: '22' name: Chandler href: /objects/company-config/employee/28 verbalApprovalBy: key: '28' id: '22' name: Chandler href: /objects/company-config/employee/28 issuedBy: key: '31' id: '23' name: Jurasek href: /objects/company-config/employee/31 issuedOnDate: '2021-12-08' approvedBy: key: '30' id: '2345' name: Johnson href: /objects/company-config/employee/30 approvedOnDate: '2021-12-09' signedBy: key: '30' id: '2345' name: Johnson href: /objects/company-config/employee/30 signedOnDate: '2021-12-09' source: NA sourceReferenceNumber: NA externalReference: referenceNumber: NA verbalApprovalBy: key: '11' name: Baechtel href: /objects/company-config/contact/11 approvedBy: key: '11' name: Baechtel href: /objects/company-config/contact/11 approvedOnDate: '2021-12-10' signedBy: key: '224' name: Able and Sons, Accountants href: /objects/company-config/contact/224 signedOnDate: '2021-12-10' attachment: id: pco-bti-1-att1 key: '6' href: /objects/company-config/attachment/6 audit: modifiedDateTime: '2021-12-30T22:28:51Z' createdDateTime: '2021-12-08T23:30:01Z' modifiedBy: '1' createdBy: '1' href: /objects/construction/project-change-order/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a project change order description: >- Updates an existing project change order by setting field values. Any fields not provided remain unchanged tags: - Construction_Project change orders operationId: update-construction-project-change-order-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-project-change-order' - type: object properties: id: readOnly: true examples: Update a project change order: value: project: id: DIM - BTI projectChangeOrderDate: '2021-12-15' priceEffectiveDate: '2021-12-15' state: posted description: Change Oder 1 for BTI Project changeRequestStatus: id: Approved sendToContact: id: Chandler item: id: Maintenance scope: scope inclusions: incl exclusions: excl terms: terms schedule: scheduledStartDate: '2022-01-12' attachment: id: pco-bti-1-att2 responses: '200': description: OK content: application/json: schema: type: object title: Updated project-change-order properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated project change order: value: ia::result: key: '1' id: PCO-BTI-1 href: /objects/construction/project-change-order/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a project change order description: Deletes a project change order. tags: - Construction_Project change orders operationId: delete-construction-project-change-order-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/change-request: get: summary: List change requests description: >- Returns up to 100 object references from the collection with a key, ID, and link for each change request. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned. tags: - Construction_Change requests operationId: list-construction-change-request responses: '200': description: OK content: application/json: schema: type: object title: List of change-request objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of change requests: value: ia::result: - key: '1' id: CR-1 href: /objects/construction/change-request/1 - key: '2' id: CR-2 href: /objects/construction/change-request/2 - key: '3' id: CR-3 href: /objects/construction/change-request/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a change request description: Creates a new change request. tags: - Construction_Change requests operationId: create-construction-change-request requestBody: description: Change request to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-change-request' - $ref: '#/components/schemas/construction-change-requestRequiredProperties' examples: Creates a change request: value: id: CR-4 changeRequestDate: '2021-11-11' project: key: '12' responses: '201': description: Created content: application/json: schema: type: object title: Reference to new change request properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new change request: value: ia::result: key: '4' id: CR-4 href: /objects/construction/change-request/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/change-request/{key}: parameters: - name: key description: System-assigned key for the change request. in: path required: true schema: type: string get: summary: Get a change request description: Returns detailed information for a particular change request. tags: - Construction_Change requests operationId: get-construction-change-request-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the change request properties: ia::result: $ref: '#/components/schemas/construction-change-request' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the change request: value: ia::result: key: '1' id: CR1-DIMBTI-CRHSrce changeRequestType: key: '12' id: CRType-12 href: /objects/construction/change-request-type/12 project: key: '1' id: DIM - BTI name: Dimensions - Berkeley Technology Inc href: /objects/projects/project/1 location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 projectCustomer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 changeRequestDate: '2021-02-07' changeRequestState: posted changeRequestStatus: key: '1' id: CRStatus_Original workflowType: original href: /objects/construction/change-request-status/1 description: CR1 with Line Source set to change request header costEffectiveDate: '2021-02-02' priceEffectiveDate: '2021-02-02' totalCost: '100.00' totalPrice: '200.00' projectChangeOrder: key: '1' id: PCO1-DIMBTI href: /objects/construction/project-change-order/1 scope: change request scope inclusions: null exclusions: null terms: null schedule: scheduledStartDate: '2022-05-30' actualStartDate: '2022-05-30' scheduledCompletionDate: '2022-05-30' revisedCompletionDate: '2022-05-30' substantialCompletionDate: '2022-05-30' actualCompletionDate: '2022-05-30' noticeToProceedDate: '2022-05-30' responseDueDate: '2022-05-30' executedOnDate: '2022-05-30' scheduleImpact: None internalReference: referenceNumber: INT-01 initiatedBy: key: '2' id: '12' name: Hatcher href: /objects/company-config/employee/2 verbalApprovalBy: key: '2' id: '12' name: Hatcher href: /objects/company-config/employee/2 issuedBy: key: '25' id: '123' name: Marquess href: /objects/company-config/employee/25 issuedOnDate: '2021-05-30' approvedBy: key: '1' id: '11' name: Reser href: /objects/company-config/employee/1 approvedOnDate: '2021-10-02' signedBy: key: '32' id: Robert name: Robert href: /objects/company-config/employee/32 signedOnDate: '2021-05-31' source: NA sourceReferenceNumber: REF-01 externalReference: referenceNumber: A23 verbalApprovalBy: key: '6' name: Johnson href: /objects/company-config/contact/6 approvedBy: key: '69' name: Jagadish href: /objects/company-config/contact/69 approvedOnDate: '2021-11-03' signedBy: key: '200' name: Modulus Industries href: /objects/company-config/contact/200 signedOnDate: '2021-12-01' attachment: id: '1' projectContract: key: '1' id: PCN1-Top-DIMBTI name: PCN1-Top-DIMBTI href: /objects/construction/project-contract/1 projectContractLine: key: '1' id: '01' name: 01-Billable Labor href: /objects/construction/project-contract-line/1 audit: modifiedDateTime: '2023-06-14T13:56:37Z' createdDateTime: '2023-06-14T13:56:35Z' modifiedBy: '1' createdBy: '1' projectContractLineSource: changeRequest changeRequestLines: - key: '99' id: '99' changeRequest: key: '1' id: CR1-DIMBTI-CRHSrce href: /objects/construction/change-request/1 workflowType: approvedChange dimensions: location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 department: key: '9' id: '11' name: Accounting href: /objects/company-config/department/9 project: key: '1' id: DIM - BTI name: Dimensions - Berkeley Technology Inc href: /objects/projects/project/1 customer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 vendor: key: '43' id: V101 name: NW Concrete href: /objects/accounts-payable/vendor/43 employee: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 class: key: '1' id: '3' name: Heath Care href: /objects/company-config/class/1 task: key: '690' id: 2-050 name: Demolition href: /objects/projects/task/690 costType: key: '8' id: L name: Labor href: /objects/costType/8 numberOfProductionUnits: '0' productionUnitDescription: Hours quantity: '10' externalUOM: null unitCost: '100.00' cost: '200.00' unitPrice: '100.00' price: '200.00' priceMarkupPercent: '0' priceMarkupAmount: '0.00' linePrice: '200.00' projectChangeOrder: key: '1' id: PCO1-DIMBTI href: /objects/construction/project-change-order/1 memo: CR1L1 projectEstimate: key: '1' id: PrimEst-DIMBTI href: /objects/construction/project-estimate/1 glAccount: key: '222' id: '5008' name: Salaries - Contract href: /objects/general-ledger/account/222 projectContract: key: '1' id: PCN1-Top-DIMBTI name: PCN1-Top-DIMBTI href: /objects/construction/project-contract/1 projectContractLine: key: '1' id: '01' name: 01-Billable Labor href: /objects/construction/project-contract-line/1 audit: modifiedDateTime: '2023-06-14T13:56:37Z' createdDateTime: '2023-06-14T13:56:35Z' modifiedBy: '1' createdBy: '1' href: /objects/construction/change-request-line/99 href: /objects/construction/change-request/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a change request description: >- Updates an existing change request by setting field values. Any fields not provided remain unchanged. tags: - Construction_Change requests operationId: update-construction-change-request-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-change-request' - type: object properties: id: readOnly: true examples: Updates a change request description: value: description: >- CR1 with Line Source set to change request header - updated by project manager responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated change request properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated change request: value: ia::result: key: '4' id: CR-4 href: /objects/construction/change-request/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a change request description: Deletes a change request. tags: - Construction_Change requests operationId: delete-construction-change-request-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/change-request-line: get: summary: List change request lines description: >- Returns up to 100 object references from the collection with a key, ID, and link for each change request line. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned. tags: - Construction_Change request lines operationId: list-construction-change-request-line responses: '200': description: OK content: application/json: schema: type: object title: List of change-request-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of change request lines: value: ia::result: - key: '1' id: '1' href: /objects/construction/change-request-line/1 - key: '2' id: '2' href: /objects/construction/change-request-line/2 - key: '3' id: '3' href: /objects/construction/change-request-line/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/change-request-line/{key}: parameters: - name: key description: System-assigned unique key for the change request line. in: path required: true schema: type: string get: summary: Get a change request line description: Returns detailed information for a specified change request line. tags: - Construction_Change request lines operationId: get-construction-change-request-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the change request line properties: ia::result: $ref: '#/components/schemas/construction-change-request-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the change request line: value: ia::result: key: '7' id: '7' changeRequest: key: '11' id: REST-CR-02 href: /objects/construction/change-request/11 workflowType: none dimensions: location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 department: key: '3' id: '3' name: Engineering href: /objects/company-config/department/3 project: key: '1' id: DIM - BTI name: Dimensions - Berkeley Technology Inc href: /objects/projects/project/1 customer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '27' id: '12' name: Eberhardt href: /objects/company-config/employee/27 item: key: '240' id: '3' name: 'Rebar #10' href: /objects/inventory-control/item/240 class: key: '6' id: '4' name: Professional Services href: /objects/company-config/class/6 task: key: '3' id: '1020' name: Roofing href: /objects/projects/task/3 costType: key: '8' id: L name: Labor href: /objects/costType/8 numberOfProductionUnits: '1200' productionUnitDescription: sqft quantity: '5.00' externalUOM: each unitCost: '32.00' cost: '160.00' unitPrice: '40.00' price: '200.00' priceMarkupPercent: '10.00' priceMarkupAmount: '20.00' linePrice: '220.00' projectChangeOrder: key: '2' id: PCO2-DIMBTI href: /objects/construction/project-change-order/2 memo: CR Line 02 projectEstimate: key: '1' id: BTI-01 href: /objects/construction/project-estimate/1 glAccount: key: '35' id: '5001' name: Construction href: /objects/general-ledger/account/35 projectContract: key: '4' id: PCN-04 name: Construction href: /objects/construction/project-contract/4 projectContractLine: key: '6' id: PCL-06 name: Construction href: /objects/construction/project-contract-line/6 audit: createdDateTime: '2023-06-14T13:56:42Z' modifiedDateTime: '2023-06-14T13:56:43Z' createdBy: '1' modifiedBy: '1' href: /objects/construction/change-request-line/7 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/change-request-type: get: summary: List change request types description: >- Returns up to 100 object references from the collection with a key, ID, and link for each change request type. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned. tags: - Construction_Change request types operationId: list-construction-change-request-type responses: '200': description: OK content: application/json: schema: type: object title: List of change request type objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of change request types: value: ia::result: - key: '21' id: CRType-21 href: /objects/construction/change-request-type/21 - key: '23' id: CRType-23 href: /objects/construction/change-request-type/23 - key: '24' id: CRType-24 href: /objects/construction/change-request-type/24 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a change request type description: Creates a new change request type. tags: - Construction_Change request types operationId: create-construction-change-request-type requestBody: description: Change request type to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-change-request-type' - $ref: '#/components/schemas/construction-change-request-typeRequiredProperties' examples: Create a change request type: value: id: Internal status: active responses: '201': description: Created content: application/json: schema: type: object title: Reference to new change request type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new change request type: value: ia::result: key: '111' id: Internal href: /objects/construction/change-request-type/111 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/change-request-type/{key}: parameters: - name: key description: System-assigned key for the change request type. in: path required: true schema: type: string get: summary: Get a change request type description: Returns detailed information for a specified change request type. tags: - Construction_Change request types operationId: get-construction-change-request-type-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the change request type properties: ia::result: $ref: '#/components/schemas/construction-change-request-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of change request type: value: ia::result: key: '12' id: Internal status: active audit: createdDateTime: '2021-11-11T02:16:46Z' modifiedDateTime: '2021-11-11T02:16:46Z' createdBy: '1' modifiedBy: '1' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a change request type description: >- Updates an existing change request type by setting field values. Any fields not provided remain unchanged. tags: - Construction_Change request types operationId: update-construction-change-request-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-change-request-type' - type: object properties: id: readOnly: true examples: Set a change request type to inactive: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated change request type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated change request type: value: ia::result: key: '12' id: Internal href: /objects/construction/change-request-type/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a change request type description: Deletes a change request type. tags: - Construction_Change request types operationId: delete-construction-change-request-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/change-request-status: get: summary: List change request statuses description: >- Returns up to 100 object references from the collection with a key, ID, and link for each change request status. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned. tags: - Construction_Change request statuses operationId: list-construction-change-request-status responses: '200': description: OK content: application/json: schema: type: object title: List of change request status objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of change request statuses: value: ia::result: - key: '21' id: Not issued href: /objects/construction/change-request-status/21 - key: '22' id: Approved href: /objects/construction/change-request-status/22 - key: '23' id: Original href: /objects/construction/change-request-status/23 - key: '24' id: Revised href: /objects/construction/change-request-status/24 - key: '25' id: Future href: /objects/construction/change-request-status/25 ia::meta: totalCount: 5 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a change request status description: Creates a new change request status. tags: - Construction_Change request statuses operationId: create-construction-change-request-status requestBody: description: Change request status to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-change-request-status' - $ref: '#/components/schemas/construction-change-request-statusRequiredProperties' examples: Create a change request status: value: id: Pending workflowType: pendingChange status: active responses: '201': description: Created content: application/json: schema: type: object title: Reference to new change request status properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new change request status: value: ia::result: key: '111' id: Approved change href: /objects/construction/change-request-status/111 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/change-request-status/{key}: parameters: - name: key description: System-assigned key for the change request status. in: path required: true schema: type: string get: summary: Get a change request status description: Returns detailed information for a specified change request status. tags: - Construction_Change request statuses operationId: get-construction-change-request-status-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the change request status properties: ia::result: $ref: '#/components/schemas/construction-change-request-status' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of change request status: value: ia::result: key: '12' id: Pending workflowType: pendingChange status: active audit: createdDateTime: '2021-11-11T02:16:46Z' modifiedDateTime: '2021-11-11T02:16:46Z' createdBy: '1' modifiedBy: '1' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a change request status description: >- Updates an existing change request status by setting field values. Any fields not provided remain unchanged. tags: - Construction_Change request statuses operationId: update-construction-change-request-status-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-change-request-status' - type: object properties: id: readOnly: true examples: Set a change request status as inactive: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated change request status properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated change request status: value: ia::result: key: '12' id: Pending href: /objects/construction/change-request-status/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a change request status description: Deletes a change request status. tags: - Construction_Change request statuses operationId: delete-construction-change-request-status-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-contract: get: summary: List project contracts description: > Returns up to 100 object references from the collection with a key, ID, and link for each object. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned. tags: - Construction_Project contracts operationId: list-construction-project-contract responses: '200': description: OK content: application/json: schema: type: object title: List of project contract objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: example-result-collection-of-project-contracts: value: ia::result: - key: '1' id: BTI-01 href: /objects/construction/project-contract/1 - key: '2' id: BTI-02 href: /objects/construction/project-contract/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a project contract description: Creates a new project contract. tags: - Construction_Project contracts operationId: create-construction-project-contract requestBody: description: Project contract to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-project-contract' - $ref: '#/components/schemas/construction-project-contractRequiredProperties' examples: Details of project contract to create: value: id: BTI-05 name: Berkeley Technology Inc - Contract 05 project: id: DIM - BTI customer: id: BTI contractDate: '2023-09-30' description: Project contract for Berkeley Technology Inc architect: id: Eberhardt projectContractType: id: COM attachment: id: pc-att-2 isBillable: true scope: Project scope only inclusions: Per original contract exclusions: Plumbing terms: Per original contract schedule: scheduledStartDate: '2023-06-15' actualStartDate: '2023-06-30' scheduledCompletionDate: '2022-11-15' revisedCompletionDate: '2023-12-15' substantialCompletionDate: '2023-09-30' actualCompletionDate: '2023-12-15' noticeToProceedDate: '2023-05-30' responseDueDate: '2023-06-05' executedOnDate: '2023-06-01' scheduleImpact: NA internalReference: referenceNumber: INT-01 initiatedBy: id: '2' verbalBy: id: '2' issuedBy: id: '123' issuedOnDate: '2023-05-30' approvedBy: id: '1' approvedOnDate: '2023-10-02' signedBy: id: Robert signedOnDate: '2023-05-31' source: NA sourceReferenceNumber: REF-01 externalReference: referenceNumber: A23 verbalBy: name: Johnson approvedBy: name: Jagadish approvedOnDate: '2023-11-03' signedBy: name: Modulus Industries signedOnDate: '2023-12-01' responses: '201': description: Created content: application/json: schema: type: object title: New project-contract properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new project contract: value: ia::result: key: '1' id: BTI-01 href: /objects/construction/project-contract/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-contract/{key}: parameters: - name: key description: System-assigned key for the project contract. in: path required: true schema: type: string get: summary: Get a project contract description: Returns detailed information for a specified project contract. tags: - Construction_Project contracts operationId: get-construction-project-contract-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the project contract properties: ia::result: $ref: '#/components/schemas/construction-project-contract' ia::meta: $ref: '#/components/schemas/metadata' examples: Project contract details: value: ia::result: key: '1' id: BTI-01 name: Berkeley Technology Inc - Contract 01 project: id: DIM - BTI name: Dimensions - Berkeley Technology Inc key: '1' href: /objects/projects/project/1 location: id: '1' name: United States of America key: '1' href: /objects/company-config/location/1 customer: id: BTI name: Berkeley Technology Inc key: '14' href: /objects/accounts-receivable/customer/14 contractDate: '2023-05-15' description: BTI Project - Main lobby renovation contract projectContractType: id: COM key: '2' href: /objects/construction/project-contract-type/2 architect: id: Eberhardt key: '12' href: /objects/company-config/contact/12 isBillable: true attachment: id: pc-att-2 key: '7' href: /objects/company-config/attachment/7 status: active summary: totalPrice: '2810.65' originalPrice: '1100.00' revisionPrice: '210.65' approvedChangePrice: '1500.00' pendingChangePrice: '311.85' otherPrice: '900.00' forecastPrice: '750.00' billing: billedPrice: '0.00' totalBilledNetRetainage: '0.00' percentBilled: '0.00' percentBilledNetRetainage: '0.00' totalRetainageHeld: '0.00' totalRetainageReleased: '0.00' retainageBalance: '0.00' balanceToBill: '2810.65' balanceToBillNetRetainage: '2810.65' totalPaymentsReceived: '0.00' netTotalBilled: '2810.65' netTotalPaymentsReceived: '1000.00' subtotalBilledAsTax: '0.00' subtotalBilledAsDiscount: '0.00' subtotalBilledAsCharge: '0.00' lastApplicationNumber: A-122 excludeFromWIPReporting: false scope: Project scope only inclusions: Per original contract exclusions: Plumbing terms: Per original contract schedule: scheduledStartDate: '2023-06-15' actualStartDate: '2023-06-30' scheduledCompletionDate: '2022-11-15' revisedCompletionDate: '2023-12-15' substantialCompletionDate: '2023-09-30' actualCompletionDate: '2023-12-15' noticeToProceedDate: '2023-05-30' responseDueDate: '2023-06-05' executedOnDate: '2023-06-01' scheduleImpact: NA internalReference: referenceNumber: INT-01 initiatedBy: key: '2' id: '2' name: Hatcher href: /objects/company-config/employee/2 verbalBy: key: '2' id: '2' name: Hatcher href: /objects/company-config/employee/2 issuedBy: key: '25' id: '123' name: Marquess href: /objects/company-config/employee/25 issuedOnDate: '2023-05-30' approvedBy: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 approvedOnDate: '2023-10-02' signedBy: key: '32' id: Robert name: Robert href: /objects/company-config/employee/32 signedOnDate: '2023-05-31' source: NA sourceReferenceNumber: REF-01 externalReference: referenceNumber: A23 verbalBy: key: '6' name: Johnson href: /objects/company-config/contact/6 approvedBy: key: '69' name: Jagadish href: /objects/company-config/contact/69 approvedOnDate: '2023-11-03' signedBy: key: '200' name: Modulus Industries href: /objects/company-config/contact/200 signedOnDate: '2023-12-01' audit: modifiedDateTime: '2022-01-19T00:00:00Z' createdDateTime: '2023-12-01T00:00:00Z' modifiedBy: '1' createdBy: '1' href: /objects/construction/project-contract/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a project contract description: >- Updates an existing project contract by setting field values. Any fields not provided remain unchanged. tags: - Construction_Project contracts operationId: update-construction-project-contract-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-project-contract' - type: object properties: id: readOnly: true examples: example-update-project-contract: value: name: Berkeley Technology Inc - Contract 05[Revised] contractDate: '2023-10-15' description: BTI Project - Main lobby renovation contract scope: Project scope only [updated] inclusions: Per original contract [updated] exclusions: Plumbing [updated] terms: Per revised contract schedule: scheduledStartDate: '2023-11-15' scheduledCompletionDate: '2022-11-15' internalReference: signedBy: id: Robert signedOnDate: '2023-10-15' projectContractType: id: COM responses: '200': description: OK content: application/json: schema: type: object title: Updated project contract properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated project contract: value: ia::result: key: '1' id: BTI-01 href: /objects/construction/project-contract/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a project contract description: Deletes a project contract. tags: - Construction_Project contracts operationId: delete-construction-project-contract-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-contract-line: get: summary: List project contract lines description: > Returns up to 100 object references from the collection with a key, ID, and link for each object. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned. tags: - Construction_Project contract lines operationId: list-construction-project-contract-line responses: '200': description: OK content: application/json: schema: type: object title: List of project-contract line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: example-result-collection-of-project-contract-lines: value: ia::result: - key: '7' id: '7' href: /objects/construction/project-contract-line/7 - key: '4' id: '4' href: /objects/construction/project-contract-line/4 - key: '6' id: '6' href: /objects/construction/project-contract-line/6 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a project contract line description: Creates a new project contract line. tags: - Construction_Project contract lines operationId: create-construction-project-contract-line requestBody: description: Project contract line to be created required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-project-contract-line' - $ref: '#/components/schemas/construction-project-contract-lineRequiredProperties' examples: Create a project contract line: value: projectContract: key: '5' id: '002' name: line 2 description: Contract:BTI-05 - Line 2 contractLineDate: '2023-10-05' account: key: '26' billing: billingType: progressBill maximumBilling: totalPrice summarizeBill: false status: active dimensions: project: key: '11' item: key: '13' scope: Initial survey internalReference: referenceNumber: Ref-BTI-05-004 signedBy: key: '1' isBillable: true Create a project contract line with line entries: value: projectContract: key: '5' id: '001' name: line 1 description: Contract:BTI-05 - Line 1 contractLineDate: '2023-10-05' account: key: '26' billing: billingType: progressBill maximumBilling: totalPrice summarizeBill: false status: active dimensions: project: key: '11' item: key: '13' scope: Initial survey internalReference: referenceNumber: Ref-BTI-03-003 signedBy: key: '1' isBillable: true projectContractLineEntries: - workflowType: revision dimensions: project: key: '11' item: key: '13' quantity: '1' externalUOM: each unitPrice: '97' priceMarkupPercent: '5' memo: memo priceEffectiveDate: '2023-10-14' responses: '201': description: Created content: application/json: schema: type: object title: Reference to new project contract line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new project contract line: value: ia::result: key: '7' id: '7' href: /objects/construction/project-contract-line/7 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-contract-line/{key}: parameters: - name: key description: System-assigned key for the project contract line. in: path required: true schema: type: string get: summary: Get a project contract line description: Returns detailed information for a specified project contract line. tags: - Construction_Project contract lines operationId: get-construction-project-contract-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the project contract line properties: ia::result: $ref: '#/components/schemas/construction-project-contract-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Project contract line details: value: ia::result: key: '4' id: '003' projectContract: key: '1' id: BTI-01 name: Berkeley Technology Inc - Contract 01[Revised] href: /objects/construction/project-contract/1 name: 'BTI-01: line 3' parent: key: '2' id: '002' name: line 2 href: /objects/construction/project-contract-line/2 description: additional services contractLineDate: '2023-10-05' glAccount: key: '207' id: '5001' name: Construction href: /objects/general-ledger/account/207 retainagePercentage: '0.00' isBillable: true billingSetup: billingType: progressBill maximumBilling: totalPrice maximumBillingAmount: '0.00' summarizeBill: false billing: billedPrice: '2810.65' billedNetRetainage: '2810.65' percentBilled: '50.00' percentBilledNetRetainage: '50.00' retainageHeld: '0.00' retainageReleased: '0.00' retainageBalance: '0.00' paymentsReceived: '1000.00' previouslyAppliedPrice: '0.00' summary: originalPrice: '0.00' revisionPrice: '0.00' forecastPrice: '0.00' approvedChangePrice: '0.00' pendingChangePrice: '210.65' otherPrice: '0.00' totalPrice: '0.00' dimensions: location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 customer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 department: key: '3' id: '3' name: Engineering href: /objects/company-config/department/3 project: key: '1' id: DIM - BTI name: Dimensions - Berkeley Technology Inc href: /objects/projects/project/1 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 item: key: '18' id: Implementation name: Implimentation href: /objects/inventory-control/item/18 class: key: '6' id: '4' name: Professional Services href: /objects/company-config/class/6 excludeFromGLBudget: false scope: Initial survey inclusions: NA exclusions: NA terms: Standard schedule: scheduledStartDate: '2023-06-12' actualStartDate: '2023-06-15' scheduledCompletionDate: '2023-06-21' revisedCompletionDate: '2023-06-28' substantialCompletionDate: '2023-06-20' actualCompletionDate: '2023-06-28' noticeToProceedDate: '2023-06-01' responseDueDate: '2023-06-05' executedOnDate: '2023-06-08' scheduleImpact: 2 days internalReference: referenceNumber: Ref-BTI-03-003 initiatedBy: key: '2' id: '2' name: Hatcher href: /objects/company-config/employee/2 verbalApprovalBy: key: '2' id: '2' name: Hatcher href: /objects/company-config/employee/2 issuedBy: key: '28' id: '22' name: Chandler href: /objects/company-config/employee/28 issuedOnDate: '2023-06-10' approvedBy: key: '31' id: '23' name: Jurasek href: /objects/company-config/employee/31 approvedOnDate: '2023-06-11' signedBy: key: '1' id: '1' name: Reser href: /objects/company-config/employee/1 signedOnDate: '2023-06-11' source: None sourceReferenceNumber: NA externalReference: referenceNumber: E-REF-003 verbalApprovalBy: key: '94' name: Aaron href: /objects/company-config/contact/94 approvedBy: key: '115' name: Ashish href: /objects/company-config/contact/115 approvedOnDate: '2023-06-12' signedBy: key: '224' name: Able and Sons, Accountants href: /objects/company-config/contact/224 signedOnDate: '2023-06-15' attachment: id: pc-att-1 key: '6' href: /objects/company-config/attachment/6 status: active audit: createdDateTime: '2023-12-07T21:26:38Z' modifiedDateTime: '2023-12-18T00:08:31Z' createdBy: '1' modifiedBy: '1' rateTables: default: key: '1' id: rt_main href: /objects/construction/rate-table/1 timesheet: key: '1' id: rt_main href: /objects/construction/rate-table/1 purchasing: key: '1' id: rt_main href: /objects/construction/rate-table/1 ap: key: '1' id: rt_main href: /objects/construction/rate-table/1 gl: key: '1' id: rt_main href: /objects/construction/rate-table/1 creditCard: key: '1' id: rt_main href: /objects/construction/rate-table/1 employeeExpense: key: '1' id: rt_main href: /objects/construction/rate-table/1 projectContractLineEntries: - key: '5' id: '5' projectContractLine: key: '4' id: '003' href: /objects/construction/project-contract-line/4 workflowType: original dimensions: location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 department: key: '3' id: '3' name: Engineering href: /objects/company-config/department/3 project: key: '1' id: DIM - BTI name: Dimensions - Berkeley Technology Inc href: /objects/projects/project/1 customer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '27' id: '12' name: Eberhardt href: /objects/company-config/employee/27 item: key: '240' id: '3' name: 'Rebar #10' href: /objects/inventory-control/item/240 class: key: '6' id: '4' name: Professional Services href: /objects/company-config/class/6 quantity: '2.50' externalUOM: box unitPrice: '95.75' price: '191.50' priceMarkupPercent: '10.00' priceMarkupAmount: '19.15' linePrice: '210.65' memo: '[updated]' priceEffectiveDate: '2023-10-21' href: /objects/construction/project-contract-line-entry/5 changeRequestEntries: - key: '6' id: '6' changeRequest: key: '1' id: CR1-DIMBTI-CRHSrce href: /objects/construction/change-request/1 workflowType: pendingChange dimensions: location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 department: key: '3' id: '3' name: Engineering href: /objects/company-config/department/3 project: key: '1' id: DIM - BTI name: Dimensions - Berkeley Technology Inc href: /objects/projects/project/1 customer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '27' id: '12' name: Eberhardt href: /objects/company-config/employee/27 item: key: '240' id: '3' name: 'Rebar #10' href: /objects/inventory-control/item/240 class: key: '6' id: '4' name: Professional Services href: /objects/company-config/class/6 numberOfProductionUnits: '500' productionUnitDescription: sqft quantity: '2.50' externalUOM: box unitCost: '100.00' cost: '1000.00' unitPrice: '100.00' price: '1000.00' priceMarkupPercent: '10.00' priceMarkupAmount: '100.00' linePrice: '1100.00' memo: change request priceEffectiveDate: '2023-10-30' projectChangeOrder: key: '1' id: PCO1-DIMBTI href: /objects/construction/project-change-order/1 projectEstimate: key: '1' id: PrimEst-DIMBTI href: /objects/construction/project-estimate/1 glAccount: key: '222' id: '5008' name: Salaries - Contract href: /objects/general-ledger/account/222 projectContract: key: '1' id: BTI-01 name: Berkeley Technology Inc - Contract 01[Revised] href: /objects/construction/project-contract/1 projectContractLine: key: '4' id: '003' name: 003-Billable Labor href: /objects/construction/project-contract-line/4 href: /objects/construction/change-request-line/6 href: /objects/construction/project-contract-line/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a project contract line description: >- Updates an existing project contract line by setting field values. Any fields not provided remain unchanged. tags: - Construction_Project contract lines operationId: update-construction-project-contract-line-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-project-contract-line' - type: object properties: id: readOnly: true examples: Update a line and a line entry: value: name: 'BTI-01: line 1' description: additional services dimensions: vendor: key: '24' department: key: '3' employee: key: '1' class: key: '4' item: key: '15' projectContractLineEntries: - key: '1' workflowType: original dimensions: project: key: '11' item: key: '3' quantity: '2.5' externalUOM: box unitPrice: '95.75' priceMarkupPercent: '10' price: '191.50' priceMarkupAmount: '19.15' linePrice: '210.65' memo: updated markup priceEffectiveDate: '2023-10-21' Add a line entry: value: projectContractLineEntries: - workflowType: revision dimensions: project: key: '11' item: key: '3' quantity: '2' externalUOM: each unitPrice: '46' priceMarkupPercent: '10' memo: added new charge priceEffectiveDate: '2023-10-10' Delete a line entry: value: projectContractLineEntries: - ia::operation: delete key: '2' responses: '200': description: OK content: application/json: schema: type: object title: Updated project-contract-line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated project contract line: value: ia::result: key: '1' id: '003' href: /objects/construction/project-contract-line/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a project contract line description: Deletes a project contract line. tags: - Construction_Project contract lines operationId: delete-construction-project-contract-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-contract-line-entry: get: summary: List project contract line entries description: > Returns up to 100 object references from the collection with a key, ID, and link for each object. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned. tags: - Construction_Project contract line entries operationId: list-construction-project-contract-line-entry responses: '200': description: OK content: application/json: schema: type: object title: List of project-contract-line-entry objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: example-result-collection-of-project-contract-line-entries: value: ia::result: - key: '44' id: '44' href: /objects/construction/project-contract-line-entry/44 - key: '40' id: '40' href: /objects/construction/project-contract-line-entry/40 - key: '1' id: '1' href: /objects/construction/project-contract-line-entry/1 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-contract-line-entry/{key}: parameters: - name: key description: System-assigned key for the project contract line entry. in: path required: true schema: type: string get: summary: Get a project contract line entry description: >- Returns detailed information for a specified project contract line entry. tags: - Construction_Project contract line entries operationId: get-construction-project-contract-line-entry-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the project-contract-line-entry properties: ia::result: $ref: '#/components/schemas/construction-project-contract-line-entry' ia::meta: $ref: '#/components/schemas/metadata' examples: Project contract line entry details: value: ia::result: key: '5' id: '5' projectContractLine: key: '4' id: '003' href: /objects/construction/project-contract-line/4 workflowType: original dimensions: location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 department: key: '3' id: '3' name: Engineering href: /objects/company-config/department/3 project: key: '1' id: DIM - BTI name: Dimensions - Berkeley Technology Inc href: /objects/projects/project/1 customer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 vendor: key: '43' id: 1099 Int name: 1099 Int href: /objects/accounts-payable/vendor/43 employee: key: '27' id: '12' name: Eberhardt href: /objects/company-config/employee/27 item: key: '240' id: '3' name: 'Rebar #10' href: /objects/inventory-control/item/240 class: key: '6' id: '4' name: Professional Services href: /objects/company-config/class/6 quantity: '2.50' externalUOM: box unitPrice: '95.75' price: '191.50' priceMarkupPercent: '10.00' priceMarkupAmount: '19.15' linePrice: '210.65' memo: '[updated]' priceEffectiveDate: '2021-10-21' href: /objects/construction/project-contract-line-entry/5 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a project contract line entry description: Deletes a project contract line entry. tags: - Construction_Project contract line entries operationId: delete-construction-project-contract-line-entry-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-contract-type: get: summary: List project contract types description: > Returns up to 100 object references from the collection with a key, ID, and link for each object. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned. tags: - Construction_project-contract-type operationId: list-construction-project-contract-type responses: '200': description: OK content: application/json: schema: type: object title: construction-project-contract-type Collection properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of project contract types: value: ia::result: - key: '21' id: COM href: /objects/construction/project-contract-type/21 - key: '22' id: RES href: /objects/construction/project-contract-type/22 - key: '23' id: REST-CUST href: /objects/construction/project-contract-type/23 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a project contract type description: Creates a new project contract type. tags: - Construction_project-contract-type operationId: create-construction-project-contract-type requestBody: description: Project contract type to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-project-contract-type' - $ref: '#/components/schemas/construction-project-contract-typeRequiredProperties' examples: example-create-project-contract-type: value: id: RES name: Residential responses: '201': description: Created content: application/json: schema: type: object title: New project contract type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new project contract type: value: ia::result: key: '22' id: RES href: /objects/construction/project-contract-type/22 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-contract-type/{key}: parameters: - name: key description: System-assigned unique key of the project contract type in: path required: true schema: type: string get: summary: Get a project contract type description: Returns detailed information for a specified project contract type tags: - Construction_project-contract-type operationId: get-construction-project-contract-type-key responses: '200': description: OK content: application/json: schema: type: object title: Project contract type details properties: ia::result: $ref: '#/components/schemas/construction-project-contract-type' ia::meta: $ref: '#/components/schemas/metadata' examples: example-result-get-project-contract-type: value: ia::result: key: '22' id: RES name: Residential status: active audit: createdDateTime: '2023-08-19T00:00:00Z' modifiedDateTime: '2023-08-19T00:00:00Z' createdBy: '5' modifiedBy: '43' href: /objects/construction/project-contract-type/22 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a project contract type description: >- Updates an existing project contract type by setting field values. Any fields not provided remain unchanged. tags: - Construction_project-contract-type operationId: update-construction-project-contract-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-project-contract-type' - type: object properties: id: readOnly: true examples: Change the name of a project contract type: value: name: Temp contract responses: '200': description: OK content: application/json: schema: type: object title: Updated project-contract-type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated project contract type: value: ia::result: key: '29' id: TEMP href: /objects/construction/project-contract-type/29 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a project contract type description: Deletes a project contract type tags: - Construction_project-contract-type operationId: delete-construction-project-contract-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-estimate: get: summary: List project estimates description: > Returns up to 100 object references from the collection with a key, ID, and link for each object. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned. tags: - Construction_Project estimates operationId: list-construction-project-estimate responses: '200': description: OK content: application/json: schema: type: object title: List of project-estimate objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Example 1: value: ia::result: - key: '2' id: PJE-01-001 href: /objects/construction/project-estimate/2 - key: '1' id: PJE-00-01 href: /objects/construction/project-estimate/1 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a project estimate description: Creates a new project estimate. tags: - Construction_Project estimates operationId: create-construction-project-estimate requestBody: description: Project estimate to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-project-estimate' - $ref: '#/components/schemas/construction-project-estimateRequiredProperties' examples: Create a new project that contains two project lines: value: id: PE-CB-BTI-003 description: PE-CB-BTI-003 estimateDate: '2024-03-14' isPrimary: false status: active postTo: firstPeriod budget: key: '2' projectEstimateType: key: '7' project: key: '1' projectEstimateLines: - externalUOM: Hour quantity: '10.00' unitCost: '300.00' amount: '3000.00' numberOfProductionUnits: 0 workflowType: original glAccount: key: '210' dimensions: department: key: '3' project: key: '1' item: key: '17' costType: key: '17' class: key: '6' task: key: '1' - externalUOM: Box quantity: '10.00' unitCost: '300.00' amount: '3000.00' numberOfProductionUnits: 0 workflowType: original glAccount: key: '210' dimensions: department: key: '3' project: key: '1' item: key: '17' costType: key: '87' class: key: '6' task: key: '10' responses: '201': description: Created content: application/json: schema: type: object title: New project estimate properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Example 1: value: ia::result: key: '27' id: PE-CB-BTI-003 href: /objects/construction/project-estimate/27 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-estimate/{key}: parameters: - name: key description: System-assigned key for the project estimate. in: path schema: type: string example: '27' required: true get: summary: Get a project estimate description: Returns detailed information for a specified project estimate. tags: - Construction_Project estimates operationId: get-construction-project-estimate-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the project estimate properties: ia::result: $ref: '#/components/schemas/construction-project-estimate' ia::meta: $ref: '#/components/schemas/metadata' examples: Project estimate details including project estimate lines: value: ia::result: key: '27' id: PE-CB-BTI-003 description: PE-CB-BTI-003 estimateDate: '2024-03-14' isPrimary: false status: active isPosted: false budget: key: '2' id: Root PJ Estimates href: /objects/general-ledger/budget/2 postTo: firstPeriod project: key: '1' id: DIM - BTI name: Dimensions - Berkeley Technology Inc beginDate: '2000-01-01' endDate: '2023-12-31' href: /objects/projects/project/1 projectEstimateType: key: '7' id: Original workflowTypes: - original href: /objects/construction/project-estimate-type/7 currency: USD totalEstimateAmount: '6000.00' location: key: '1' id: USA name: United States of America parentProject: key: '2' id: DIM name: Dimensions customer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 attachment: id: Doc001 audit: modifiedDateTime: '2023-03-14T06:25:35Z' createdDateTime: '2023-03-14T06:25:35Z' modifiedBy: '1' createdBy: '1' projectEstimateLines: - id: '68' key: '68' lineNumber: 1 projectEstimate: id: PE-CB-BTI-003 key: '27' href: /objects/construction/project-estimate/27 externalUOM: Hour quantity: '10' unitCost: '300.00' amount: '3000.00' memo: memo for item 1 currency: USD workflowType: original isPosted: false glAccount: key: '210' id: '5001.03' name: Construction Miscellaneous href: /objects/general-ledger/account/210 dimensions: department: key: '3' id: '3' name: Engineering href: /objects/company-config/department/3 location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 project: key: '1' id: DIM - BTI name: Dimensions - Berkeley Technology Inc href: /objects/projects/project/1 customer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 vendor: key: '357' id: '1605212096809' name: GenLab employee: key: '10' id: EMP-10 name: Thomas item: key: '17' id: Design name: Design href: /objects/inventory-control/item/17 class: key: '6' id: '4' name: Professional Services href: /objects/company-config/class/6 task: key: '1' id: TSK-RT-0001 name: DIM - BTI01 href: /objects/projects/task/1 costType: key: '17' id: GNC name: General Conditions DIM-BTI 0001 href: /objects/construction/cost-type/17 effectiveDate: '2022-06-23' numberOfProductionUnits: 0 productionUnitDescription: days changeRequest: key: '1' id: CR-TM-02 href: /objects/construction/change-request/1 changeRequestLine: key: '1' id: '1' href: /objects/construction/change-request-line/1 audit: modifiedDateTime: '2023-03-14T00:00:00Z' createdDateTime: '2023-03-14T00:00:00Z' modifiedBy: '1' createdBy: '1' href: /objects/construction/project-estimate-line/68 - id: '69' key: '69' lineNumber: 2 projectEstimate: id: PE-CB-BTI-003 key: '27' href: /objects/construction/project-estimate/27 externalUOM: Box quantity: '10' unitCost: '300.00' amount: '3000.00' memo: memo for item 2 currency: USD workflowType: original isPosted: false glAccount: key: '210' id: '5001.03' name: Construction Miscellaneous href: /objects/general-ledger/account/210 dimensions: department: key: '3' id: '3' name: Engineering href: /objects/company-config/department/3 location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 project: key: '1' id: DIM - BTI name: Dimensions - Berkeley Technology Inc href: /objects/projects/project/1 customer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 vendor: key: '357' id: '1605212096809' name: GenLab employee: key: '10' id: EMP-10 name: Thomas item: key: '17' id: Design name: Design href: /objects/inventory-control/item/17 class: key: '6' id: '4' name: Professional Services href: /objects/company-config/class/6 task: key: '10' id: TSK-RT-0022 name: DIM - BTI10 href: /objects/projects/task/10 costType: key: '87' id: LABOR name: LABOR GROUP DIM-BTI 0022 href: /objects/construction/cost-type/87 effectiveDate: '2022-06-23' numberOfProductionUnits: 0 productionUnitDescription: days changeRequest: key: '1' id: CR-TM-02 href: /objects/construction/change-request/1 changeRequestLine: key: '1' id: '1' href: /objects/construction/change-request-line/1 audit: modifiedDateTime: '2023-03-14T00:00:00Z' createdDateTime: '2023-03-14T00:00:00Z' modifiedBy: '1' createdBy: '1' href: /objects/construction/project-estimate-line/69 href: /objects/construction/project-estimate/27 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a project estimate description: > Updates an existing project estimate by setting field values. Any fields not provided remain unchanged. If the `budget` reference is change when `isPosted` is `true`, the estimate is unposted from the first budget and posted to the new budget. tags: - Construction_Project estimates operationId: update-construction-project-estimate-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-project-estimate' - type: object properties: id: readOnly: true examples: Update an existing line and add a new line: value: description: Project estimate for BUD BTI- update4 estimateDate: '2022-06-24' projectEstimateLines: - key: '70' externalUOM: Seconds quantity: '10.00' unitCost: '500.00' amount: '5000.00' numberOfProductionUnits: 0 workflowType: original glAccount: key: '210' dimensions: department: key: '7' project: key: '1' item: key: '17' costType: key: '17' class: key: '2' task: key: '1' - externalUOM: Seconds quantity: '10.00' unitCost: '600.00' amount: '6000.00' numberOfProductionUnits: 0 workflowType: original glAccount: key: '210' dimensions: department: key: '7' project: key: '1' item: key: '17' costType: key: '17' class: key: '2' task: key: '1' Update an existing line: value: description: Project estimate for BUD BTI- update3 estimateDate: '2022-06-24' projectEstimateLines: - key: '70' externalUOM: Seconds quantity: '10.00' unitCost: '400.00' amount: '4000.00' numberOfProductionUnits: 0 workflowType: original glAccount: key: '210' dimensions: department: key: '7' project: key: '1' item: key: '17' costType: key: '17' class: key: '2' task: key: '1' Delete a line: value: projectEstimateLines: - ia::operation: delete key: '67' responses: '200': description: OK content: application/json: schema: type: object title: Updated project estimate properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update an existing line and add a new line: value: ia::result: key: '23' id: PE-GL-T001 href: /objects/construction/project-estimate/23 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Update an existing line: value: ia::result: key: '23' id: PE-GL-T001 href: /objects/construction/project-estimate/23 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Delete a line: value: ia::result: key: '23' id: PE-GL-T001 href: /objects/construction/project-estimate/23 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a project estimate description: >- Deletes a project estimate. A primary project estimate cannot be deleted. tags: - Construction_Project estimates operationId: delete-construction-project-estimate-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-estimate-line: get: summary: List project estimate lines description: > Returns up to 100 object references from the collection with a key, ID, and link for each object. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned. tags: - Construction_Project estimate lines operationId: list-construction-project-estimate-line responses: '200': description: OK content: application/json: schema: type: object title: List of project-estimate-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Example 1: value: ia::result: - key: '32' id: '32' href: /objects/construction/project-estimate-line/32 - key: '34' id: '34' href: /objects/construction/project-estimate-line/34 - key: '31' id: '31' href: /objects/construction/project-estimate-line/31 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-estimate-line/{key}: parameters: - name: key description: System-assigned key for the project estimate line. in: path required: true schema: type: string example: '101' get: summary: Get a project estimate line description: Returns detailed information for a specified project estimate line. tags: - Construction_Project estimate lines operationId: get-construction-project-estimate-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the project estimate line properties: ia::result: $ref: '#/components/schemas/construction-project-estimate-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Project estimate line details: value: ia::result: key: '1' id: '1' amount: '2000.00' quantity: '10' unitCost: '1000.00' currency: USD memo: service charges lineNumber: 1 externalUOM: Piece workflowType: original isPosted: false effectiveDate: '2022-06-23' numberOfProductionUnits: 200 productionUnitDescription: days projectEstimate: key: '1' id: Original href: /objects/construction/project-estimate/1 glAccount: key: '144' id: '1112' name: Employee Advances href: /objects/general-ledger/account/144 changeRequest: key: '1' id: CR-TM-02 href: /objects/construction/change-request/1 changeRequestLine: key: '1' id: '1' href: /objects/construction/change-request-line/1 dimensions: location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 department: key: '1' id: '2' name: Engineering href: /objects/company-config/department/1 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 href: /objects/asset/1 audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' href: /objects/construction/project-estimate-line/1 ia::meta: totalCount: 3 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-estimate-type: get: summary: List project estimate types description: >- Returns up to 100 object references from the collection with a key, ID, and link for each project estimate type. 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: - Construction_Project estimate types operationId: list-construction-project-estimate-type responses: '200': description: OK content: application/json: schema: type: object title: List of project-estimate-type objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Example 1: value: ia::result: - key: '1' id: ApprovedChange href: /objects/construction/project-estimate-type/1 - key: '2' id: Original href: /objects/construction/project-estimate-type/2 - key: '3' id: No SWFT href: /objects/construction/project-estimate-type/3 - key: '4' id: Novaluesxml href: /objects/construction/project-estimate-type/4 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a project estimate type description: Creates a new project estimate type. tags: - Construction_Project estimate types operationId: create-construction-project-estimate-type requestBody: description: Project estimate type to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-project-estimate-type' - $ref: '#/components/schemas/construction-project-estimate-typeRequiredProperties' examples: Create a project estimate: value: id: ApprovedChangeandOther workflowTypes: - approvedChange - other estimateCategory: originalEstimate responses: '201': description: Created content: application/json: schema: type: object title: Reference to new project estimate type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new project estimate type: value: ia::result: key: '9' id: ApprovedChangeandOther href: /objects/construction/project-estimate-type/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/project-estimate-type/{key}: parameters: - name: key description: System-assigned key for the project estimate type. in: path required: true schema: type: string example: '8' get: summary: Get a project estimate type description: Returns detailed information for a specified project estimate type. tags: - Construction_Project estimate types operationId: get-construction-project-estimate-type-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the project estimate type properties: ia::result: $ref: '#/components/schemas/construction-project-estimate-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Project estimate type details: value: ia::result: key: '9' id: ApprovedChangeandOther status: active workflowTypes: - approvedChange - other audit: createdDateTime: '2024-02-19T07:32:40Z' modifiedDateTime: '2024-02-19T07:32:40Z' createdBy: '1' modifiedBy: '1' estimateCategory: originalEstimate href: /objects/construction/project-estimate-type/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a project estimate type description: >- Updates an existing project estimate type by setting field values. Any fields not provided remain unchanged. tags: - Construction_Project estimate types operationId: update-construction-project-estimate-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-project-estimate-type' - type: object properties: id: readOnly: true examples: Set a project estimate type to inactive status: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Reference to the updated project estimate type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to the updated project estimate type: value: ia::result: key: '9' id: ApprovedChangeandOther href: /objects/construction/project-estimate-type/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a project estimate type description: Deletes a project estimate type. tags: - Construction_Project estimate types operationId: delete-construction-project-estimate-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/standard-cost-type: get: summary: List standard cost types description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each standard cost type. 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
SubscriptionProject Costing or Construction
User ypeBusiness, Employee, Project Manager
PermissionsList Standard Cost Types
tags: - Construction_Standard cost types operationId: list-construction-standard-cost-type responses: '200': description: OK content: application/json: schema: type: object title: List of standard cost types properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of standard cost types: value: ia::result: - key: '7' id: LAB href: /objects/construction/standard-cost-type/7 - key: '1' id: EQ href: /objects/construction/standard-cost-type/1 - key: '2' id: EQ-Rental href: /objects/construction/standard-cost-type/2 - key: '3' id: EQ-Owned href: /objects/construction/standard-cost-type/3 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a standard cost type description: >+ Creates a new standard cost type.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Project Manager
PermissionsAdd Standard Cost Types
tags: - Construction_Standard cost types operationId: create-construction-standard-cost-type requestBody: description: Standard cost type to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-standard-cost-type' - $ref: '#/components/schemas/construction-standard-cost-typeRequiredProperties' examples: Create a standard cost type: value: id: EQ-Owned name: EQ Owned description: EQ Owned accumulationType: id: Equipment glAccount: key: '208' parent: id: EQ item: id: Equipment responses: '201': description: Created content: application/json: schema: type: object title: Reference to new standard cost type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new standard cost type: value: ia::result: key: '14' id: EQ-Owned href: /objects/construction/standard-cost-type/14 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/standard-cost-type/{key}: parameters: - name: key description: System-assigned key for the standard cost type. in: path example: '1050' required: true schema: type: string get: summary: Get a standard cost type description: >+ Returns detailed information for a specified standard cost type.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Employee, Project Manager
PermissionsView Standard Cost Types
tags: - Construction_Standard cost types operationId: get-construction-standard-cost-type-key responses: '200': description: OK content: application/json: schema: type: object title: Standard cost type properties: ia::result: $ref: '#/components/schemas/construction-standard-cost-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Standard cost type details: value: ia::result: key: '10' id: LAB-REG name: Labor Regular description: Labor Regular accumulationType: key: '1' id: Labor href: /objects/construction/accumulation-type/1 costUnitDescription: null status: active glAccount: key: '208' id: '5001.01' href: /objects/general-ledger/account/208 parent: key: '7' id: LAB name: Labor href: /objects/construction/standard-cost-type/7 item: key: '320' id: Labor name: Labor href: /objects/inventory-control/item/320 audit: createdDateTime: '2022-10-14T15:45:22Z' modifiedDateTime: '2022-10-14T15:46:44Z' createdBy: '1' modifiedBy: '1' href: /objects/construction/standard-cost-type/10 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a standard cost type description: >+ Updates an existing standard cost type by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Project Manager
PermissionsEdit Standard Cost Types
tags: - Construction_Standard cost types operationId: update-construction-standard-cost-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-standard-cost-type' - type: object properties: id: readOnly: true examples: Update standard cost type fields: value: description: Owned equipment costUnitDescription: each glAccount: id: '5001.05' item: id: Equipment parent: id: OH responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated standard cost type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated standard cost type: value: ia::result: key: '14' id: EQ-Owned href: /objects/construction/standard-cost-type/14 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a standard cost type description: >+ Deletes a standard cost type. You cannot delete a standard cost type if it has been used to create a cost type in a project.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Project Manager
PermissionsDelete Standard Cost Types
tags: - Construction_Standard cost types operationId: delete-construction-standard-cost-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/cost-type: get: summary: List cost types. description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each cost type. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Employee, Project Manager
PermissionsList Cost Types
tags: - Construction_Cost types operationId: list-construction-cost-type responses: '200': description: OK content: application/json: schema: type: object title: List of cost types properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of cost types: value: ia::result: - key: '1' id: '1' href: /objects/construction/cost-type/1 - key: '2' id: '2' href: /objects/construction/cost-type/2 - key: '3' id: '4' href: /objects/construction/cost-type/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a cost type description: >+ Creates a new cost type. When you create a cost type, the following field values from the given standard cost type are used unless you override them: * `accumulationType` * `glAccount` * `parent` * `item` Custom field values from the standard cost type can also be used by the cost type. For this to work, the standard cost type and the cost type must have same custom fields with the same IDs, types, and lengths. Custom fields of type Sequence are not copied. Parent-child relationships defined by standard cost types are preserved when cost types are created.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Project Manager
PermissionsAdd Cost Types
tags: - Construction_Cost types operationId: create-construction-cost-type requestBody: description: Cost type to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-cost-type' - $ref: '#/components/schemas/construction-cost-typeRequiredProperties' examples: Create a cost type: value: project: id: Project Expense 1 task: id: ID1 name: Costtype2 description: standard task1 accumulationType: id: '1' costUnitDescription: Hours glAccount: id: '5000' item: id: '1' planned: startDate: '2024-10-31' endDate: '2024-12-31' root: id: '1' standardCostType: id: '2' responses: '201': description: Created content: application/json: schema: type: object title: Reference to new cost type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new cost type: value: ia::result: key: '40' id: '40' href: /objects/construction/cost-type/40 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/cost-type/{key}: parameters: - name: key description: System-assigned key for the cost type. in: path example: '495' required: true schema: type: string get: summary: Get a cost type description: >+ Returns detailed information for a specified cost type.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Employee, Project Manager
PermissionsView Cost Types
tags: - Construction_Cost types operationId: get-construction-cost-type-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the cost type properties: ia::result: $ref: '#/components/schemas/construction-cost-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Cost type details: value: ia::result: key: '5941' project: key: '109' id: 22-001 name: Wallula Heights Conference Center href: /objects/projects/project/109 task: key: '690' id: 2-050 name: Demolition href: /objects/projects/task/690 id: EQ name: Equipment description: Equipment Group accumulationType: id: '3' key: '3' name: Equipment href: /objects/construction/accumulation-type/3 costUnitDescription: null status: active glAccount: key: '383' id: '5001.07' href: /objects/general-ledger/account/383 parent: key: '490' id: '1' name: EQ item: key: '317' id: Equipment name: Equipment href: /objects/inventory-control/item/317 planned: startDate: '2022-04-30' endDate: '2022-06-30' actual: startDate: '2022-04-30' endDate: '2022-06-30' audit: createdDateTime: '2022-01-25T16:11:28Z' modifiedDateTime: '2022-01-25T16:11:28Z' createdBy: '1' modifiedBy: '1' root: key: '5941' id: EQ name: Equipment href: /objects/construction/cost-type/5941 standardCostType: key: '1' id: EQ name: Equipment href: /objects/construction/cost-type/1 href: /objects/construction/cost-type/5941 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a cost type description: >+ Updates an existing cost type by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Project Manager
PermissionsEdit Cost Types
tags: - Construction_Cost types operationId: update-construction-cost-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-cost-type' - type: object properties: id: readOnly: true examples: Updates a cost type: value: description: Updated cost type responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated cost type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated cost type: value: ia::result: key: '40' id: '40' href: /objects/construction/cost-type/40 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a cost type description: >+ Deletes a cost type.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Project Manager
PermissionsDelete Cost Type
tags: - Construction_Cost types operationId: delete-construction-cost-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/standard-task: get: summary: List standard tasks description: >- Returns up to 100 object references from the collection with a key, ID, and link for each standard task. 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: - Construction_Standard tasks operationId: list-construction-standard-task responses: '200': description: OK content: application/json: schema: type: object title: List of standard-task objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: example-result-collection-of-standard-tasks: value: ia::result: - key: '1' id: 1-000 href: /objects/construction/standard-task/1 - key: '2' id: 3-010 href: /objects/construction/standard-task/2 - key: '3' id: 1-020 href: /objects/construction/standard-task/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a standard task description: Creates a new standard task. tags: - Construction_Standard tasks operationId: create-construction-standard-task requestBody: description: Standard task to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-standard-task' - $ref: '#/components/schemas/construction-standard-taskRequiredProperties' examples: Create a standard task: value: id: 1-010 name: Summary of Work description: Summary of Work status: active isBillable: false isMilestone: false isUtilized: false parent: id: 1-000 standardCostTypes: - id: EQ - id: EQ-Owned - id: EQ-Rental - id: LAB - id: LAB-OT - id: LAB-REG - id: LAB-SALARY - id: LAB-BURDEN - id: MAT - id: OH - id: OTH responses: '201': description: Created content: application/json: schema: type: object title: Reference to new standard task properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new standard task: value: ia::result: key: '2' id: 1-010 href: /objects/construction/standard-task/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/standard-task/{key}: parameters: - name: key description: System-assigned key for the standard task. in: path required: true schema: type: string get: summary: Get a standard task description: Returns detailed information for a specified standard task. tags: - Construction_Standard tasks operationId: get-construction-standard-task-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the standard task properties: ia::result: $ref: '#/components/schemas/construction-standard-task' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the standard task: value: ia::result: key: '312' id: 1-010 name: Summary of Work description: 'General Conditions: Summary of Work' productionUnitDescription: days status: active item: key: '318' id: Other name: Other href: /objects/inventory-control/item/318 isBillable: false isMilestone: false isUtilized: true timeType: key: '11' name: Design wbsCode: S parent: key: '1' id: 1-000 name: GENERAL CONDITIONS href: /objects/construction/standard-task/1 class: key: '8' id: CON name: Construction href: /objects/company-config/class/8 audit: createdDateTime: '2021-11-23T23:57:52Z' modifiedDateTime: '2021-11-29T23:15:38Z' createdBy: '1' modifiedBy: '1' standardCostTypes: - key: '1' id: EQ href: /objects/construction/standard-cost-type/1 - key: '3' id: EQ-Owned href: /objects/construction/standard-cost-type/3 href: /objects/construction/standard-task/312 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a standard task description: >- Updates an existing standard task by setting field values. Any fields not provided remain unchanged. tags: - Construction_Standard tasks operationId: update-construction-standard-task-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-standard-task' - type: object properties: id: readOnly: true examples: Update standard task and add standard cost type: value: description: 'General Conditions: Summary of Work' productionUnitDescription: days isUtilized: true class: id: '3' standardCostTypes: - id: SUB Delete a standard cost type: value: standardCostTypes: - key: '13' ia::operation: delete Update standard cost type: value: standardCostTypes: - key: '11' id: MAT responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated standard task properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated standard task: value: ia::result: key: '2' id: 1-010 href: /objects/construction/standard-task/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a standard task description: Deletes a standard task tags: - Construction_Standard tasks operationId: delete-construction-standard-task-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/accumulation-type: get: summary: List accumulation types description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each accumulation type. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Employee, Project Manager
PermissionsList Accumulation Types
tags: - Construction_Accumulation types operationId: list-construction-accumulation-type responses: '200': description: OK content: application/json: schema: type: object title: List of accumulation types properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of accumulation types: value: ia::result: - key: '1' id: Direct cost href: /objects/construction/accumulation-type/1 - key: '2' id: Indirect cost href: /objects/construction/accumulation-type/2 - key: '3' id: Equipment cost href: /objects/construction/accumulation-type/3 ia::meta: totalCount: 3 start: 1 pageSize: 50 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an accumulation type description: >+ Creates a new accumulation type.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Project Manager
PermissionsAdd Accumulation Types
tags: - Construction_Accumulation types operationId: create-construction-accumulation-type requestBody: description: Accumulation type to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-accumulation-type' examples: Creates an accumulation type: value: id: Direct cost status: active costCategory: material responses: '201': description: Created content: application/json: schema: type: object title: Reference to new accumulation type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new accumulation type: value: ia::result: key: '40' id: '40' href: /objects/construction/accumulation-type/40 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/accumulation-type/{key}: parameters: - name: key description: System-assigned key for the accumulation type. in: path required: true example: '3086' schema: type: string get: summary: Get an accumulation type description: >+ Returns detailed information for a specified accumulation type.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Employee, Project Manager
PermissionsView Accumulation Types
tags: - Construction_Accumulation types operationId: get-construction-accumulation-type-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the accumulation type properties: ia::result: $ref: '#/components/schemas/construction-accumulation-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the accumulation type: value: ia::result: key: '1' id: Direct cost status: active audit: createdDateTime: '2023-10-14T15:12:40Z' modifiedDateTime: '2023-10-14T15:12:40Z' createdBy: '1' modifiedBy: '1' costCategory: labor href: /objects/construction/accumulation-type/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an accumulation type description: >+ Updates an existing accumulation type by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Project Manager
PermissionsEdit Accumulation Types
tags: - Construction_Accumulation types operationId: update-construction-accumulation-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-accumulation-type' - type: object properties: id: readOnly: true examples: Updates the costCategory: value: costCategory: other responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated accumulation type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated accumulation type: value: ia::result: key: '40' id: Direct cost href: /objects/construction/accumulation-type/40 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an accumulation type description: >+ Deletes an accumulation type.
Permissions and other requirements
SubscriptionProject Costing or Construction
User ypeBusiness, Project Manager
PermissionsDelete Accumulation Type
tags: - Construction_Accumulation types operationId: delete-construction-accumulation-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/employee-position: get: summary: List employee positions description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each employee position. This operation is mostly for use in testing; use query to find employee positions that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsList Employee Positions
tags: - Construction_Employee positions operationId: list-construction-employee-position responses: '200': description: OK content: application/json: schema: type: object title: List of employee-position objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of employee positions: value: ia::result: - key: '1' id: EP-001 href: /objects/construction/employee-position/1 - key: '2' id: EP-002 href: /objects/construction/employee-position/2 - key: '7' id: PLUM-001 href: /objects/construction/employee-position/7 - key: '8' id: FOR-001 href: /objects/construction/employee-position/8 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee position description: >+ Creates a new employee position.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsAdd Employee Positions
tags: - Construction_Employee positions operationId: create-construction-employee-position requestBody: description: Employee position to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-employee-position' - $ref: '#/components/schemas/construction-employee-positionRequiredProperties' examples: Create an employee position: value: id: FOR-001 name: Foreman-01 description: Job site foreman status: active responses: '201': description: Created content: application/json: schema: type: object title: Reference to new employee position properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new employee position: value: ia::result: key: '8' id: FOR-001 href: /objects/construction/employee-position/8 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/employee-position/{key}: parameters: - name: key description: System-assigned key for the employee position. in: path required: true schema: type: string example: '41' get: summary: Get an employee position description: >+ Returns detailed information for a specified employee position.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsList, View Employee Positions
tags: - Construction_Employee positions operationId: get-construction-employee-position-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee position properties: ia::result: $ref: '#/components/schemas/construction-employee-position' ia::meta: $ref: '#/components/schemas/metadata' examples: employee position details: value: ia::result: key: '8' id: FOR-001 name: Foreman-01 description: Job site foreman status: active audit: createdDateTime: '2023-02-02T23:32:10Z' modifiedDateTime: '2023-03-03T01:24:56Z' createdBy: '1' modifiedBy: '1' href: /objects/construction/employee-position/8 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee position description: >+ Updates an existing employee position by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsUpdate Employee Position
tags: - Construction_Employee positions operationId: update-construction-employee-position-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-employee-position' - type: object properties: id: readOnly: true examples: Set a position to inactive: value: description: (deactivated) This employee is a foreman status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated employee position properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated employee position: value: ia::result: key: '8' id: FOR-001 href: /objects/construction/employee-position/8 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee position description: >+ Deletes an employee position.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsDelete Employee Position
tags: - Construction_Employee positions operationId: delete-construction-employee-position-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/labor-class: get: summary: List labor classes description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each labor class. This operation is mostly for use in testing; use query to find labor classes that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsList Labor Classes
tags: - Construction_Labor classes operationId: list-construction-labor-class responses: '200': description: OK content: application/json: schema: type: object title: List of labor-class objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of labor classes: value: ia::result: - key: '6' id: LC001 href: /objects/construction/labor-class/6 - key: '7' id: LC002 href: /objects/construction/labor-class/7 - key: '8' id: LC003 href: /objects/construction/labor-class/8 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a labor class description: >+ Creates a new labor class.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsAdd Labor Class
tags: - Construction_Labor classes operationId: create-construction-labor-class requestBody: description: Labor class to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-labor-class' - $ref: '#/components/schemas/construction-labor-classRequiredProperties' examples: example-1: value: id: LC001 name: LC Skilled description: Skilled laborer status: active responses: '201': description: Created content: application/json: schema: type: object title: Reference to new labor class properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new labor class: value: ia::result: key: '6' id: LC001 href: /objects/construction/labor-class/6 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/labor-class/{key}: parameters: - name: key description: System-assigned key for the labor class. in: path required: true schema: type: string example: '23' get: summary: Get a labor class description: >+ Returns detailed information for a specified labor class.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsList, View Labor Classes
tags: - Construction_Labor classes operationId: get-construction-labor-class-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the labor class properties: ia::result: $ref: '#/components/schemas/construction-labor-class' ia::meta: $ref: '#/components/schemas/metadata' examples: Labor class details: value: ia::result: key: '6' id: LC001 name: LC Skilled description: Skilled laborer status: active audit: createdDateTime: '2023-11-21T22:42:02Z' modifiedDateTime: '2023-11-21T22:42:02Z' createdBy: '1' modifiedBy: '1' href: /objects/construction/labor-class/6 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a labor class description: >+ Updates an existing labor class by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsUpdate Labor Class
tags: - Construction_Labor classes operationId: update-construction-labor-class-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-labor-class' - type: object properties: id: readOnly: true examples: Change labor class description: value: description: Professional laborer (salaried) responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated labor class properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated labor class: value: ia::result: key: '8' id: LC003 href: /objects/construction/labor-class/8 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a labor class description: >+ Deletes a labor class.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsDelete Labor Classes
tags: - Construction_Labor classes operationId: delete-construction-labor-class-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/labor-shift: get: summary: List labor shifts description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each labor shift. This operation is mostly for use in testing; use query to find labor shifts that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsList Labor Shifts
tags: - Construction_Labor shifts operationId: list-construction-labor-shift responses: '200': description: OK content: application/json: schema: type: object title: List of labor-shift objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: example-1: value: ia::result: - key: '2' id: LS-AM href: /objects/construction/labor-shift/2 - key: '3' id: LS-PM href: /objects/construction/labor-shift/3 - key: '4' id: LS-NT href: /objects/construction/labor-shift/4 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a labor shift description: >+ Creates a new labor shift.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsAdd Labor Shift
tags: - Construction_Labor shifts operationId: create-construction-labor-shift requestBody: description: Labor shift to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-labor-shift' - $ref: '#/components/schemas/construction-labor-shiftRequiredProperties' examples: Create a labor shift: value: id: LS-AM name: AM Shift description: Morning shift (6am-2pm) status: active responses: '201': description: Created content: application/json: schema: type: object title: Reference to new labor shift properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new labor shift: value: ia::result: key: '2' id: LS-AM href: /objects/construction/labor-shift/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/labor-shift/{key}: parameters: - name: key description: System-assigned key for the labor shift. in: path required: true schema: type: string get: summary: Get a labor shift description: >+ Returns detailed information for a specified labor shift.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsList, View Labor Shifts
tags: - Construction_Labor shifts operationId: get-construction-labor-shift-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the labor shift properties: ia::result: $ref: '#/components/schemas/construction-labor-shift' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of a labor shift: value: ia::result: key: '2' id: LS-AM name: AM Shift description: Morning shift (6am-2pm) status: active audit: createdDateTime: '2021-11-21T23:05:29Z' modifiedDateTime: '2021-11-21T23:05:29Z' createdBy: '1' modifiedBy: '1' href: /objects/construction/labor-shift/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a labor shift description: >+ Updates an existing labor shift by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsUpdate Labor Shifts
tags: - Construction_Labor shifts operationId: update-construction-labor-shift-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-labor-shift' - type: object properties: id: readOnly: true examples: example-1: value: description: (unused) Graveyard shift (10pm-6am) status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated labor shift properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated labor shift: value: ia::result: key: '4' id: LS-NT href: /objects/construction/labor-shift/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a labor shift description: >+ Deletes a labor shift.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsDelete Labor Shift
tags: - Construction_Labor shifts operationId: delete-construction-labor-shift-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/labor-union: get: summary: List labor unions description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each labor union. This operation is mostly for use in testing; use query to find labor unions that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsList Labor Unions
tags: - Construction_Labor unions operationId: list-construction-labor-union responses: '200': description: OK content: application/json: schema: type: object title: List of labor-union objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: example-1: value: ia::result: - key: '1' id: IBEW href: /objects/construction/labor-union/1 - key: '2' id: Teamsters href: /objects/construction/labor-union/2 - key: '3' id: BAC href: /objects/construction/labor-union/3 - key: '4' id: IUEC href: /objects/construction/labor-union/4 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a labor union description: >+ Creates a new labor union.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsAdd Labor Union
tags: - Construction_Labor unions operationId: create-construction-labor-union requestBody: description: Labor union to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-labor-union' - $ref: '#/components/schemas/construction-labor-unionRequiredProperties' examples: Create a labor union: value: id: BAC name: International Union of Bricklayers and Allied Craftworkers description: >- BAC represents all skilled trowel trades workers, including bricklayers, tile setters, plasterers, cement masons, marble masons, restoration workers, and terrazzo and mosaic workers. status: active responses: '201': description: Created content: application/json: schema: type: object title: Reference to new labor union properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new labor shift: value: ia::result: key: '3' id: BAC href: /objects/construction/labor-union/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/labor-union/{key}: parameters: - name: key description: System-assigned key for the labor union. in: path required: true schema: type: string get: summary: Get a labor union description: >+ Returns detailed information for a specified labor union.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsList, View Labor Unions
tags: - Construction_Labor unions operationId: get-construction-labor-union-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the labor-union properties: ia::result: $ref: '#/components/schemas/construction-labor-union' ia::meta: $ref: '#/components/schemas/metadata' examples: example: value: ia::result: key: '4' id: IUEC name: International Union of Elevator Constructors description: >- The IUEC represent the most qualified and trained elevator constructors in the world. Members assemble, install and replace elevators, escalators, dumbwaiters, moving walkways and similar equipment in new and old buildings. Elevator constructors also maintain and repair this equipment and modernize older equipment. status: active audit: createdDateTime: '2021-11-22T00:08:55Z' modifiedDateTime: '2021-11-22T00:11:44Z' createdBy: '1' modifiedBy: '1' href: /objects/construction/labor-union/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a labor union description: >+ Updates an existing labor union by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsUpdate Labor Union
tags: - Construction_Labor unions operationId: update-construction-labor-union-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-labor-union' - type: object properties: id: readOnly: true examples: Update labor union description: value: description: >- The IUEC represent the most qualified and trained elevator constructors in the world. Members assemble, install and replace elevators, escalators, dumbwaiters, moving walkways and similar equipment in new and old buildings. Elevator constructors also maintain and repair this equipment and modernize older equipment. responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated labor union properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated labor union: value: ia::result: key: '4' id: IUEC href: /objects/construction/labor-union/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a labor union description: >+ Deletes a labor union.
Permissions and other requirements
SubscriptionConstruction
User ypeBusiness user with admin permissions
PermissionsDelete Labor Unions
tags: - Construction_Labor unions operationId: delete-construction-labor-union-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table: get: summary: List rate tables description: >- Returns up to 100 object references from the collection with a key, ID, and link for each rate table. 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: - Construction_Rate tables operationId: list-construction-rate-table responses: '200': description: OK content: application/json: schema: type: object title: List of rate table objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of rate tables: value: ia::result: - key: '84' id: RT-00001 href: /objects/construction/rate-table/84 - key: '85' id: RT-00002 href: /objects/construction/rate-table/85 - key: '60' id: RT-00003 href: /objects/construction/rate-table/60 - key: '78' id: RT-00004 href: /objects/construction/rate-table/78 - key: '79' id: RT-00005 href: /objects/construction/rate-table/79 ia::meta: totalCount: 5 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a rate table description: Creates a new rate table. tags: - Construction_Rate tables operationId: create-construction-rate-table requestBody: description: Rate table to be created required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-rate-table' - $ref: '#/components/schemas/construction-rate-tableRequiredProperties' examples: Create a rate table: value: id: 2021-LV2 name: 2021 Level 2 description: 2021 Level 2 Rate Table location: key: '1' status: active timesheetLines: lineNumber: 1 description: Aug Costing Kit startDate: '2021-08-03' markupPercent: '8.250' laborRate: '115.500' accumulationType: key: '2' standardCostType: key: '33' standardTask: key: '3' employeePosition: key: '2' laborClass: key: '2' laborShift: key: '2' laborUnion: key: '2' timeType: key: '1' dimensions: employee: key: '10' project: key: '2' customer: key: '13' vendor: key: '357' item: key: '13' warehouse: key: '6' class: key: '731' task: key: '2' purchasingLines: lineNumber: 1 description: Aug Costing SOPA startDate: '2021-08-03' markupPercent: '15.900' unitPrice: '112.560' accumulationType: key: '2' standardCostType: key: '33' standardTask: key: '3' dimensions: employee: key: '10' project: key: '2' customer: key: '13' vendor: key: '357' item: key: '13' warehouse: key: '6' class: key: '731' task: key: '2' accountsPayableLines: lineNumber: 1 description: Aug Service startDate: '2021-08-01' markupPercent: '25.500' accumulationType: key: '2' standardCostType: key: '33' standardTask: key: '3' dimensions: employee: key: '10' project: key: '2' customer: key: '13' vendor: key: '357' item: key: '13' warehouse: key: '6' class: key: '731' task: key: '2' journalLines: lineNumber: 1 description: Aug John Smith startDate: '2021-08-01' markupPercent: '12.500' accumulationType: key: '2' standardCostType: key: '33' standardTask: key: '3' dimensions: employee: key: '10' project: key: '2' customer: key: '13' vendor: key: '357' item: key: '13' warehouse: key: '6' class: key: '731' task: key: '2' creditCardLines: lineNumber: 1 description: Aug Costing SOPA startDate: '2021-08-03' markupPercent: '15.900' accumulationType: key: '2' standardCostType: key: '33' standardTask: key: '3' dimensions: employee: key: '10' project: key: '2' customer: key: '13' vendor: key: '357' item: key: '13' warehouse: key: '6' class: key: '731' task: key: '2' employeeExpenseLines: lineNumber: 1 description: Aug Manager startDate: '2021-08-02' markupPercent: '14.800' accumulationType: key: '2' standardCostType: key: '33' standardTask: key: '3' dimensions: employee: key: '10' project: key: '2' customer: key: '13' vendor: key: '357' item: key: '13' warehouse: key: '6' class: key: '731' task: key: '2' responses: '201': description: Created content: application/json: schema: type: object title: Reference to new rate table properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new rate table: value: ia::result: key: '111' href: /objects/construction/rate-table/111 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table/{key}: parameters: - name: key description: System-assigned key for the rate table. in: path required: true schema: type: string get: summary: Get a rate table description: Returns detailed information for a specified rate table. tags: - Construction_Rate tables operationId: get-construction-rate-table-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the rate table properties: ia::result: $ref: '#/components/schemas/construction-rate-table' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of rate table: value: ia::result: key: '145' id: 2021-LV2 name: 2021 Level 2 description: 2021 Level 2 Rate Table location: key: '1' id: '1' name: United States audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' status: active timesheetLines: - key: '12' id: '12' rateTable: key: '145' id: 2021-LV2 name: 2021 Level 2 href: /objects/construction/rate-table/145 href: /objects/construction/rate-table-timesheet-line/12 lineNumber: 1 description: Aug Costing Kit startDate: '2021-08-03' markupPercent: '8.250' laborRate: '115.500' accumulationType: key: '2' id: ACCT-2 href: /objects/construction/accumulation-type/2 standardCostType: key: '33' id: CT-RT-0010 name: CT-RT-0010 MATERIAL href: /objects/construction/standard-cost-type/33 standardTask: key: '3' id: TSK-RT-0011 name: TSK-RT-0011 Name href: /objects/construction/standard-task/3 employeePosition: key: '2' id: COO name: Chief Executive Officer href: /objects/construction/employee-position/2 laborClass: key: '2' id: LC-2 name: Labor class 2 href: /objects/construction/labor-class/2 laborShift: key: '2' id: LS-2 name: Day shift href: /objects/construction/labor-shift/2 laborUnion: key: '2' id: LU-2 name: Labor union 2 href: /objects/construction/labor-union/2 timeType: key: '1' id: Salaries At Root href: /objects/projects/time-type/1 dimensions: employee: key: '10' id: '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: '113' 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: key: '2' id: tet name: Design href: /objects/projects/task/2 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' purchasingLines: - key: '176' id: '176' rateTable: key: '145' id: 2021-LV2 name: 2021 Level 2 href: /objects/construction/rate-table/145 href: /objects/construction/rate-table-purchasing-line/176 lineNumber: 1 description: Aug Costing SOPA startDate: '2021-08-03' markupPercent: '15.900' unitPrice: '112.560' accumulationType: key: '2' id: ACCT-2 href: /objects/construction/accumulation-type/2 standardCostType: key: '33' id: CT-RT-0010 name: CT-RT-0010 MATERIAL href: /objects/construction/standard-cost-type/33 standardTask: key: '3' id: TSK-RT-0011 name: TSK-RT-0011 Name href: /objects/construction/standard-task/3 dimensions: employee: key: '10' id: '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: '113' 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: key: '2' id: tet name: Design href: /objects/projects/task/2 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' accountsPayableLines: - key: '397' id: '397' rateTable: key: '145' id: 2021-LV2 name: 2021 Level 2 href: /objects/construction/rate-table/145 href: '/objects/construction/rate-table-credit-card-line/397' lineNumber: 1 description: Aug Service startDate: '2021-08-01' markupPercent: '25.500' accumulationType: key: '2' id: ACCT-2 href: /objects/construction/accumulation-type/2 standardCostType: key: '33' id: CT-RT-0010 name: CT-RT-0010 MATERIAL href: /objects/construction/standard-cost-type/33 standardTask: key: '3' id: TSK-RT-0011 name: TSK-RT-0011 Name href: /objects/construction/standard-task/3 dimensions: employee: key: '10' id: '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: '113' 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: key: '2' id: tet name: Design href: /objects/projects/task/2 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' journalLines: - key: '64' id: '64' rateTable: key: '145' id: 2021-LV2 name: 2021 Level 2 href: /objects/construction/rate-table/145 href: /objects/construction/rate-table-journal-line/64 lineNumber: 1 description: Aug John Smith startDate: '2021-08-01' markupPercent: '12.500' accumulationType: key: '2' id: ACCT-2 href: /objects/construction/accumulation-type/2 standardCostType: key: '33' id: CT-RT-0010 name: CT-RT-0010 MATERIAL href: /objects/construction/standard-cost-type/33 standardTask: key: '3' id: TSK-RT-0011 name: TSK-RT-0011 Name href: /objects/construction/standard-task/3 dimensions: employee: key: '10' id: '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: '113' 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: key: '2' id: tet name: Design href: /objects/projects/task/2 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' creditCardLines: - key: '145' id: '145' rateTable: key: '145' id: 2021-LV2 name: 2021 Level 2 href: /objects/construction/rate-table/145 href: '/objects/construction/rate-table-credit-card-line/145' lineNumber: 1 description: Aug Costing SOPA startDate: '2021-08-03' markupPercent: '15.900' accumulationType: key: '2' id: ACCT-2 href: /objects/construction/accumulation-type/2 standardCostType: key: '33' id: CT-RT-0010 name: CT-RT-0010 MATERIAL href: /objects/construction/standard-cost-type/33 standardTask: key: '3' id: TSK-RT-0011 name: TSK-RT-0011 Name href: /objects/construction/standard-task/3 dimensions: employee: key: '10' id: '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: '113' 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: key: '2' id: tet name: Design href: /objects/projects/task/2 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' employeeExpenseLines: - key: '30' id: '30' rateTable: key: '145' id: 2021-LV2 name: 2021 Level 2 href: /objects/construction/rate-table/145 href: '/objects/construction/rate-table-employee-expense-line/30' lineNumber: 1 description: Aug Manager startDate: '2021-08-02' markupPercent: '14.800' accumulationType: key: '2' id: ACCT-2 href: /objects/construction/accumulation-type/2 standardCostType: key: '33' id: CT-RT-0010 name: CT-RT-0010 MATERIAL href: /objects/construction/standard-cost-type/33 standardTask: key: '3' id: TSK-RT-0011 name: TSK-RT-0011 Name href: /objects/construction/standard-task/3 dimensions: employee: key: '10' id: '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: '113' 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: key: '2' id: tet name: Design href: /objects/projects/task/2 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a rate table description: >- Updates an existing rate table by setting field values. Any fields not provided remain unchanged. tags: - Construction_Rate tables operationId: update-construction-rate-table-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/construction-rate-table' - type: object properties: id: readOnly: true examples: Update a rate table: value: key: '145' description: 2021 Level 2 Rate Table (Aug) timesheetLines: - key: '12' lineNumber: 2 description: Aug Costing Kit (Aug) responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated rate table properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated rate table: value: ia::result: key: '12' id: 2021-LV2 href: /objects/construction/rate-table/12 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a rate table description: Deletes a rate table. tags: - Construction_Rate tables operationId: delete-construction-rate-table-key responses: '204': description: No Content security: - OAuth2: [] /objects/construction/rate-table-accounts-payable-line: get: summary: List rate table accounts payable lines description: >- Returns up to 100 object references from the collection with a key, ID, and link for each 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. tags: - Construction_Rate table accounts payable lines operationId: list-construction-rate-table-accounts-payable-line responses: '200': description: OK content: application/json: schema: type: object title: List of rate-table-accounts-payable-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of rate table accounts payable lines: value: ia::result: - key: '84' id: '84' href: '/objects/construction/rate-table-accounts-payable-line/84' - key: '85' id: '85' href: '/objects/construction/rate-table-accounts-payable-line/85' - key: '60' id: '60' href: '/objects/construction/rate-table-accounts-payable-line/60' - key: '78' id: '78' href: '/objects/construction/rate-table-accounts-payable-line/78' - key: '79' id: '79' href: '/objects/construction/rate-table-accounts-payable-line/79' ia::meta: totalCount: 5 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table-accounts-payable-line/{key}: parameters: - name: key description: System-assigned key for the rate table accounts payable line. in: path required: true schema: type: string get: summary: Get a rate table accounts payable line description: >- Returns detailed information for a particular rate table accounts payable line. tags: - Construction_Rate table accounts payable lines operationId: get-construction-rate-table-accounts-payable-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the rate-table-accounts-payable-line properties: ia::result: $ref: '#/components/schemas/construction-rate-table-accounts-payable-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of rate table accounts payable line: value: ia::result: key: '397' id: '397' rateTable: key: '145' id: 2021-LV2 name: 2021 Level 2 href: /objects/construction/rate-table/145 href: /objects/construction/rate-table-credit-card-line/397 lineNumber: 1 description: Aug Service startDate: '2021-08-01' markupPercent: '25.500' accumulationType: key: '2' id: ACCT-2 href: /objects/construction/accumulation-type/2 standardCostType: key: '33' id: CT-RT-0010 name: CT-RT-0010 MATERIAL href: /objects/construction/standard-cost-type/33 standardTask: key: '3' id: TSK-RT-0011 name: TSK-RT-0011 Name href: /objects/construction/standard-task/3 dimensions: employee: key: '10' id: '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: '113' 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: key: '2' id: tet name: Design href: /objects/projects/task/2 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table-credit-card-line: get: summary: List rate table credit card lines description: >- Returns a collection with a key, ID, and link for each rate table credit card line. tags: - Construction_Rate table credit card lines operationId: list-construction-rate-table-credit-card-line responses: '200': description: OK content: application/json: schema: type: object title: List of rate-table-credit-card-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of rate table credit card lines: value: ia::result: - key: '84' id: '84' href: /objects/construction/rate-table-credit-card-line/84 - key: '85' id: '85' href: /objects/construction/rate-table-credit-card-line/85 - key: '60' id: '60' href: /objects/construction/rate-table-credit-card-line/60 - key: '78' id: '78' href: /objects/construction/rate-table-credit-card-line/78 - key: '79' id: '79' href: /objects/construction/rate-table-credit-card-line/79 ia::meta: totalCount: 5 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table-credit-card-line/{key}: parameters: - name: key description: System-assigned key for the rate table credit card line. in: path required: true schema: type: string get: summary: Get a rate table credit card line description: >- Returns detailed information for a particular rate table credit card line. tags: - Construction_Rate table credit card lines operationId: get-construction-rate-table-credit-card-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the rate-table-credit-card-line properties: ia::result: $ref: '#/components/schemas/construction-rate-table-credit-card-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of rate table credit card line: value: ia::result: key: '145' id: '145' rateTable: key: '145' id: 2021-LV2 name: 2021 Level 2 href: /objects/construction/rate-table/145 href: /objects/construction/rate-table-credit-card-line/145 lineNumber: 1 description: Aug Costing SOPA startDate: '2021-08-03' markupPercent: '15.900' accumulationType: key: '2' id: ACCT-2 href: /objects/construction/accumulation-type/2 standardCostType: key: '33' id: CT-RT-0010 name: CT-RT-0010 MATERIAL href: /objects/construction/standard-cost-type/33 standardTask: key: '3' id: TSK-RT-0011 name: TSK-RT-0011 Name href: /objects/construction/standard-task/3 dimensions: employee: key: '10' id: '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: '113' 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: key: '2' id: tet name: Design href: /objects/projects/task/2 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table-employee-expense-line: get: summary: List rate table employee expense lines description: >- Returns up to 100 object references from the collection with a key, ID, and link for each 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. tags: - Construction_Rate table employee expense lines operationId: list-construction-rate-table-employee-expense-line responses: '200': description: OK content: application/json: schema: type: object title: List of rate-table-employee-expense-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of rate table employee expense lines: value: ia::result: - key: '84' id: '84' href: '/objects/construction/rate-table-employee-expense-line/84' - key: '85' id: '85' href: '/objects/construction/rate-table-employee-expense-line/85' - key: '60' id: '60' href: '/objects/construction/rate-table-employee-expense-line/60' - key: '78' id: '78' href: '/objects/construction/rate-table-employee-expense-line/78' - key: '79' id: '79' href: '/objects/construction/rate-table-employee-expense-line/79' ia::meta: totalCount: 5 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table-employee-expense-line/{key}: parameters: - name: key description: System-assigned key for the rate table employee expense line. in: path required: true schema: type: string get: summary: Get a rate table employee expense line description: >- Returns detailed information for a particular rate table employee expense line. tags: - Construction_Rate table employee expense lines operationId: get-construction-rate-table-employee-expense-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the rate-table-employee-expense-line properties: ia::result: $ref: '#/components/schemas/construction-rate-table-employee-expense-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of rate table employee expense line: value: ia::result: key: '30' id: '30' rateTable: key: '145' id: 2021-LV2 name: 2021 Level 2 href: /objects/construction/rate-table/145 href: '/objects/construction/rate-table-employee-expense-line/30' lineNumber: 1 description: Aug Manager startDate: '2021-08-02' markupPercent: '14.800' accumulationType: key: '2' id: ACCT-2 href: /objects/construction/accumulation-type/2 standardCostType: key: '33' id: CT-RT-0010 name: CT-RT-0010 MATERIAL href: /objects/construction/standard-cost-type/33 standardTask: key: '3' id: TSK-RT-0011 name: TSK-RT-0011 Name href: /objects/construction/standard-task/3 dimensions: employee: key: '10' id: '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: '113' 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: key: '2' id: tet name: Design href: /objects/projects/task/2 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table-journal-line: get: summary: List rate table journal lines description: >- Returns up to 100 object references from the collection with a key, ID, and link for each 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. tags: - Construction_Rate table journal lines operationId: list-construction-rate-table-journal-line responses: '200': description: OK content: application/json: schema: type: object title: List of rate-table-journal-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of rate table journal lines: value: ia::result: - key: '84' id: '84' href: /objects/construction/rate-table-journal-line/84 - key: '85' id: '85' href: /objects/construction/rate-table-journal-line/85 - key: '60' id: '60' href: /objects/construction/rate-table-journal-line/60 - key: '78' id: '78' href: /objects/construction/rate-table-journal-line/78 - key: '79' id: '79' href: /objects/construction/rate-table-journal-line/79 ia::meta: totalCount: 5 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table-journal-line/{key}: parameters: - name: key description: System-assigned key for the rate table journal line. in: path required: true schema: type: string get: summary: Get a rate table journal line description: Returns detailed information for a particular rate table journal line. tags: - Construction_Rate table journal lines operationId: get-construction-rate-table-journal-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the rate-table-journal-line properties: ia::result: $ref: '#/components/schemas/construction-rate-table-journal-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of rate table journal line: value: ia::result: key: '64' id: '64' rateTable: key: '145' id: 2021-LV2 name: 2021 Level 2 href: /objects/construction/rate-table/145 href: /objects/construction/rate-table-journal-line/64 lineNumber: 1 description: Aug John Smith startDate: '2021-08-01' markupPercent: '12.5' accumulationType: key: '2' id: ACCT-2 href: /objects/construction/accumulation-type/2 standardCostType: key: '33' id: CT-RT-0010 name: CT-RT-0010 MATERIAL href: /objects/construction/standard-cost-type/33 standardTask: key: '3' id: TSK-RT-0011 name: TSK-RT-0011 Name href: /objects/construction/standard-task/3 dimensions: employee: key: '10' id: '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: '113' 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: key: '2' id: tet name: Design href: /objects/projects/task/2 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table-purchasing-line: get: summary: List rate table purchasing lines description: >- Returns up to 100 object references from the collection with a key, ID, and link for each 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. tags: - Construction_Rate table purchasing lines operationId: list-construction-rate-table-purchasing-line responses: '200': description: OK content: application/json: schema: type: object title: List of rate-table-purchasing-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of rate table purchasing lines: value: ia::result: - key: '84' id: '84' href: /objects/construction/rate-table-purchasing-line/84 - key: '85' id: '85' href: /objects/construction/rate-table-purchasing-line/85 - key: '60' id: '60' href: /objects/construction/rate-table-purchasing-line/60 - key: '78' id: '78' href: /objects/construction/rate-table-purchasing-line/78 - key: '79' id: '79' href: /objects/construction/rate-table-purchasing-line/79 ia::meta: totalCount: 5 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table-purchasing-line/{key}: parameters: - name: key description: System-assigned key for the rate table purchasing line. in: path required: true schema: type: string get: summary: Get a rate table purchasing line description: >- Returns detailed information for a particular rate table purchasing line. tags: - Construction_Rate table purchasing lines operationId: get-construction-rate-table-purchasing-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the rate-table-purchasing-line properties: ia::result: $ref: '#/components/schemas/construction-rate-table-purchasing-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of rate table purchasing line: value: ia::result: key: '176' id: '176' rateTable: key: '145' id: 2021-LV2 name: 2021 Level 2 href: /objects/construction/rate-table/145 href: /objects/construction/rate-table-purchasing-line/176 lineNumber: 1 description: Aug Costing SOPA startDate: '2021-08-03' markupPercent: '15.900' unitPrice: '112.560' accumulationType: key: '2' id: ACCT-2 href: /objects/construction/accumulation-type/2 standardCostType: key: '33' id: CT-RT-0010 name: CT-RT-0010 MATERIAL href: /objects/construction/standard-cost-type/33 standardTask: key: '3' id: TSK-RT-0011 name: TSK-RT-0011 Name href: /objects/construction/standard-task/3 dimensions: employee: key: '10' id: '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: '113' 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: key: '2' id: tet name: Design href: /objects/projects/task/2 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table-timesheet-line: get: summary: List rate table timesheet lines description: >- Returns up to 100 object references from the collection with a key, ID, and link for each 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. tags: - Construction_Rate table timesheet lines operationId: list-construction-rate-table-timesheet-line responses: '200': description: OK content: application/json: schema: type: object title: List of rate-table-timesheet-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of rate table timesheet lines: value: ia::result: - key: '84' id: '84' href: /objects/construction/rate-table-timesheet-line/84 - key: '85' id: '85' href: /objects/construction/rate-table-timesheet-line/85 - key: '60' id: '60' href: /objects/construction/rate-table-timesheet-line/60 - key: '78' id: '78' href: /objects/construction/rate-table-timesheet-line/78 - key: '79' id: '79' href: /objects/construction/rate-table-timesheet-line/79 ia::meta: totalCount: 5 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/construction/rate-table-timesheet-line/{key}: parameters: - name: key description: System-assigned key for the rate table timesheet line. in: path required: true schema: type: string get: summary: Get a rate table timesheet line description: Returns detailed information for a particular rate table timesheet line. tags: - Construction_Rate table timesheet lines operationId: get-construction-rate-table-timesheet-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the rate-table-timesheet-line properties: ia::result: $ref: '#/components/schemas/construction-rate-table-timesheet-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of rate table timesheet line: value: ia::result: key: '12' id: '12' rateTable: key: '145' id: 2021-LV2 name: 2021 Level 2 href: /objects/construction/rate-table/145 href: /objects/construction/rate-table-timesheet-line/12 lineNumber: 1 description: Aug Costing Kit startDate: '2021-08-03' markupPercent: '8.250' laborRate: '115.500' accumulationType: key: '2' id: ACCT-2 href: /objects/construction/accumulation-type/2 standardCostType: key: '33' id: CT-RT-0010 name: CT-RT-0010 MATERIAL href: /objects/construction/standard-cost-type/33 standardTask: key: '3' id: TSK-RT-0011 name: TSK-RT-0011 Name href: /objects/construction/standard-task/3 employeePosition: key: '2' id: COO name: Chief Executive Officer href: /objects/construction/employee-position/2 laborClass: key: '2' id: LC-2 name: Labor class 2 href: /objects/construction/labor-class/2 laborShift: key: '2' id: LS-2 name: Day shift href: /objects/construction/labor-shift/2 laborUnion: key: '2' id: LU-2 name: Labor union 2 href: /objects/construction/labor-union/2 timeType: key: '1' id: Salaries At Root href: /objects/projects/time-type/1 dimensions: employee: key: '10' id: '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: '113' 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: key: '2' id: tet name: Design href: /objects/projects/task/2 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/contract: get: summary: List contracts description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each contract. 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
SubscriptionContract Core Billing
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsList Contracts
tags: - Contracts_and_Revenue_Management_Contracts operationId: list-contracts-contract responses: '200': description: OK content: application/json: schema: type: object title: List of contracts properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of contracts: value: ia::result: - key: '84' id: '84' href: /objects/contracts/contract/84 - key: '107' id: '107' href: /objects/contracts/contract/107 - key: '108' id: '108' href: /objects/contracts/contract/108 - key: '56' id: '56' href: /objects/contracts/contract/56 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a contract description: >+ Creates a new contract. `id` is required if document sequencing is not enabled for contracts- If document sequencing is enabled, you can provide an `id` value to use instead of the document sequence value.
Permissions and other requirements
SubscriptionContract Core Billing
User ypeBusiness
PermissionsAdd Contracts
tags: - Contracts_and_Revenue_Management_Contracts operationId: create-contracts-contract requestBody: required: true content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/contracts-contract' - $ref: '#/components/schemas/contracts-contractRequiredProperties' examples: Create a contract: value: id: ProjectTime_Completed_Flows34_45_4 startDate: '2023-01-01' endDate: '2023-12-31' name: ProjectTime_Completed_Flows dimensions: customer: key: '1' location: key: '1' department: key: '1' currency: baseCurrency: USD txnCurrency: USD exchangeRateType: Intacct Daily Rate paymentTerm: key: '1' responses: '201': description: Created content: application/json: schema: type: object title: Reference to new contract properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new contract: value: ia::result: key: '124' id: ProjectTime_Completed_Flows34_45_4 href: /objects/contracts/contract/124 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/contract/{key}: parameters: - name: key description: System-assigned key for the contract. in: path required: true schema: type: string get: summary: Get a contract description: >+ Returns detailed information for a specified contract.
Permissions and other requirements
SubscriptionContract Core Billing
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsView Contracts
tags: - Contracts_and_Revenue_Management_Contracts operationId: get-contracts-contract-key responses: '200': description: OK content: application/json: schema: type: object title: contracts-contract properties: ia::result: $ref: '#/components/schemas/contracts-contract' ia::meta: $ref: '#/components/schemas/metadata' examples: Contract detail: value: ia::result: key: '2' parent: key: null id: null description: contract with 2 lines all values id: ProjectTime_Completed_Flows34_45_4 state: inProgress isRenewable: false renewedContract: key: null id: null renewal: contractTermType: termed template: RC_24M_Price_SO termLength: 24 termPeriod: months billInAdvanceLength: null billInAdvancePeriod: '' triggerDate: null date: null startDate: '2016-01-01' endDate: '2016-12-31' cancellationDate: '2016-03-01' name: BaseSanity dimensions: customer: key: '2' id: '2' name: Logic Solutions href: /objects/accounts-receivable/customer/2 location: key: '2' id: '2' name: India href: /objects/company-config/location/2 department: key: '4' id: '4' name: Human Resources href: /objects/company-config/department/4 project: key: null id: null name: null vendor: key: '54' id: '208' name: Quick and Easy Payroll href: /objects/accounts-payable/vendor/54 employee: key: '55' id: EM 2 name: Ravi href: /objects/company-config/employee/55 class: key: '15' id: vsoe_class_004_R name: vsoe_class_name_004_R href: /objects/company-config/class/15 contacts: billTo: key: '117' id: Logic Solutions(C2) email1: qa-auto-emails@intacct.com email2: twoaddres@yahoo.com href: /objects/company-config/contact/117 shipTo: key: '117' id: Logic Solutions(C2) email1: qa-auto-emails@intacct.com email2: twoaddres@yahoo.com href: /objects/company-config/contact/117 billingFrequency: quarterly paymentTerm: key: '16' id: N90 href: /objects/accounts-receivable/term/16 billingPriceList: key: '24' id: SaaSy Pricing href: /objects/contracts/billing-price-list/24 meaPriceList: id: 2009 VSOE Price List USD_R key: '2' href: /objects/contracts/mea-price-list/2 holdBilling: false holdRevenue: false holdExpense: false currency: baseCurrency: INR txnCurrency: INR exchangeRateType: EUR-Rate billInAdvanceLength: null billInAdvancePeriod: null audit: createdDateTime: '2022-07-13T04:42:34Z' modifiedDateTime: '2022-07-13T04:42:34Z' createdBy: '1' modifiedBy: '1' attachment: id: null key: null status: active contractType: key: null name: null deferEstimatedTimeBasedRevenueBy: null postMemo: null contractTotalAmount: 1728 billedAmount: 0 href: /objects/contracts/contract/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a contract description: >+ Updates an existing contract by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionContract Core Billing
User ypeBusiness
PermissionsEdit Contract
tags: - Contracts_and_Revenue_Management_Contracts operationId: update-contracts-contract-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-contract' - type: object properties: id: readOnly: true examples: Update location and billTo contact: value: location: key: '6' contacts: billTo: key: '2' responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated contract properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated contract: value: ia::result: key: '121' id: CON-0045-1 href: /objects/contracts/contract/121 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a contract description: >+ Deletes a contract. You can delete a contract if there are no related records. For example, you can delete a contract if there are no contract lines, no expense lines, no signed-off compliance tasks, no notes, and so on. If there are related records, delete each record and then delete the contract. If you cannot delete a related record, cancel the contract instead.
Permissions and other requirements
SubscriptionContract Core Billing
User ypeBusiness
PermissionsDelete Contracts
tags: - Contracts_and_Revenue_Management_Contracts operationId: delete-contracts-contract-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/contract-line: get: summary: List contract lines description: >- Returns up to 100 object references from the collection with a key, ID, and link for each contract line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Contracts_and_Revenue_Management_Contract lines operationId: list-contracts-contract-line responses: '200': description: OK content: application/json: schema: type: object title: List of contract line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Example-1: value: ia::result: - key: '1' id: '1' href: /objects/contracts/contract-line/1 - key: '2' id: '2' href: /objects/contracts/contract-line/2 - key: '3' id: '3' href: /objects/contracts/contract-line/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a contract line description: Creates a new contract line. tags: - Contracts_and_Revenue_Management_Contract lines operationId: create-contracts-contract-line requestBody: description: Contract line to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-contract-line' - $ref: '#/components/schemas/contracts-contract-lineRequiredProperties' examples: Creates a contract line: value: contract: key: '1' item: key: '2' dimensions: location: key: '1' startDate: '2022-01-01' endDate: '2022-12-31' billing: quantity: '12' rate: '12' multiplier: '1' discount: '0' method: fixedPrice amountFrequency: includeWithEveryInvoice frequency: monthly flatFixedAmount: '144' baseFlatFixedAmount: '144' totalFlatFixedAmount: '1728' totalBaseFlatFixedAmount: '1728' changeType: newMRR lineType: sale revenue: journal1: revenueTemplate: key: '1' postingDate: '2022-01-01' responses: '201': description: Created content: application/json: schema: type: object title: Reference to new contract line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new contract line: value: ia::result: id: '26' key: '26' href: /objects/contracts/contract-line/26 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/contract-line/{key}: parameters: - name: key description: System-assigned key for the contract line. in: path required: true schema: type: string get: summary: Get a contract line description: Returns detailed information for a specified contract line. tags: - Contracts_and_Revenue_Management_Contract lines operationId: get-contracts-contract-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contract line properties: ia::result: $ref: '#/components/schemas/contracts-contract-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the contract line: value: ia::result: id: '1' key: '1' contract: key: '1' id: Usagerevrec_Case6 state: In progress name: CAR-IMPLEMENTATION href: /objects/contracts/contract/1 parent: id: null key: null item: key: null itemType: '' lineNumber: null currency: txnCurrency: USD baseCurrency: USD exchangeRateDate: null exchangeRate: '1.000000000000' state: inProgress lineNumber: '1' recurringBillingPeriod: 0 startDate: '2015-01-15' endDate: '2015-03-31' cancelationDate: null item: key: '306' id: LICNERP name: Licenses-ERP href: /objects/inventory-control/item/306 itemDescription: null deferralStatus: deferRevenueUntilItemIsDelivered billing: quantity: '1' rate: '599999.99' multiplier: '1' discount: '0' template: key: null id: null method: '' schedule: id: '1' key: '1' status: In progress startDate: '2015-01-15' endDate: '2015-03-31' method: fixedPrice amountFrequency: includeWithEveryInvoice frequency: monthly flatFixedAmount: '599999.99' baseFlatFixedAmount: '599999.99' totalFlatFixedAmount: '1799999.97' totalBaseFlatFixedAmount: '1799999.97' resetUsageQuantity: '' isUsageQuantityRecurring: null holdDate: null resumeDate: null memo: null durationInPeriods: '3' proratePartialPeriods: false quantityType: '' committedQuantityEndAction: '' committedQuantityExcess: '' contacts: billTo: key: '126' id: CAR(CCAR) href: /objects/company-config/contact/126 shipTo: key: '126' id: CAR(CCAR) href: /objects/company-config/contact/126 billToSource: contractValue shipToSource: contractValue renewal: renew: false billingTemplate: key: null id: null isRecurring: false lineType: sale revenue: journal1: revenueTemplate: key: '9' id: QUANTITYBASED_MANUAL method: Quantity based href: /objects/contracts/revenue-template/9 startDate: '2015-01-15' endDate: '2015-03-31' revenueSchedule: id: '3' key: '3' href: /objects/contracts/revenue-schedule/3 journalSymbol: key: '51' id: LEGACYREVREC href: /objects/general-ledger/journal/51 journal2: revenueTemplate: key: null id: null method: '' startDate: null endDate: null revenueSchedule: key: '3' href: /objects/contracts/revenue-schedule/3 journalSymbol: key: '53' id: ASC606REVREC href: /objects/general-ledger/journal/53 totalQuantity: '33333.33' holdDate: null resumeDate: null memo: null dimensions: location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 department: key: '3' id: '3' name: Engineering href: /objects/company-config/department/3 task: key: null name: null id: null project: key: null id: null name: null customer: id: CAR name: CAR vendor: key: null id: null name: null employee: key: null id: null name: null class: key: null id: null name: null audit: createdDateTime: '2023-06-05T17:45:45Z' modifiedDateTime: '2023-06-05T17:45:45Z' createdBy: '1' modifiedBy: '1' changeType: '' isMRR: false priceListDetails: null deliveryStatus: delivered deliveryDate: '2015-01-15' postingDate: '2015-01-15' expense: holdDate: null resumeDate: null memo: null memo: null renewalTriggerDate: null lineRenewalDate: null href: /objects/contracts/contract-line/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a contract line description: >- Updates an existing contract line by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_Contract lines operationId: update-contracts-contract-line-key requestBody: content: application/json: schema: $ref: '#/components/schemas/contracts-contract-line' examples: Update a contract line: value: item: key: '3' dimensions: location: key: '1' startDate: '2022-01-01' endDate: '2022-12-31' billing: quantity: '12' rate: '12' multiplier: '1' discount: '0' method: fixedPrice amountFrequency: includeWithEveryInvoice frequency: monthly flatFixedAmount: '144' baseFlatFixedAmount: '144' totalFlatFixedAmount: '1728' totalBaseFlatFixedAmount: '1728' changeType: newMRR lineType: sale revenue: journal1: revenueTemplate: key: '1' journal2: revenueTemplate: key: '2' postingDate: '2022-01-01' responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated contract line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated contract line: value: ia::result: id: '3' key: '3' href: /objects/contracts/contract-line/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a contract line description: Deletes a contract line. tags: - Contracts_and_Revenue_Management_Contract lines operationId: delete-contracts-contract-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/contract-type: get: summary: List contract types description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each contract type. 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
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsList Contract Types
tags: - Contracts_and_Revenue_Management_Contract types operationId: list-contracts-contract-type responses: '200': description: OK content: application/json: schema: type: object title: List of contract types properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List contract types: value: ia::result: - key: '2' id: Service_1 href: /objects/contracts/contract-type/2 - key: '1' id: API href: /objects/contracts/contract-type/1 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create contract type description: >+ Creates a new contract type.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsAdd Contract Types
tags: - Contracts_and_Revenue_Management_Contract types operationId: create-contracts-contract-type requestBody: required: true content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/contracts-contract-type' - $ref: '#/components/schemas/contracts-contract-typeRequiredProperties' examples: Create a contract type: value: id: Auto-renewal description: Parent type for automatic renewal contracts status: active Create a child contract type: value: id: Annual description: Annual automatic renewals status: active parent: key: '11' responses: '201': description: Created content: application/json: schema: type: object title: Reference to the new contract type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to the new contract type: value: ia::result: key: '11' id: Auto-renewal href: /objects/contracts/contract-type/11 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/contract-type/{key}: parameters: - name: key description: System-assigned key for the contract type. in: path required: true schema: type: string get: summary: Get a contract type description: >+ Returns detailed information for a specified contract type.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsView Contract Types
tags: - Contracts_and_Revenue_Management_Contract types operationId: get-contracts-contract-type-key responses: '200': description: OK content: application/json: schema: type: object title: contract type properties: ia::result: $ref: '#/components/schemas/contracts-contract-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a contract type: value: ia::result: key: '2' id: Annual status: active audit: createdBy: '1' modifiedBy: '1' createdDateTime: '2023-12-14T00:00:00Z' modifiedDateTime: '2023-12-14T00:00:00Z' href: /objects/contracts/contract-type/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a contract type description: >+ Updates an existing contract type by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsEdit Contract Types
tags: - Contracts_and_Revenue_Management_Contract types operationId: update-contracts-contract-type-key requestBody: content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/contracts-contract-type' - type: object properties: id: readOnly: true example: Set status to inactive: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated contract type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated contract type: value: ia::result: key: '3' id: Service_1 href: /objects/contracts/contract-type/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete contract type description: >+ Deletes a contract type. You cannot delete a contract type that is currently assigned to any contracts-
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsDelete Contract Types
tags: - Contracts_and_Revenue_Management_Contract types operationId: delete-contracts-contract-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/contract-usage: get: summary: List contract usage description: >- Returns up to 100 object references from the collection with a key, ID, and link for each contract usage. 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: - Contracts_and_Revenue_Management_Contract usage operationId: list-contracts-contract-usage responses: '200': description: OK content: application/json: schema: type: object title: List of contract usage objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of contract usage: value: ia::result: - key: '84' id: RT-00001 href: /objects/contracts/contract-usage/84 - key: '85' id: RT-00002 href: /objects/contracts/contract-usage/85 ia::meta: totalCount: 5 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create contract usage description: Create a new contract usage tags: - Contracts_and_Revenue_Management_Contract usage operationId: create-contracts-contract-usage requestBody: description: Contract usage to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-contract-usage' - $ref: '#/components/schemas/contracts-contract-usageRequiredProperties' examples: example-1: value: contractLine: key: '1' usageDate: '2024-01-16' quantity: '3003.99' usageType: revenue responses: '201': description: Created content: application/json: schema: type: object title: Reference to new contract properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new contract: value: ia::result: id: '6' key: '6' href: /objects/contracts/contract-usage/6 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/contract-usage/{key}: parameters: - name: key description: System-assigned key for the contract usage. in: path required: true schema: type: string get: summary: Get a contract usage description: Returns detailed information for a specified contract usage. tags: - Contracts_and_Revenue_Management_Contract usage operationId: get-contracts-contract-usage-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contract usage properties: ia::result: $ref: '#/components/schemas/contracts-contract-usage' ia::meta: $ref: '#/components/schemas/metadata' examples: Contract usage details: value: ia::result: id: '2' key: '2' contractLine: id: '7' key: '7' lineNumber: '1' href: /objects/contracts/contract-line/7 usageDate: '2017-05-01' quantity: '300' usageType: revenue documentId: null revenueScheduleLine: id: null key: null postingDate: null amount: null revenueSchedule: id: null key: null revenue2ScheduleLine: id: null key: null postingDate: null amount: null revenue2Schedule: id: null key: null audit: createdDateTime: '2024-01-18T15:51:32Z' modifiedDateTime: '2024-01-18T15:53:05Z' createdBy: '1' modifiedBy: '1' contractUsageBilling: billedDate: null recurringUsageDate: null contract: key: '3' id: QtyCancel501 name: 12 Months contract for CUS-RT-0602 href: /objects/contracts/contract/3 item: key: '306' id: LICNERP name: Licenses-ERP href: /objects/inventory-control/item/306 customer: key: '841' id: CUS-RT-0602 name: Customer-Root-0602 href: /objects/accounts-receivable/customer/84 href: /objects/contracts/contract-usage/2 ia::meta: totalCount: 1 totalSuccess: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a contract usage description: >- Updates an existing contract usage by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_Contract usage operationId: update-contracts-contract-usage-key requestBody: content: application/json: schema: $ref: '#/components/schemas/contracts-contract-usage' examples: Update quantity: value: quantity: '400' responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated contract usage properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated contract usage: value: ia::result: key: '12' id: 2021-LV2 href: /objects/contracts/contract-usage/12 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete contract usage description: Delete a contract usage tags: - Contracts_and_Revenue_Management_Contract usage operationId: delete-contracts-contract-usage-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-price-list: get: summary: List billing price lists description: >+ Returns up to 100 billing price lists from the collection with a key, ID, and link for each list. This operation is mostly for use in testing; use the query service to find billing price lists that meet specific criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsList Contract Price Lists
tags: - Contracts_and_Revenue_Management_Billing price lists operationId: list-contracts-billing-price-list responses: '200': description: OK content: application/json: schema: type: object title: List of billing price lists. properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List billing price lists: value: ia::result: - key: '24' id: SoftwarePackagePL href: /objects/contracts/billing-price-list/24 - key: '37' id: API href: /objects/contracts/billing-price-list/37 - key: '1' id: SoftwareFinance href: /objects/contracts/billing-price-list/1 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a billing price list description: >+ Creates a new billing price list.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness
PermissionsAdd Contract Price Lists
tags: - Contracts_and_Revenue_Management_Billing price lists operationId: create-contracts-billing-price-list requestBody: description: Billing price list to create required: true content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/contracts-billing-price-list' - $ref: '#/components/schemas/contracts-billing-price-listRequiredProperties' examples: Create a billing price list: value: id: SoftwarePackagePL description: Billing price list for software packages status: active responses: '201': description: Created content: application/json: schema: type: object title: New billing price list properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New billing price list created: value: ia::result: key: '40' id: SoftwarePackagePL_1 href: /objects/contracts/billing-price-list/40 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-price-list/{key}: parameters: - name: key description: System-assigned key for the billing price list. in: path required: true schema: type: string get: summary: Get a billing price list description: >+ Returns detailed information for a specified billing price list.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsView Contract Price Lists
tags: - Contracts_and_Revenue_Management_Billing price lists operationId: get-contracts-billing-price-list-key responses: '200': description: OK content: application/json: schema: type: object title: billing price list properties: ia::result: $ref: '#/components/schemas/contracts-billing-price-list' ia::meta: $ref: '#/components/schemas/metadata' examples: Billing price list details: value: ia::result: key: '1' id: SoftwarePackagePL status: active description: Software billing price list audit: createdDateTime: '2023-05-13T18:23:18Z' modifiedDateTime: '2023-05-13T18:23:18Z' createdBy: '14' modifiedBy: '129' href: /objects/contracts/billing-price-list/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a billing price list description: >+ Updates an existing billing price list by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness
PermissionsEdit Contract Price Lists
tags: - Contracts_and_Revenue_Management_Billing price lists operationId: update-contracts-billing-price-list-key requestBody: content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/contracts-billing-price-list' - type: object properties: id: readOnly: true examples: Change billing price list status: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Billing price list updated properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update successful: value: ia::result: key: '40' id: SoftwarePackagePL href: /objects/contracts/billing-price-list/40 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a billing price list description: >+ Deletes a billing price list. You can delete a billing price list if it has not been used by any contracts- Deleted price lists cannot be recovered. Alternatively, you can change the status to Inactive, which prevents it from being used but retains the price list for historical purposes.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness
PermissionsDelete Contract Price Lists
tags: - Contracts_and_Revenue_Management_Billing price lists operationId: delete-contracts-billing-price-list-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-price-list-entry: get: summary: List billing price list entries description: >- Returns up to 100 object references from the collection with a key, ID, and link for each entry. 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: - Contracts_and_Revenue_Management_Billing price list entries operationId: list-contracts-billing-price-list-entry responses: '200': description: OK content: application/json: schema: type: object title: List of billing-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 billing price list entry: value: ia::result: - key: '300' id: '300' href: /objects/contracts/billing-price-list-entry/300 - key: '296' id: '296' href: /objects/contracts/billing-price-list-entry/296 - key: '298' id: '298' href: /objects/contracts/billing-price-list-entry/298 - key: '299' id: '299' href: /objects/contracts/billing-price-list-entry/299 - key: '301' id: '301' href: /objects/contracts/billing-price-list-entry/301 ia::meta: totalCount: 5 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a billing price list entry description: Creates a new billing price list entry. tags: - Contracts_and_Revenue_Management_Billing price list entries operationId: create-contracts-billing-price-list-entry requestBody: description: Billing price list entry to create required: true content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/contracts-billing-price-list-entry' - $ref: '#/components/schemas/contracts-billing-price-list-entryRequiredProperties' examples: Creates a billing price list entry: value: status: active billingPriceList: key: '1' item: id: SUBPACKPROJ currency: txnCurrency: CAD priceType: tiered flatAmountFrequency: useBillingTemplate variableUnitDivisor: '1' roundingType: none usageQuantityResetPeriod: afterEachRenewal isQuantityRecurring: false tieredPricingType: volume lines: - startDate: '2015-01-01' flatAmount: '5900.00' variableUnitRate: '1' includedUnits: '1000' tiers: - beginQuantity: '0' tierRate: '49' - beginQuantity: '10001' tierRate: '129' - beginQuantity: '30000' tierRate: '150' - billingPriceListEntry: id: '286' startDate: '2015-06-01' flatAmount: '5900.00' variableUnitRate: '1' includedUnits: '1000' tiers: - beginQuantity: '0' tierRate: '59' - beginQuantity: '10001' tierRate: '139' - beginQuantity: '30000' tierRate: '159' responses: '201': description: Created content: application/json: schema: type: object title: New billing-price-list-entry properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New billing price list entry: value: ia::result: key: '525' id: '525' href: /objects/contracts/billing-price-list-entry/525 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-price-list-entry/{key}: parameters: - name: key description: System-assigned unique key for the billing price list entry. in: path required: true schema: type: string example: '425' get: summary: Get a billing price list entry description: Returns detailed information for a specified billing price list entry. tags: - Contracts_and_Revenue_Management_Billing price list entries operationId: get-contracts-billing-price-list-entry-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the billing-price-list-entry properties: ia::result: $ref: '#/components/schemas/contracts-billing-price-list-entry' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the billing price list entry: value: ia::result: id: '4' key: '4' audit: createdDateTime: '2016-05-13T18:23:18Z' modifiedDateTime: '2016-05-13T18:23:18Z' createdBy: '1' modifiedBy: '1' status: active item: key: '306' id: LICNERP name: Licenses-ERP href: /objects/inventory-control/item/306 billingPriceList: key: '1' id: SoftwarePackagePL href: /objects/contracts/billing-price-list/1 currency: txnCurrency: USD priceType: tiered flatAmountFrequency: includeWithEveryInvoice variableUnitDivisor: '1' roundingType: none usageQuantityResetPeriod: afterEachInvoice isQuantityRecurring: true tieredPricingType: step lines: - id: '4' key: '4' billingPriceListEntry: id: '4' key: '4' href: /objects/contracts/billing-price-list-entry/4 startDate: '2016-01-01' flatAmount: '0.00' variableUnitRate: '1' includedUnits: '9' memo: null audit: createdDateTime: '2016-05-13T18:23:18Z' modifiedDateTime: '2016-05-13T18:23:18Z' createdBy: '1' modifiedBy: '1' tiers: - id: '1' key: '1' beginQuantity: '0' tierRate: '850' - id: '2' key: '2' beginQuantity: '10' tierRate: '799' - id: '3' key: '3' beginQuantity: '100' tierRate: '699' href: /objects/contracts/billing-price-list-entry-line/4 - id: '5' key: '5' billingPriceListEntry: id: '4' key: '4' href: /objects/contracts/billing-price-list-entry/4 startDate: '2016-06-01' flatAmount: '0.00' variableUnitRate: '1' includedUnits: '9' memo: null audit: createdDateTime: '2016-05-13T18:23:18Z' modifiedDateTime: '2016-05-13T18:23:18Z' createdBy: '1' modifiedBy: '1' tiers: - id: '4' key: '4' beginQuantity: '0' tierRate: '899.99' - id: '5' key: '5' beginQuantity: '10' tierRate: '850.99' - id: '6' key: '6' beginQuantity: '100' tierRate: '699.99' href: /objects/contracts/billing-price-list-entry-line/5 href: /objects/contracts/billing-price-list-entry/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a billing price list entry description: >- Updates an existing billing price list entry by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_Billing price list entries operationId: update-contracts-billing-price-list-entry-key requestBody: content: application/json: schema: $ref: '#/components/schemas/contracts-billing-price-list-entry' examples: Updates a billing price list entry: value: status: active currency: txnCurrency: CAD type: tiered flatAmountFrequency: includeWithEveryInvoice variableUnitDivisor: '1' roundingType: standard quantityResetPeroid: afterEachInvoice isQuantityRecurring: true isTieredStep: step version: null lines: - key: '572' startDate: '2016-01-01' flatAmount: '0' variableUnitRate: '1' includedUnits: '9' memo: null tier: - key: '121' beginQuantity: '0' tierRate: '850' responses: '200': description: OK content: application/json: schema: type: object title: Updated billing-price-list-entry properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated billing price list entry: value: ia::result: key: '525' id: '525' href: /objects/contracts/billing-price-list-entry/525 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a/an billing price list entry description: Deletes a/an billing price list entry. tags: - Contracts_and_Revenue_Management_Billing price list entries operationId: delete-contracts-billing-price-list-entry-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-price-list-entry-line: get: summary: List billing price list entry lines description: >- Returns up to 100 object references from the collection with a key, ID, and link for each entry line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Contracts_and_Revenue_Management_Billing price list entry lines operationId: list-contracts-billing-price-list-entry-line responses: '200': description: OK content: application/json: schema: type: object title: List of billing-price-list-entry-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of billing price list entry lines: value: ia::result: - key: '304' id: '304' href: /objects/contracts/billing-price-list-entry-line/304 - key: '301' id: '301' href: /objects/contracts/billing-price-list-entry-line/301 - key: '302' id: '302' href: /objects/contracts/billing-price-list-entry-line/302 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-price-list-entry-line/{key}: parameters: - name: key description: System-assigned unique key for the billing price list entry line. in: path required: true schema: type: string example: '10295' get: summary: Get a billing price list entry line description: >- Returns detailed information for a specified billing price list entry line. tags: - Contracts_and_Revenue_Management_Billing price list entry lines operationId: get-contracts-billing-price-list-entry-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the billing-price-list-entry-line properties: ia::result: $ref: '#/components/schemas/contracts-billing-price-list-entry-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the billing price list entry line: value: ia::result: key: '572' id: '572' billingPriceListEntry: key: '525' id: '525' href: /objects/billing-price-list-entry/525 startDate: '2024-01-01' flatAmount: '0' variableUnitRate: '0' includedUnits: '9' memo: Annual price increase audit: createdDateTime: '2023-06-15T06:01:21Z' modifiedDateTime: '2023-06-15T06:01:21Z' createdBy: '1' modifiedBy: '1' tiers: - key: '121' id: '121' billingPriceListEntryLine: key: '572' id: '572' href: '/objects/contracts/billing-price-list-entry-line/572' beginQuantity: '0' tierRate: '850' audit: createdDateTime: '2023-06-15T06:01:21Z' modifiedDateTime: '2023-06-15T06:01:21Z' createdBy: '1' modifiedBy: '1' href: '/objects/contracts/billing-price-list-entry-line-tier/121' href: /objects/contracts/billing-price-list-entry-line/572 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a billing price list entry line description: >- Updates an existing billing price list entry line by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_Billing price list entry lines operationId: update-contracts-billing-price-list-entry-line-key requestBody: content: application/json: schema: $ref: '#/components/schemas/contracts-billing-price-list-entry-line' examples: Updates a billing price list entry line: value: startDate: '2024-01-01' flatAmount: '0' variableUnitRate: '1' includedUnits: '9' memo: null tiers: - key: '121' beginQuantity: '0' tierRate: '850' responses: '200': description: OK content: application/json: schema: type: object title: Updated billing-price-list-entry-line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated billing price list entry line: value: ia::result: key: '572' id: '572' href: /objects/contracts/billing-price-list-entry-line/572 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a billing price list entry line description: Deletes a billing price list entry line. tags: - Contracts_and_Revenue_Management_Billing price list entry lines operationId: delete-contracts-billing-price-list-entry-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-price-list-entry-line-tier: get: summary: List billing price list entry line tiers description: >- Returns up to 100 object references from the collection with a key, ID, and link for each entry line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Contracts_and_Revenue_Management_Billing price list entry line tiers operationId: list-contracts-billing-price-list-entry-line-tier responses: '200': description: OK content: application/json: schema: type: object title: List of billing-price-list-entry-line-tier objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of billing price list entry line tiers: value: ia::result: - key: '1' id: '1' href: '/objects/contracts/billing-price-list-entry-line-tier/1' - key: '2' id: '2' href: '/objects/contracts/billing-price-list-entry-line-tier/2' - key: '3' id: '3' href: '/objects/contracts/billing-price-list-entry-line-tier/3' - key: '4' id: '4' href: '/objects/contracts/billing-price-list-entry-line-tier/4' ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a billing price list entry line tier description: Creates a new billing price list entry line tier. tags: - Contracts_and_Revenue_Management_Billing price list entry line tiers operationId: create-contracts-billing-price-list-entry-line-tier requestBody: description: Billing price list entry tier to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-billing-price-list-entry-line-tier' - $ref: '#/components/schemas/contracts-billing-price-list-entry-line-tierRequiredProperties' examples: Creates a billing price list entry line tier: value: billingPriceListEntryLine: key: '4' beginQuantity: '0' tierRate: '860' responses: '201': description: Created content: application/json: schema: type: object title: New billing-price-list-entry-line-tier properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New billing price list entry line tier: value: beginQuantity: '100' tierRate: '850' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-price-list-entry-line-tier/{key}: parameters: - name: key description: System-assigned unique key for the billing price list entry line tier. in: path required: true schema: type: string example: '32195' get: summary: Get a billing price list entry line tier description: >- Returns detailed information for a specified billing price list entry line tier. tags: - Contracts_and_Revenue_Management_Billing price list entry line tiers operationId: get-contracts-billing-price-list-entry-line-tier-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the billing-price-list-entry-line-tier properties: ia::result: $ref: '#/components/schemas/contracts-billing-price-list-entry-line-tier' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the billing price list entry line tier: value: ia::result: key: '1' id: '1' billingPriceListEntryLine: key: '4' href: /objects/billing-price-list-entry-line/4 beginQuantity: '0' tierRate: '850' audit: createdDateTime: '2023-06-15T06:01:21Z' modifiedDateTime: '2023-06-15T06:01:21Z' createdBy: '1' modifiedBy: '1' href: /objects/contracts/billing-price-list-entry-line-tier/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a billing price list entry line tier description: >- Updates an existing billing price list entry line tier by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_Billing price list entry line tiers operationId: update-contracts-billing-price-list-entry-line-tier-key requestBody: content: application/json: schema: $ref: '#/components/schemas/contracts-billing-price-list-entry-line-tier' examples: Update a billing price list entry line tier: value: beginQuantity: '0' tierRate: '850' responses: '200': description: OK content: application/json: schema: type: object title: Updated billing-price-list-entry-line-tier properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated billing price list entry line tier: value: ia::result: key: '32069' id: '32069' href: /objects/contracts/billing-price-list-entry-line/32069 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a billing price list entry line tier description: Deletes a billing price list entry line tier. tags: - Contracts_and_Revenue_Management_Billing price list entry line tiers operationId: delete-contracts-billing-price-list-entry-line-tier-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-schedule: get: summary: List contract billing schedules description: >- Returns up to 100 object references from the collection with a key, ID, and link for each contract billing schedule. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Contracts_and_Revenue_Management_Billing schedules operationId: list-contracts-billing-schedule responses: '200': description: OK content: application/json: schema: type: object title: List of contract billing schedule objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of contract billing schedules: value: ia::result: - key: '84' id: RT-00001 href: /objects/contracts/billing-schedule/84 - key: '85' id: RT-00002 href: /objects/contracts/billing-schedule/85 - key: '60' id: RT-00003 href: /objects/contracts/billing-schedule/60 - key: '78' id: RT-00004 href: /objects/contracts/billing-schedule/78 - key: '79' id: RT-00005 href: /objects/contracts/billing-schedule/79 ia::meta: totalCount: 5 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-schedule/{key}: parameters: - name: key description: System-assigned key for the contract billing schedule. in: path required: true schema: type: string example: '1843' get: summary: Get a contract billing schedule description: Returns detailed information for a specified contract billing schedule. tags: - Contracts_and_Revenue_Management_Billing schedules operationId: get-contracts-billing-schedule-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contract billing schedule properties: ia::result: $ref: '#/components/schemas/contracts-billing-schedule' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a contract billing schedule description: >- Updates an existing contract billing schedule by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_Billing schedules operationId: update-contracts-billing-schedule-key requestBody: content: application/json: schema: $ref: '#/components/schemas/contracts-billing-schedule' examples: Add a billing schedule line: value: key: '145' lines: - scheduledBillingDate: '2022-05-25' scheduledAmount: '125.34' Update a billing schedule line: value: key: '145' lines: - key: '12' scheduledBillingDate: '2022-05-25' scheduledAmount: '125.34' Update a multiple billing schedule line: value: key: '145' lines: - key: '12' scheduledBillingDate: '2022-05-25' scheduledAmount: '125.34' - key: '13' scheduledBillingDate: '2022-06-25' scheduledAmount: '245.18' Delete a billing schedule line: value: key: '145' lines: - ia::operation: delete key: '12' responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated contract billing schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated contract billing schedule: value: ia::result: key: '12' id: 2021-LV2 href: /objects/contracts/billing-schedule/12 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-schedule-line: get: summary: List contract billing schedule lines description: >- Returns a collection with a key, ID, and link for each contract-billing-schedule-line. tags: - Contracts_and_Revenue_Management_Billing schedule lines operationId: list-contracts-billing-schedule-line responses: '200': description: OK content: application/json: schema: type: object title: List of contract billing schedule line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of contract billing schedules: value: ia::result: - key: '84' id: RT-00001 href: /objects/contracts/billing-schedule-line/84 - key: '85' id: RT-00002 href: /objects/contracts/billing-schedule-line/85 - key: '60' id: RT-00003 href: /objects/contracts/billing-schedule-line/60 - key: '78' id: RT-00004 href: /objects/contracts/billing-schedule-line/78 - key: '79' id: RT-00005 href: /objects/contracts/billing-schedule-line/79 ia::meta: totalCount: 5 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-schedule-line/{key}: parameters: - name: key description: System-assigned key for the contract billing schedule line. in: path required: true schema: type: string example: '349' get: summary: Get a contract billing schedule line description: >- Returns detailed information for a particular contract billing schedule line. tags: - Contracts_and_Revenue_Management_Billing schedule lines operationId: get-contracts-billing-schedule-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contract billing schedule line properties: ia::result: $ref: '#/components/schemas/contracts-billing-schedule-line' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-template: get: summary: List billing templates description: >- Returns a collection with a key, ID, and link for each billing template. This operation is mostly for use in testing. Use query to fnd objects that meet certain criteria and to specify properties that are returned. tags: - Contracts_and_Revenue_Management_Billing templates operationId: list-contracts-billing-template responses: '200': description: OK content: application/json: schema: type: object title: List of billing-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List billing templates: value: ia::result: - key: '7' id: BILLINGBEGPERCUST2 href: /objects/contracts/billing-template/7 - key: '19' id: 18M_Straitline_Beg href: /objects/contracts/billing-template/19 - key: '14' id: 4P_25PER_MBEGIN href: /objects/contracts/billing-template/14 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a billing template description: Creates a new billing template. tags: - Contracts_and_Revenue_Management_Billing templates operationId: create-contracts-billing-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-billing-template' - $ref: '#/components/schemas/contracts-billing-templateRequiredProperties' examples: Create a billing template: value: id: BILLINGBEGPERCUST3 description: Custom percent billing beginning of 3,6,9,12 periods status: active method: predefinedPercentages source: estimatedHours isStepBilling: false lines: - periodOffset: '3' percentBilled: '5' stepPercent: null - periodOffset: '6' percentBilled: '25' stepPercent: null - periodOffset: '9' percentBilled: '45' stepPercent: null - periodOffset: '12' percentBilled: '25' stepPercent: null responses: '201': description: Created content: application/json: schema: type: object title: New billing-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New billing template: value: ia::result: key: '22' id: BILLINGBEGPERCUST3 href: /objects/contracts/billing-template/22 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-template/{key}: parameters: - name: key description: System-assigned key for the billing template. in: path required: true schema: type: string get: summary: Get a billing template description: Returns detailed information for a specified billing template. tags: - Contracts_and_Revenue_Management_Billing templates operationId: get-contracts-billing-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the billing-template properties: ia::result: $ref: '#/components/schemas/contracts-billing-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a billing template: value: ia::result: key: '7' id: BILLINGBEGPERCUST2 description: Custom percent billing beginning of 3,6,9,12 periods status: active method: predefinedPercentages source: '' isStepBilling: false audit: modifiedDateTime: '2016-05-13T18:22:29Z' createdDateTime: '2016-05-13T18:22:29Z' createdBy: '1' modifiedBy: '1' lines: - id: '44' key: '44' contractBillingTemplate: key: '7' href: /objects/contracts/billing-template/7 periodOffset: '3' percentBilled: '5' stepPercent: null href: /objects/contracts/billing-template-entry/44 - id: '45' key: '45' contractBillingTemplate: key: '7' href: /objects/contracts/billing-template/7 periodOffset: '6' percentBilled: '25' stepPercent: null href: /objects/contracts/billing-template-line/45 - id: '46' key: '46' contractBillingTemplate: key: '7' href: /objects/contracts/billing-template/7 periodOffset: '9' percentBilled: '45' stepPercent: null href: /objects/contracts/billing-template-line/46 - id: '47' key: '47' contractBillingTemplate: key: '7' href: /objects/contracts/billing-template/7 periodOffset: '12' percentBilled: '25' stepPercent: null href: /objects/contracts/billing-template-line/47 href: /objects/contracts/billing-template/7 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a billing template description: >- Updates an existing billing template by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_Billing templates operationId: update-contracts-billing-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-billing-template' - type: object properties: id: readOnly: true examples: Update a billing template: value: description: Custom percent billing beginning of 3,6,9,12 periods status: active method: predefinedPercentages source: estimatedHours isStepBilling: false lines: - key: '135' periodOffset: '3' percentBilled: '5' stepPercent: null - key: '136' periodOffset: '6' percentBilled: '25' stepPercent: null - key: '137' periodOffset: '9' percentBilled: '45' stepPercent: null - key: '138' periodOffset: '12' percentBilled: '25' stepPercent: null responses: '200': description: OK content: application/json: schema: type: object title: Updated billing-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated billing template: value: ia::result: key: '22' id: BILLINGBEGPERCUST3 href: /objects/contracts/billing-template/22 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a billing template description: Deletes a billing template. tags: - Contracts_and_Revenue_Management_Billing templates operationId: delete-contracts-billing-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-template-line: get: summary: List billing template lines description: >- Returns a collection with a key, ID, and link for each billing template entry. tags: - Contracts_and_Revenue_Management_Billing template lines operationId: list-contracts-billing-template-line responses: '200': description: OK content: application/json: schema: type: object title: List of billing-template-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Example-1: value: ia::result: - key: '7' id: '7' href: /objects/contracts/billing-template-line/7 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/billing-template-line/{key}: parameters: - name: key description: System-assigned key for the billing template entry. in: path required: true schema: type: string example: '7' get: summary: Get a billing template entry description: Returns detailed information for a specified billing template entry. tags: - Contracts_and_Revenue_Management_Billing template lines operationId: get-contracts-billing-template-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the billing-template-line properties: ia::result: $ref: '#/components/schemas/contracts-billing-template-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Example-1: value: ia::result: key: '7' billingTemplate: key: '37' href: /objects/contracts/billing-template/37 periodOffset: '1' stepPercent: '1.00000000' periodPercent: '50.00000000' href: /objects/contracts/billing-template-line/7 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/expense: get: summary: List contract expenses description: >- Returns up to 100 object references from the collection with a key, ID, and link for each contract expense. 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: - Contracts_and_Revenue_Management_Contract expenses operationId: list-contracts-expense responses: '200': description: OK content: application/json: schema: type: object title: List of contract-expense objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List contract expenses: value: ia::result: - key: '84' id: '84' href: /objects/contracts/expense/84 - key: '87' id: '87' href: /objects/contracts/expense/87 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a contract expense description: Creates a new contract expense. tags: - Contracts_and_Revenue_Management_Contract expenses operationId: create-contracts-expense requestBody: description: Contract expense to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-expense' - $ref: '#/components/schemas/contracts-expenseRequiredProperties' examples: Create a contract expense: value: contract: key: '1' item: key: '1' dimensions: location: key: '1' templates: expenseJournal1: expenseTemplate: key: '1' startDate: '2015-01-15' endDate: '2015-03-31' txnAmount: '8.25' baseAmount: '8.25' postingDate: '2015-01-15' responses: '201': description: Created content: application/json: schema: type: object title: Reference to new contract expense properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new contract expense: value: ia::result: - key: '2' id: '2' href: /objects/contracts/expense/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/expense/{key}: parameters: - name: key description: System-assigned key for the contract expense. in: path required: true schema: type: string example: '17' get: summary: Get a contract expense description: Returns detailed information for a specified contract expense. tags: - Contracts_and_Revenue_Management_Contract expenses operationId: get-contracts-expense-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contract-expense properties: ia::result: $ref: '#/components/schemas/contracts-expense' ia::meta: $ref: '#/components/schemas/metadata' examples: Contract expense details: value: ia::result: id: '2' key: '2' contract: key: '1' id: Usagerevrec_Case6 href: /objects/contracts/contract/1 contractLine: id: null key: null state: null item: key: '322' id: CONT-SUPPEXP name: Functional Consultation support Charges href: /objects/inventory-control/item/322 dimensions: location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 department: key: null id: null name: null project: key: null id: null name: null customer: id: CAR name: CAR vendor: key: null id: null name: null employee: key: null id: null name: null class: key: null id: null name: null templates: expenseJournal1: expenseTemplate: key: '1' id: EXPSTRAIGHTLINE_MAN defaultPostingType: M href: /objects/contracts/expense-template/1 startDate: '2015-01-15' endDate: '2015-03-31' schedule: key: '15' status: In progress href: /objects/contracts/expense-schedule/15 glJournal: key: '52' href: /objects/general-ledger/journal/52 postingType: null postingConversionDate: null expenseJournal2: expenseTemplate: key: null id: null defaultPostingType: null startDate: null endDate: null schedule: key: null status: null glJournal: key: '54' href: /objects/general-ledger/journal/54 postingType: null postingConversionDate: null txnAmount: '8.25' baseAmount: '8.25' currency: txnCurrency: USD baseCurrency: USD exchangeRateDate: null exchangeRate: '1.000000000000' postingDate: '2015-01-15' cancelationDate: null deferredExpenseGLAccount: key: '427' href: /objects/general-ledger/account/427 recognizedExpenseGLAccount: key: '433' href: /objects/general-ledger/account/433 expenseAccrualGLAccount: key: '439' href: /objects/general-ledger/account/439 state: inProgress expenseType: contract audit: createdDateTime: '2023-06-26T10:17:19Z' modifiedDateTime: '2023-06-26T10:19:18Z' createdBy: '1' modifiedBy: '1' calculatedExpensePostingType: M memo: null lineNumber: '2' href: /objects/contracts/expense/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a/an contract expense description: >- Updates an existing contract expense by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_Contract expenses operationId: update-contracts-expense-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-expense' - type: object properties: id: readOnly: true examples: Update a contract expense: value: templates: expenseJournal1: expenseTemplate: key: '1' startDate: '2015-01-15' endDate: '2015-03-31' txnAmount: '8.25' baseAmount: '8.25' postingDate: '2015-01-15' responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated contract expense properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated contract expense: value: ia::result: key: '2' id: '2' href: /objects/contracts/expense/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a contract expense description: Deletes a contract expense. tags: - Contracts_and_Revenue_Management_Contract expenses operationId: delete-contracts-expense-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/expense-template: get: summary: List Contract expense templates description: >- Returns up to 100 object references from the collection with a key, ID, and link for each contract expense template. 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: - Contracts_and_Revenue_Management_Contract expense templates operationId: list-contracts-expense-template responses: '200': description: OK content: application/json: schema: type: object title: List of contract expense template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List contract expense templates: value: ia::result: - key: '2' id: EXPSTRAIGHTLINE_AUTO href: /objects/contracts/expense-template/2 ia::meta: totalCount: 1 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a contract expense template description: Creates a new contract expense template. tags: - Contracts_and_Revenue_Management_Contract expense templates operationId: create-contracts-expense-template requestBody: description: Contract expense template to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-expense-template' - $ref: '#/components/schemas/contracts-expense-templateRequiredProperties' examples: Create an expense template: value: id: EXPSTRAIGHTLINE_MAN1 description: Cont Expenses straighline Amortization Monthly Manual defaultPostingType: manual amortizationSchedulePeriod: monthly postingDay: 2 amortizationMethod: straightLine responses: '201': description: Created content: application/json: schema: type: object title: Reference to new contract expense template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new contract expense template: value: ia::result: key: '26' id: EXPSTRAIGHTLINE_MAN1 href: /objects/contracts/expense-template/26 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/expense-template/{key}: parameters: - name: key description: System-assigned key for the contract expense template. in: path required: true schema: type: string example: '1' get: summary: Get a contract expense template description: Returns detailed information for a specified contract expense template. tags: - Contracts_and_Revenue_Management_Contract expense templates operationId: get-contracts-expense-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contract expense template properties: ia::result: $ref: '#/components/schemas/contracts-expense-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Contract expense template details: value: ia::result: key: '1' id: EXPSTRAIGHTLINE_MAN description: Cont Expenses straighline Amortization Monthly Manual defaultPostingType: manual amortizationSchedulePeriod: monthly postingDay: 1 amortizationMethod: straightLine status: active audit: modifiedDateTime: '2016-05-13T18:22:57Z' createdDateTime: '2016-05-13T18:22:57Z' createdBy: '1' modifiedBy: '1' lines: [] href: /objects/contracts/expense-template/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a contract expense template description: >- Updates an existing contract expense template by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_Contract expense templates operationId: update-contracts-expense-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-expense-template' - type: object properties: id: readOnly: true examples: Update a contract expense template: value: description: Cont Expenses straighline Amortization Monthly Manual defaultPostingType: manual amortizationSchedulePeriod: monthly postingDay: 3 amortizationMethod: straightLine responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated contract expense template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated contract expense template: value: ia::result: key: '27' id: EXPSTRAIGHTLINE_1 href: /objects/contracts/expense-template/27 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a contract expense template description: Deletes a contract expense template. tags: - Contracts_and_Revenue_Management_Contract expense templates operationId: delete-contracts-expense-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/expense-template-line: get: summary: List contract expense template lines description: >- Returns up to 100 object references from the collection with a key, ID, and link for each contract expense template line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Contracts_and_Revenue_Management_Contract expense template lines operationId: list-contracts-expense-template-line responses: '200': description: OK content: application/json: schema: type: object title: List of contract expense template line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List contract expense template lnies: value: ia::result: - key: '7' id: '7' href: /objects/contracts/expense-template-line/7 ia::meta: totalCount: 1 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/expense-template-line/{key}: parameters: - name: key description: System-assigned key for the contract expense template line. in: path required: true schema: type: string example: '7' get: summary: Get a contract expense template line description: >- Returns detailed information for a specified contract expense template line. tags: - Contracts_and_Revenue_Management_Contract expense template lines operationId: get-contracts-expense-template-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contract expense template line properties: ia::result: $ref: '#/components/schemas/contracts-expense-template-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Contract expense template line details: value: ia::result: key: '7' contractExpenseTemplate: key: '37' href: /objects/contracts/expense-template/37 periodOffset: '1' percentToRecognize: '50.00000000' href: /objects/contracts/expense-template-line/7 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/expense-schedule: get: summary: List contract expense schedules description: >- Returns up to 100 object references from the collection with a key, ID, and link for each contract expense schedule. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Contracts_and_Revenue_Management_Contract expense schedules operationId: list-contracts-expense-schedule responses: '200': description: OK content: application/json: schema: type: object title: List of contract expense schedule objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of contract expense schedules: value: ia::result: - key: '84' id: RT-00001 href: /objects/contracts/expense-schedule/84 - key: '85' id: RT-00002 href: /objects/contracts/expense-schedule/85 - key: '60' id: RT-00003 href: /objects/contracts/expense-schedule/60 - key: '78' id: RT-00004 href: /objects/contracts/expense-schedule/78 - key: '79' id: RT-00005 href: /objects/contracts/expense-schedule/79 ia::meta: totalCount: 5 start: 1 pageSize: 100 next: null previous: null '400': description: Bad Request content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/error-response' ia::meta: $ref: '#/components/schemas/metadata' examples: List of contract expense schedule errors: value: ia::result: ia::error: code: invalidRequest message: >- Object named [contract-expense-schedule] is not supported in version [0] supportId: '-hOIM%7EYagYsDEpVbp0kVn1KUJ45gAAAAQ' ia::meta: totalCount: 1 totalSuccess: 0 totalError: 1 security: - OAuth2: [] /objects/contracts/expense-schedule/{key}: parameters: - name: key description: System-assigned key for the contract expense schedule. in: path required: true schema: type: string example: '762' get: summary: Get a contract expense schedule description: Returns detailed information for a specified contract expense schedule. tags: - Contracts_and_Revenue_Management_Contract expense schedules operationId: get-contracts-expense-schedule-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contract expense schedule properties: ia::result: $ref: '#/components/schemas/contracts-expense-schedule' ia::meta: $ref: '#/components/schemas/metadata' '400': description: Bad Request content: application/json: schema: type: object properties: key: type: string href: type: string ia::result: $ref: '#/components/schemas/error-response' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a contract expense schedule error: value: key: '12' href: /objects/contracts/expense-schedule/12 ia::result: ia::error: code: invalidRequest message: Field [id] is a read-only field supportId: YCbdS%7EYagQGDEvVbn0UIY1o-JKOAAAAAo ia::meta: totalCount: 1 totalSuccess: 0 totalError: 1 security: - OAuth2: [] patch: summary: Update a contract expense schedule description: >- Updates an existing contract expense schedule by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_Contract expense schedules operationId: update-contracts-expense-schedule-key requestBody: content: application/json: schema: $ref: '#/components/schemas/contracts-expense-schedule' examples: Add an expense schedule line: value: key: '145' expenseScheduleLines: - scheduledExpenseDate: '2022-05-25' scheduledAmount: '125.34' Update an expense schedule line: value: key: '145' expenseScheduleLines: - key: '12' scheduledExpenseDate: '2022-05-25' scheduledAmount: '125.34' Update multiple expense schedule lines: value: key: '145' expenseScheduleLines: - key: '12' scheduledExpenseDate: '2022-05-25' scheduledAmount: '125.34' - key: '13' scheduledExpenseDate: '2022-06-25' scheduledAmount: '245.18' Delete an expense schedule line: value: key: '145' expenseScheduleLines: - ia::operation: delete key: '12' responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated contract expense schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated contract expense schedule: value: ia::result: key: '12' id: 2021-LV2 href: /objects/contracts/expense-schedule/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': description: Bad Request content: application/json: schema: type: object properties: key: type: string href: type: string ia::result: $ref: '#/components/schemas/error-response' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a contract expense schedule error: value: key: '145' href: /objects/contracts/expense-schedule/145 ia::result: ia::error: code: notFound message: >- The requested resource [contract-expense-schedule] with key(s) [145] could not be found but may be available in the future supportId: PhOIM%7EYagW2DEpVbp0kVn1KUJ43wAAAAQ ia::meta: totalCount: 1 totalSuccess: 0 totalError: 1 security: - OAuth2: [] /objects/contracts/expense-schedule-line: get: summary: List contract expense schedule lines description: >- Returns a collection with a key, ID, and link for each contract-expense-schedule-line. tags: - Contracts_and_Revenue_Management_Contract expense schedule lines operationId: list-contracts-expense-schedule-line responses: '200': description: OK content: application/json: schema: type: object title: List of contract expense schedule line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of contract expense schedules: value: ia::result: - key: '84' id: RT-00001 href: /objects/contracts/expense-schedule-line/84 - key: '85' id: RT-00002 href: /objects/contracts/expense-schedule-line/85 - key: '60' id: RT-00003 href: /objects/contracts/expense-schedule-line/60 - key: '78' id: RT-00004 href: /objects/contracts/expense-schedule-line/78 - key: '79' id: RT-00005 href: /objects/contracts/expense-schedule-line/79 ia::meta: totalCount: 5 start: 1 pageSize: 100 '400': description: Bad Request content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/error-response' ia::meta: $ref: '#/components/schemas/metadata' examples: List of contract expense schedule line errors: value: ia::result: ia::error: code: invalidRequest message: >- Object named [contract-expense-schedule-line] is not supported in version [0] supportId: '-hOIM%7EYagYsDEpVbp0kVn1KUJ45gAAAAQ' ia::meta: totalCount: 1 totalSuccess: 0 totalError: 1 security: - OAuth2: [] /objects/contracts/expense-schedule-line/{key}: parameters: - name: key description: System-assigned key for the contract expense schedule line. in: path required: true schema: type: string example: '8241' get: summary: Get a contract expense schedule line description: >- Returns detailed information for a particular contract expense schedule line. tags: - Contracts_and_Revenue_Management_Contract expense schedule lines operationId: get-contracts-expense-schedule-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contract expense schedule line properties: ia::result: $ref: '#/components/schemas/contracts-expense-schedule-line' ia::meta: $ref: '#/components/schemas/metadata' '400': description: Bad Request content: application/json: schema: type: object properties: key: type: string href: type: string ia::result: $ref: '#/components/schemas/error-response' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a contract expense schedule line error: value: key: '12' href: /objects/contracts/expense-schedule-line/12 ia::result: ia::error: code: invalidRequest message: Field [id] is a read-only field supportId: YCbdS%7EYagQGDEvVbn0UIY1o-JKOAAAAAo ia::meta: totalCount: 1 totalSuccess: 0 totalError: 1 security: - OAuth2: [] /objects/contracts/mea-price-list: get: summary: List MEA price lists description: >+ Returns up to 100 MEA price lists from the collection with a key, ID, and link for each list. This operation is mostly for use in testing; use the query service to find MEA price lists that meet specific criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsList Contract MEA Price Lists
tags: - Contracts_and_Revenue_Management_MEA price lists operationId: list-contracts-mea-price-list responses: '200': description: OK content: application/json: schema: type: object title: List of MEA price lists properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of MEA price lists: value: ia::result: - key: '30' id: CONMEA_FVPriceBand_Amount_USD href: /objects/contracts/mea-price-list/30 - key: '31' id: CONMEA_FVPriceBand_Amount_EUR href: /objects/contracts/mea-price-list/31 - key: '32' id: CONMEA_FVPriceBand_Amount_GBP href: /objects/contracts/mea-price-list/32 - key: '33' id: CONMEA_FVPriceBand_Amount_INR href: /objects/contracts/mea-price-list/33 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an MEA price list description: >+ Creates a new MEA price list.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness
PermissionsAdd Contract MEA Price Lists
tags: - Contracts_and_Revenue_Management_MEA price lists operationId: create-contracts-mea-price-list requestBody: description: MEA price list to create required: true content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/contracts-mea-price-list' - $ref: '#/components/schemas/contracts-mea-price-listRequiredProperties' examples: Create an MEA price list: value: status: active id: CONMEA_FVPriceBand_Amount_USD_1 description: MEA NearestBoundary PriceBand Amount responses: '201': description: Created content: application/json: schema: type: object title: New mea price list properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New MEA price list created: value: ia::result: key: '39' id: CONMEA_FVPriceBand_Amount_USD_2 href: /objects/contracts/mea-price-list/39 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/mea-price-list/{key}: parameters: - name: key description: System-assigned key for the MEA price list. in: path required: true schema: type: string example: '61' get: summary: Get an MEA price list description: >+ Returns detailed information for a specified MEA price list.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsView Contract MEA Price Lists
tags: - Contracts_and_Revenue_Management_MEA price lists operationId: get-contracts-mea-price-list-key responses: '200': description: OK content: application/json: schema: type: object title: MEA price list properties: ia::result: $ref: '#/components/schemas/contracts-mea-price-list' ia::meta: $ref: '#/components/schemas/metadata' examples: MEA price list detail: value: ia::result: key: '37' audit: createdDateTime: '2023-06-08T06:06:15Z' modifiedDateTime: '2023-06-08T06:06:15Z' createdBy: '1' modifiedBy: '1' status: active id: CONMEA_FVPriceBand_Amount_USD_2 description: MEA NearestBoundary PriceBand Amount isDefault: false href: /objects/contracts/mea-price-list/37 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an MEA price list description: >+ Update an existing MEA price list by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness
PermissionsEdit Contract MEA Price Lists
tags: - Contracts_and_Revenue_Management_MEA price lists operationId: update-contracts-mea-price-list-key requestBody: content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/contracts-mea-price-list' - type: object properties: id: readOnly: true examples: Set MEA price list to active status: value: status: active responses: '200': description: OK content: application/json: schema: type: object title: MEA price list updated properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update successful: value: ia::result: key: '38' id: CONMEA_FVPriceBand_Amount_USD href: /objects/contracts/mea-price-list/38 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an MEA price list description: >+ Deletes an MEA price list. You can delete an MEA price list if it has not been used by any contracts- Deleted price lists cannot be recovered. Alternatively, you can change the status to Inactive, which prevents it from being used but retains the price list for historical purposes.
Permissions and other requirements
SubscriptionContract Core Billing or Contract Usage Billing
User ypeBusiness
PermissionsDelete Contract MEA Price Lists
tags: - Contracts_and_Revenue_Management_MEA price lists operationId: delete-contracts-mea-price-list-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/mea-price-list-entry: get: summary: List MEA price list entries description: > Returns up to 100 MEA price lists from the collection with a key, ID, and link for each list entry. This operation is mostly for use in testing; use the query service to find MEA price list entries that meet specific criteria and to specify the properties that you want in the response. tags: - Contracts_and_Revenue_Management_MEA price list entries operationId: list-contracts-mea-price-list-entry responses: '200': description: OK content: application/json: schema: type: object title: List of mea-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 MEA price list entries: value: ia::result: - key: '516' id: '516' href: /objects/contracts/mea-price-list-entry/516 - key: '514' id: '514' href: /objects/contracts/mea-price-list-entry/514 - key: '515' id: '515' href: /objects/contracts/mea-price-list-entry/515 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an MEA price list entry description: Creates a new MEA price list entry. tags: - Contracts_and_Revenue_Management_MEA price list entries operationId: create-contracts-mea-price-list-entry requestBody: description: MEA price list entry to be created. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-mea-price-list-entry' - $ref: '#/components/schemas/contracts-mea-price-list-entryRequiredProperties' examples: Create a MEA price list entry: value: status: active meaPriceList: key: '7' item: key: '211' currency: txnCurrency: CAD priceType: amount usePriceRange: false priceRangeVarianceType: null priceRuleOutsideRange: null lines: - startDate: '2024-01-01' amountOrPercent: '100.00' markUp: '0' markDown: '0' upperLimit: '0' lowerLimit: '0' memo: ERP Implementation_Memo responses: '201': description: Created content: application/json: schema: type: object title: New mea-price-list-entry properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New MEA price list entry: value: ia::result: id: '532' key: '532' href: /objects/contracts/mea-price-list-entry/532 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/mea-price-list-entry/{key}: parameters: - name: key description: System-assigned unique key for the MEA price list entry. in: path required: true schema: type: string get: summary: Get an MEA price list entry description: Returns detailed information for a specified MEA price list entry. tags: - Contracts_and_Revenue_Management_MEA price list entries operationId: get-contracts-mea-price-list-entry-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the mea-price-list-entry properties: ia::result: $ref: '#/components/schemas/contracts-mea-price-list-entry' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the MEA price list entry: value: ia::result: id: '521' key: '521' audit: createdDateTime: '2023-09-20T15:24:19Z' modifiedDateTime: '2023-09-20T15:24:19Z' createdBy: '1' modifiedBy: '1' status: active meaPriceList: key: '7' id: 2009 VSOE Price List CAD_R href: /objects/contracts/mea-price-list/7 item: id: ERP Software License_R name: ERP Software License_R key: '211' href: /objects/inventory-control/item/211 currency: txnCurrency: CAD priceType: percent fairValueCategory: key: '3' id: Software-License-ERP href: /objects/contracts/mea-category/3 calculatePercentageBasedOn: extendedFairValuePrice usePriceRange: false priceRangeVarianceType: null priceRuleOutsideRange: null lines: - id: '575' key: '575' meaPriceListEntry: id: '521' key: '521' href: /objects/contracts/mea-price-list-entry/521 startDate: '2006-01-01' amountOrPercent: '100.00' markUp: '0' markDown: '0' upperLimit: '0' lowerLimit: '0' memo: ERP Implementation_Memo audit: createdDateTime: '2023-09-20T15:24:19Z' modifiedDateTime: '2023-09-20T15:24:19Z' createdBy: '1' modifiedBy: '1' href: /objects/contracts/mea-price-list-entry-line/575 - id: '576' key: '576' meaPriceListEntry: id: '521' key: '521' href: /objects/contracts/mea-price-list-entry/521 startDate: '2007-01-01' amountOrPercent: '100.00' markUp: '0' markDown: '0' upperLimit: '0' lowerLimit: '0' memo: ERP Training_Memo audit: createdDateTime: '2023-09-20T15:24:19Z' modifiedDateTime: '2023-09-20T15:24:19Z' createdBy: '1' modifiedBy: '1' href: /objects/contracts/mea-price-list-entry-line/576 - id: '577' key: '577' meaPriceListEntry: id: '521' key: '521' href: /objects/contracts/mea-price-list-entry/521 startDate: '2008-01-01' amountOrPercent: '100.00' markUp: '0' markDown: '0' upperLimit: '0' lowerLimit: '0' memo: ERP Training_Memo audit: createdDateTime: '2023-09-20T15:24:19Z' modifiedDateTime: '2023-09-20T15:24:19Z' createdBy: '1' modifiedBy: '1' href: /objects/contracts/mea-price-list-entry-line/577 - id: '578' key: '578' meaPriceListEntry: id: '521' key: '521' href: /objects/contracts/mea-price-list-entry/521 startDate: '2009-01-01' amountOrPercent: '100.00' markUp: '0' markDown: '0' upperLimit: '0' lowerLimit: '0' memo: ERP Software License_Memo audit: createdDateTime: '2023-09-20T15:24:19Z' modifiedDateTime: '2023-09-20T15:24:19Z' createdBy: '1' modifiedBy: '1' href: /objects/contracts/mea-price-list-entry-line/578 href: /objects/contracts/mea-price-list-entry/521 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a MEA price list entry description: >- Updates an existing MEA price list entry by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_MEA price list entries operationId: update-contracts-mea-price-list-entry-key requestBody: content: application/json: schema: $ref: '#/components/schemas/contracts-mea-price-list-entry' examples: Updates a MEA price list entry: value: status: active priceType: amount usePriceRange: false priceRangeVarianceType: null priceRuleOutsideRange: null responses: '200': description: OK content: application/json: schema: type: object title: Updated mea-price-list-entry properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated MEA price list entry: value: ia::result: id: '532' key: '532' href: /objects/contracts/mea-price-list-entry/532 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an MEA price list entry description: Deletes an MEA price list entry. tags: - Contracts_and_Revenue_Management_MEA price list entries operationId: delete-contracts-mea-price-list-entry-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/mea-price-list-entry-line: get: summary: List MEA price list entry lines description: > Returns up to 100 MEA price list entry lines from the collection with a key, ID, and link for each line. This operation is mostly for use in testing; use the query service to find MEA price list entry lines that meet specific criteria and to specify the properties that you want in the response. tags: - Contracts_and_Revenue_Management_MEA price list entry lines operationId: list-contracts-mea-price-list-entry-line responses: '200': description: OK content: application/json: schema: type: object title: List of mea-price-list-entry-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of MEA price list entry lines: value: ia::result: - key: '574' id: '574' href: /objects/contracts/mea-price-list-entry-line/574 - key: '513' id: '513' href: /objects/contracts/mea-price-list-entry-line/513 - key: '514' id: '514' href: /objects/contracts/mea-price-list-entry-line/514 - key: '515' id: '515' href: /objects/contracts/mea-price-list-entry-line/515 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/mea-price-list-entry-line/{key}: parameters: - name: key description: System-assigned unique key for the MEA price list entry line. in: path required: true schema: type: string get: summary: Get an MEA price list entry line description: Returns detailed information for a particular MEA price list entry line. tags: - Contracts_and_Revenue_Management_MEA price list entry lines operationId: get-contracts-mea-price-list-entry-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the mea-price-list-entry-line properties: ia::result: $ref: '#/components/schemas/contracts-mea-price-list-entry-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the MEA price list entry line: value: ia::result: id: '574' key: '574' meaPriceListEntry: id: '516' key: '516' href: /objects/contracts/mea-price-list-entry/516 startDate: '2022-08-01' amountOrPercent: '10.00' markUp: '0' markDown: '0' upperLimit: '0' lowerLimit: '0' memo: null audit: createdDateTime: '2022-09-02T10:25:15Z' modifiedDateTime: '2022-09-02T10:25:15Z' createdBy: '1' modifiedBy: '1' href: /objects/contracts/mea-price-list-entry-line/574 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an MEA price list entry line description: >- Updates an existing MEA price list entry line by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_MEA price list entry lines operationId: update-contracts-mea-price-list-entry-line-key requestBody: content: application/json: schema: $ref: '#/components/schemas/contracts-mea-price-list-entry-line' examples: Updates an MEA price list entry line: value: startDate: '2022-08-02' amountOrPercent: '10.00' markUp: '0' markDown: '0' upperLimit: '0' lowerLimit: '0' memo: null responses: '200': description: OK content: application/json: schema: type: object title: Updated mea-price-list-entry-line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated MEA price list entry line: value: ia::result: id: '574' key: '574' href: /objects/contracts/mea-price-list-entry-line/574 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an MEA price list entry line description: Deletes an MEA price list entry line. tags: - Contracts_and_Revenue_Management_MEA price list entry lines operationId: delete-contracts-mea-price-list-entry-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/mea-category: get: summary: List MEA fair value categories description: >- Returns up to 100 object references from the collection with a key, ID, and link for each contract expense. 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: - Contracts_and_Revenue_Management_MEA categories operationId: list-contracts-mea-category responses: '200': description: OK content: application/json: schema: type: object title: List of mea-category objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of MEA categories: value: ia::result: - key: '3' id: Software-License-ERP href: /objects/contracts/mea-category/3 - key: '9' id: Functional consultation support href: /objects/contracts/mea-category/9 - key: '2' id: Software-Implementation href: /objects/contracts/mea-category/2 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a/an MEA category description: Creates a new MEA category. tags: - Contracts_and_Revenue_Management_MEA categories operationId: create-contracts-mea-category requestBody: description: MEA category to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-mea-category' - $ref: '#/components/schemas/contracts-mea-categoryRequiredProperties' examples: Create an MEA category: value: id: Software-License-ERP-1 description: Fair value category for software licenses --ERP status: active responses: '201': description: Created content: application/json: schema: type: object title: Reference to new MEA category properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new MEA category: value: ia::result: key: '13' id: Software-License-ERP-2 href: /objects/contracts/mea-category/13 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/mea-category/{key}: parameters: - name: key description: System-assigned unique key for the MEA category. in: path required: true schema: type: string get: summary: Get an MEA category description: Returns detailed information for a specified MEA category. tags: - Contracts_and_Revenue_Management_MEA categories operationId: get-contracts-mea-category-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the mea-category properties: ia::result: $ref: '#/components/schemas/contracts-mea-category' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the MEA category: value: ia::result: key: '3' id: Software-License-ERP description: Fair value category for software licenses --ERP status: active audit: createdDateTime: '2023-02-15T06:16:32Z' modifiedDateTime: '2023-02-15T06:16:32Z' createdBy: '1' modifiedBy: '1' href: /objects/contracts/mea-category/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a/an MEA category description: >- Updates an existing MEA category by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_MEA categories operationId: update-contracts-mea-category-key requestBody: content: application/json: schema: $ref: '#/components/schemas/contracts-mea-category' examples: Update an MEA category: value: status: active responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated MEA category properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated MEA category: value: ia::result: key: '11' id: Software-License-ERP-1 href: /objects/contracts/mea-category/11 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an MEA category description: Deletes an MEA category. tags: - Contracts_and_Revenue_Management_MEA categories operationId: delete-contracts-mea-category-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/revenue-template: get: summary: List contract revenue templates description: >- Returns up to 100 object references from the collection with a key, ID, and link for each revenue template. 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: - Contracts_and_Revenue_Management_Revenue templates operationId: list-contracts-revenue-template responses: '200': description: OK content: application/json: schema: type: object title: List of contract-revenue-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of contract revenue templates: value: ia::result: - key: '26' id: Evergreen Revenue href: /objects/contracts/revenue-template/26 - key: '18' id: Conprjobserved%compA href: /objects/contracts/revenue-template/18 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a contract revenue template description: Creates a new contract revenue template. tags: - Contracts_and_Revenue_Management_Revenue templates operationId: create-contracts-revenue-template requestBody: description: Revenue template to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-revenue-template' - $ref: '#/components/schemas/contracts-revenue-templateRequiredProperties' examples: Create a contract revenue template: value: id: PREDEFINED QUARTERLY description: QUARTERLY RECOGNITION schedulePeriod: monthly recognitionMethod: predefinedPercentages recognitionSource: estimatedHours stepRevenue: false revenueAdjustmentOption: null defaultPostingType: manual status: active recognitionPercentages: - monthsOffset: 0 thresholdPercent: '60' percentToRecognize: '20' - monthsOffset: 3 thresholdPercent: '40' percentToRecognize: '40' - monthsOffset: 5 thresholdPercent: '25' percentToRecognize: '25' - monthsOffset: 7 thresholdPercent: '15' percentToRecognize: '15' responses: '201': description: Created content: application/json: schema: type: object title: Reference to new contract revenue template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new contract revenue template: value: ia::result: key: '34' id: PREDEFINED QUARTERLY href: /objects/contracts/revenue-template/34 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/revenue-template/{key}: parameters: - name: key description: System-assigned key for the contract revenue template. in: path required: true schema: type: string get: summary: Get a contract revenue template description: Returns detailed information for a specified contract revenue template. tags: - Contracts_and_Revenue_Management_Revenue templates operationId: get-contracts-revenue-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contract revenue template properties: ia::result: $ref: '#/components/schemas/contracts-revenue-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the contract revenue template: value: ia::result: key: '25' id: PREDEFINED QUARTERLY description: QUARTERLY RECOGNITION schedulePeriod: monthly recognitionMethod: predefinedPercentages recognitionSource: estimatedHours stepRevenue: false revenueAdjustmentOption: null defaultPostingType: manual status: active audit: modifiedDateTime: '2023-09-26T07:35:01Z' createdDateTime: '2019-04-26T06:00:38Z' createdBy: '1' modifiedBy: '1' recognitionPercentages: - monthsOffset: null thresholdPercent: '50.00' percentToRecognize: '70.00' - monthsOffset: null thresholdPercent: '100.00' percentToRecognize: '30.00' href: /objects/contracts/revenue-template/25 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a contract revenue template description: >- Updates a existing contract revenue template by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_Revenue templates operationId: update-contracts-revenue-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/contracts-revenue-template' - type: object properties: id: readOnly: true examples: Update a contract revenue template: value: description: QUARTERLY RECOGNITION schedulePeriod: monthly recognitionMethod: predefinedPercentages recognitionSource: estimatedHours stepRevenue: false revenueAdjustmentOption: null defaultPostingType: manual status: active recognitionPercentages: - monthsOffset: null thresholdPercent: '50.00' percentToRecognize: '70.00' - monthsOffset: null thresholdPercent: '100.00' percentToRecognize: '30.00' responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated contract revenue template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated contract revenue template: value: ia::result: key: '25' id: PREDEFINED QUARTERLY href: /objects/contracts/revenue-template/25 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a contract revenue template description: Deletes a contract revenue template. tags: - Contracts_and_Revenue_Management_Revenue templates operationId: delete-contracts-revenue-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/revenue-schedule: get: summary: List contract revenue schedules description: >- Returns a collection with a key, ID, and link for each contract-revenue-schedule. tags: - Contracts_and_Revenue_Management_Revenue schedules operationId: list-contracts-revenue-schedule responses: '200': description: OK content: application/json: schema: type: object title: List of contract revenue schedule objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of contract revenue schedules: value: ia::result: - key: '84' id: '84' href: /objects/contracts/revenue-schedule/84 - key: '85' id: '85' href: /objects/contracts/revenue-schedule/85 - key: '60' id: '60' href: /objects/contracts/revenue-schedule/60 - key: '78' id: '78' href: /objects/contracts/revenue-schedule/78 - key: '79' id: '79' href: /objects/contracts/revenue-schedule/79 ia::meta: totalCount: 5 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/revenue-schedule/{key}: parameters: - name: key description: System-assigned key for the contract revenue schedule. in: path required: true schema: type: string example: '1287' get: summary: Get a contract revenue schedule description: Returns detailed information for a particular contract revenue schedule. tags: - Contracts_and_Revenue_Management_Revenue schedules operationId: get-contracts-revenue-schedule-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contract revenue schedule properties: ia::result: $ref: '#/components/schemas/contracts-revenue-schedule' ia::meta: $ref: '#/components/schemas/metadata' examples: Contract revenue schedule: value: ia::result: key: '1578' id: '1578' journal: J1 contract: key: '143' id: Committed_Quantity_Billing href: /objects/contracts/contract/143 contractLine: id: '387' key: '387' href: /objects/contracts/contract-line/387 status: inProgress cancellationDate: null audit: createdDateTime: '2024-02-01T06:14:00Z' modifiedDateTime: '2024-02-01T06:14:01Z' createdBy: '1' modifiedBy: '1' estimateRevaluationDate: null revenueScheduleLines: - key: '14423' id: '14423' contractRevenueSchedule: id: '1578' key: '1578' href: /objects/contracts/revenue-schedule/1578 scheduledOperationKey: null scheduledAmount: '16666.66' scheduledBaseAmount: '16666.66' scheduledExchangeRate: '1.000000000000' scheduledPostingDate: '2024-01-31' actualPostingDate: null derivedPostingDate: '2024-01-31' posted: false isHistorical: false status: open journalEntry: key: null id: null computationMemo: null meaDetails: null adjustedFor: '' approvedHours: null sourceHours: null percentageRecognized: null audit: createdDateTime: '2024-02-01T06:14:00Z' modifiedDateTime: '2024-03-28T04:14:44Z' createdBy: '1' modifiedBy: null linkedBillingScheduleLine: id: null key: null href: /objects/contracts/revenue-schedule-line/14423 - key: '14424' id: '14424' contractRevenueSchedule: id: '1578' key: '1578' href: /objects/contracts/revenue-schedule/1578 scheduledOperationKey: null scheduledAmount: '16666.66' scheduledBaseAmount: '16666.66' scheduledExchangeRate: '1.000000000000' scheduledPostingDate: '2024-02-29' actualPostingDate: null derivedPostingDate: '2024-02-29' posted: false isHistorical: false status: open journalEntry: key: null id: null computationMemo: null meaDetails: null adjustedFor: '' approvedHours: null sourceHours: null percentageRecognized: null audit: createdDateTime: '2024-02-01T06:14:00Z' modifiedDateTime: '2024-03-28T04:14:44Z' createdBy: '1' modifiedBy: null linkedBillingScheduleLine: id: null key: null href: /objects/contracts/revenue-schedule-line/14424 href: /objects/contract-revenue-schedule/1578 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a contract revenue schedule description: >- Updates an existing contract revenue schedule by setting field values. Any fields not provided remain unchanged. tags: - Contracts_and_Revenue_Management_Revenue schedules operationId: update-contracts-revenue-schedule-key requestBody: content: application/json: schema: $ref: '#/components/schemas/contracts-revenue-schedule' examples: Update a revenue schedule line: value: key: '145' revenueScheduleLines: - key: '12' computationMemo: Memo scheduledAmount: '125.34' responses: '200': description: OK content: application/json: schema: type: object title: Updated contract revenue schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a contract revenue schedule: value: ia::result: key: '145' id: '145' href: /objects/contracts/revenue-schedule/145 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/revenue-schedule-line: get: summary: List contract revenue schedules description: >- Returns up to 100 object references from the collection with a key, ID, and link for each contract expense. 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: - Contracts_and_Revenue_Management_Revenue schedule lines operationId: list-contracts-revenue-schedule-line responses: '200': description: OK content: application/json: schema: type: object title: List of contract revenue schedule line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of contract revenue schedules: value: ia::result: - key: '84' id: '84' href: /objects/contracts/revenue-schedule-line/84 - key: '85' id: '85' href: /objects/contracts/revenue-schedule-line/85 - key: '60' id: '60' href: /objects/contracts/revenue-schedule-line/60 - key: '78' id: '78' href: /objects/contracts/revenue-schedule-line/78 - key: '79' id: '79' href: /objects/contracts/revenue-schedule-line/79 ia::meta: totalCount: 5 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/contracts/revenue-schedule-line/{key}: parameters: - name: key description: System-assigned key for the contract revenue schedule line. in: path required: true schema: type: string example: '897' get: summary: Get a contract revenue schedule line description: >- Returns detailed information for a specified contract revenue schedule line. tags: - Contracts_and_Revenue_Management_Revenue schedule lines operationId: get-contracts-revenue-schedule-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contract revenue schedule line properties: ia::result: $ref: '#/components/schemas/contracts-revenue-schedule-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Contract revenue schedule line: value: ia::result: key: '14424' id: '14424' contractRevenueSchedule: id: '1578' key: '1578' href: /objects/contracts/revenue-schedule/1578 scheduledOperationKey: null scheduledAmount: '16666.66' scheduledBaseAmount: '16666.66' scheduledExchangeRate: '1.000000000000' scheduledPostingDate: '2024-02-29' actualPostingDate: null derivedPostingDate: '2024-02-29' posted: false isHistorical: false status: open journalEntry: key: null id: null computationMemo: null meaDetails: null adjustedFor: '' approvedHours: null sourceHours: null percentageRecognized: null audit: createdDateTime: '2024-02-01T06:14:00Z' modifiedDateTime: '2024-03-28T04:14:44Z' createdBy: '1' modifiedBy: null linkedBillingScheduleLine: id: null key: null href: /objects/contracts/revenue-schedule-line/14424 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /services/core/composite: post: summary: Send a composite request description: Sends multiple requests within a single POST request. tags: - Core_Intacct_REST_API_Services_Composite requests operationId: post-services-composite requestBody: description: Array of subrequests required: true content: application/json: schema: $ref: '#/components/schemas/core-composite' examples: Multiple independent requests to change employee location: value: - method: PATCH path: /objects/company-config/employee/26 body: location: key: '6' - method: PATCH path: /objects/company-config/employee/33 body: location: key: '6' - method: PATCH path: /objects/company-config/employee/62 body: location: key: '6' Multiple requests using data from previous: value: - method: GET path: /objects/company-config/employee/52 resultReference: employee - method: POST path: /services/core/query body: object: employee fields: - id - jobTitle - department.key - employeeType.name filters: - $eq: department.key: '@{employee.department.key}' - $eq: employeeType.name: '@{employee.employeeType.name}' filterExpression: 1 and 2 orderBy: - id: asc Multi-status example: value: - method: GET path: >- /services/core/async/job-status?jobId=NjQ2NTc2MzAzMVl1Ul9qVmd6M2t4M2pPdEJya2J5Y2dBQUFBQTE - method: GET path: /objects/company-config/contact/2662 responses: '200': description: OK content: application/json: schema: type: object properties: ia::status: type: string description: HTTP status code ia::result: type: array description: Composite response items: type: object properties: ia::result: type: object anyOf: - type: object description: >- Response of GET on a single object or query results - $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' ia::meta: $ref: '#/components/schemas/metadata' examples: Multiple independent requests to change employee location: value: ia::result: - ia::result: key: '26' id: '0014' href: /objects/company-config/employee/26 ia::meta: totalCount: 1 ia::status: 200 ia::headers: X-IA-API-ORM-Action: update - ia::result: key: '33' id: '1' href: /objects/company-config/employee/33 ia::meta: totalCount: 1 ia::status: 200 ia::headers: X-IA-API-ORM-Action: update - ia::result: key: '62' id: '2' href: /objects/company-config/employee/62 ia::meta: totalCount: 1 ia::status: 200 ia::headers: X-IA-API-ORM-Action: update ia::meta: totalCount: 3 Multiple Requests using data from previous: value: ia::result: - ia::result: key: '52' id: Emp2 SSN: '100000001' jobTitle: Sr Software Eng location: id: '10' key: '15' name: Indianapolis href: /objects/company-config/location/15 department: id: '10' key: '10' name: QA - II href: /objects/company-config/department/10 manager: key: '11' id: '10' href: /objects/company-config/employee/11 birthDate: '1984-04-14' startDate: '2021-05-01' endDate: '2025-04-02' status: active employeeType: id: Part Time name: Part Time key: '2' href: /objects/company-config/employee-type/2 gender: female terminationType: involuntary primaryContact: id: abc(C02) name: abc(C02) key: '205' href: /objects/company-config/contact/205 defaultCurrency: MXN earningType: key: '2' id: earningType2 name: earningType2 href: /objects/company-config/earning-type/2 class: id: SW-Office name: Office Software key: '9' href: /objects/company-config/class/9 href: /objects/company-config/employee/52 ia::meta: totalCount: 1 ia::status: 200 - ia::result: - id: Emp2 jobTitle: Sr Software Eng department.key: '10' employeeType.name: Part Time - id: Emp10 jobTitle: QA Engineer department.key: '10' employeeType.name: Part Time - id: Emp22 jobTitle: Architect department.key: '10' employeeType.name: Full Time ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null ia::status: 200 ia::meta: totalCount: 2 '207': description: Multi-Status content: application/json: schema: type: object properties: ia::status: type: string description: HTTP status code ia::result: type: array description: Composite response items: type: object anyOf: - title: success-response description: Success response properties: ia::result: type: object anyOf: - type: object description: >- Response of GET on a single object or query results - $ref: '#/components/schemas/object-reference' - $ref: '#/components/schemas/error-response' ia::meta: $ref: '#/components/schemas/metadata' - $ref: '#/components/schemas/error-response' ia::meta: $ref: '#/components/schemas/metadata' examples: Multi-status example: value: ia::result: - ia::error: code: notFound message: >- Asynchronous job 6465763031YSPy9lgWtJCMGZ6UkUbA6QAAAAY1 status could not be found supportId: tqKR0%7EYsTZeDEdVao0_h01dZFQqgAAAAY ia::status: 404 - ia::error: code: unprocessed message: Operation skipped due to atomic transaction failure ia::status: 422 ia::meta: totalCount: 2 totalSuccess: 0 totalError: 2 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /services/core/model: get: summary: Get an object model definition description: List all the fields and relationships for an object. operationId: get-services-model tags: - Core_Intacct_REST_API_Services_Models parameters: - $ref: '#/components/parameters/name' responses: '200': description: OK content: application/json: schema: type: object title: Definition of the object model properties: ia::result: $ref: '#/components/schemas/object-model' ia::meta: $ref: '#/components/schemas/metadata' examples: Model for department: value: ia::result: fields: id: mutable: false nullable: false type: string readOnly: false writeOnly: false required: false key: readOnly: true type: string writeOnly: false required: false nullable: true mutable: false name: nullable: false type: string readOnly: false writeOnly: false required: false mutable: true reportTitle: nullable: true type: string readOnly: false writeOnly: false required: false mutable: true status: enum: - active - activeNonPosting - inactive type: string readOnly: false writeOnly: false required: false nullable: false mutable: true groups: audit: fields: createdBy: readOnly: true type: string writeOnly: false required: false nullable: true mutable: false createdDateTime: format: date-time readOnly: true type: string writeOnly: false required: false nullable: true mutable: false modifiedBy: readOnly: true type: string writeOnly: false required: false nullable: true mutable: false modifiedDateTime: format: date-time readOnly: true type: string writeOnly: false required: false nullable: true mutable: false httpMethods: OPTIONS,GET,POST,DELETE,PATCH refs: parent: apiObject: company-config/department fields: id: type: string readOnly: false writeOnly: false required: false nullable: true mutable: true key: nullable: true type: string readOnly: false writeOnly: false required: false mutable: true name: readOnly: true type: string writeOnly: false required: false nullable: true mutable: false supervisor: apiObject: company-config/employee fields: id: type: string readOnly: false writeOnly: false required: false nullable: true mutable: true key: nullable: true type: string readOnly: false writeOnly: false required: false mutable: true name: readOnly: true type: string writeOnly: false required: false nullable: true mutable: false lists: [] idempotenceSupported: true ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /services/core/query: post: summary: Query an object description: Queries an object for filtered data. operationId: post-services-query tags: - Core_Intacct_REST_API_Services_Query requestBody: content: application/json: schema: $ref: '#/components/schemas/core-query' examples: Query vendor: value: object: accounts-payable/vendor fields: - id - name - status - href filters: - $eq: status: active - $eq: billingType: openItem filterExpression: 1 and 2 orderBy: - id: asc responses: '200': description: OK content: application/json: schema: type: object title: Query results properties: ia::result: type: array description: Fields requested in query items: type: object description: List of fields and their values additionalProperties: oneOf: - type: string nullable: true - type: integer nullable: true - type: number nullable: true - type: object ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Response - Query vendor: value: ia::result: - id: Vend-00002 name: Test vendor status: active href: /objects/accounts-payable/vendor/85 - id: VEND-00010 name: Design Works status: active href: /objects/accounts-payable/vendor/111 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/account: get: summary: List accounts description: >+ Returns up to 100 accounts from the collection with a key, ID, and link for each account. This operation is mostly for use in testing; use the query service to find accounts that meet certain criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Project Manager, and Warehouse
PermissionsList, View Accounts
tags: - General_Ledger_Accounts operationId: list-general-ledger-account responses: '200': description: OK content: application/json: schema: type: object title: List of account objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of gl-accounts: value: ia::result: - key: '406' id: '9999' href: /objects/general-ledger/account/406 - key: '407' id: '1501.06' href: /objects/general-ledger/account/407 - key: '16' id: '1007' href: /objects/general-ledger/account/16 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an account description: >+ Creates a new general ledger account.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsAdd Accounts
tags: - General_Ledger_Accounts operationId: create-general-ledger-account requestBody: description: Account to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-account' - $ref: '#/components/schemas/general-ledger-accountRequiredProperties' examples: Create an account: value: id: '1501' name: Vehicle Spare parts - Transmission accountType: balanceSheet closingType: nonClosingAccount normalBalance: debit alternativeGLAccount: none status: active requireDimensions: department: false location: false isTaxable: false disallowDirectPosting: true responses: '201': description: Created content: application/json: schema: type: object title: New account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Account created: value: ia::result: key: '356' id: '1501' href: /objects/general-ledger/account/356 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/account/{key}: parameters: - name: key description: System-assigned key for the account. in: path schema: type: string required: true example: '411' get: summary: Get an account description: >+ Returns detailed information for a specified account.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Project Manager, and Warehouse
PermissionsList, View Accounts
operationId: get-general-ledger-account-key tags: - General_Ledger_Accounts responses: '200': description: OK content: application/json: schema: type: object title: Details of the account properties: ia::result: $ref: '#/components/schemas/general-ledger-account' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an account: value: ia::result: key: '356' id: '1501' name: Vehicle Spare parts - Transmission accountType: balanceSheet normalBalance: debit closingType: nonClosingAccount closeToGLAccount: id: null key: null status: active requireDimensions: department: false location: false project: false customer: false vendor: false employee: false item: false class: false contract: false warehouse: false isTaxable: false category: null taxCode: null mrcCode: null alternativeGLAccount: none audit: createdDateTime: '2022-10-15T00:05:46Z' modifiedDateTime: '2022-10-15T00:05:46Z' createdBy: '68' modifiedBy: '68' disallowDirectPosting: true href: /objects/general-ledger/account/356 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an account description: >+ Updates an existing account by setting field values. Any fields not provided remain unchanged. An account `id` (account number) can only be changed if the General Ledger is configured to allow changes to account numbers and by users who have permission to change financial account numbers. Changing account numbers affects important aspects of Sage Intacct such as reports, data imports, historical information, and automation.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsEdit Accounts
tags: - General_Ledger_Accounts operationId: update-general-ledger-account-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-account' examples: Enable direct posting: value: disallowDirectPosting: false responses: '200': description: OK content: application/json: schema: type: object title: Account updated properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Simple PATCH response: value: ia::result: key: '356' id: '1501' href: /objects/general-ledger/account/356 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an account description: >+ Deletes an account. You cannot delete an account if the account is used in a book transaction. Deleted accounts cannot be recovered.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsDelete Accounts
tags: - General_Ledger_Accounts operationId: delete-general-ledger-account-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/statistical-account: get: summary: List statistical accounts description: >+ Returns up to 100 statistical GL accounts from the collection with a key, ID, and link for each account. This operation is mostly for use in testing; use the query service to find statistical GL accounts that meet certain criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Project Manager, and Warehouse
PermissionsList, View Statistical Accounts
tags: - General_Ledger_Statistical accounts operationId: list-statistical-account responses: '200': description: OK content: application/json: schema: type: object title: Statistical accounts list properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of statistical GL accounts: value: ia::result: - key: '397' id: '9001' href: /objects/general-ledger/statistical-account/397 - key: '398' id: '9002' href: /objects/general-ledger/statistical-account/398 - key: '399' id: '9003' href: /objects/general-ledger/statistical-account/399 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a statistical account description: >+ Creates a new statistical account. You should assign a completely different account range to statistical accounts so that they are not inadvertently grouped with general ledger accounts. Statistical accounts can be consolidated similarly to general ledger accounts, if you have a consolidated structure of companies with subsidiaries. Individual statistical accounts are typically rolled up into account groups for use in reports.
Permissions and other requirements
SubscriptionCompany, General Ledger
User ypeBusiness user with admin privileges
PermissionsAdd Statistical Accounts
tags: - General_Ledger_Statistical accounts operationId: create-statistical-account requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-statistical-account' - $ref: '#/components/schemas/general-ledger-statistical-accountRequiredProperties' examples: Create a statistical account: value: id: '9030' name: Customer Account reportType: forPeriod status: active requireDimensions: department: true location: true isTaxable: false category: Customers responses: '201': description: Created content: application/json: schema: type: object title: New statistical account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Created Statistical Account: value: ia::result: key: '439' id: '9030' href: /objects/general-ledger/statistical-account/439 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/statistical-account/{key}: parameters: - name: key description: System-assigned key for the statistical account. in: path required: true schema: type: string example: '439' get: summary: Get a statistical account description: >+ Returns detailed information for a specified statistical account.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness, Employee, Project Manager, and Warehouse
PermissionsList, View Statistical Accounts
tags: - General_Ledger_Statistical accounts operationId: get-statistical-account-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the statistical account properties: ia::result: $ref: '#/components/schemas/general-ledger-statistical-account' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of Statistical Account: value: ia::result: key: '397' id: '9001' name: Customer Account reportType: forPeriod status: active audit: modifiedDateTime: '2023-10-21T04:55:32Z' createdDateTime: '2023-09-20T11:29:30Z' createdBy: '1' modifiedBy: '1' requireDimensions: department: false location: false project: false customer: false vendor: false employee: false item: false class: false isTaxable: true category: Customers href: /objects/general-ledger/statistical-account/397 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a statistical account description: >+ Updates an existing statistical account by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsEdit Statistical Accounts
tags: - General_Ledger_Statistical accounts operationId: update-statistical-account-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-statistical-account' examples: Change name and taxable status: value: name: Customer Accounts isTaxable: true responses: '200': description: OK content: application/json: schema: type: object title: Updated statistical account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated Statistical Account: value: ia::result: key: '397' id: '9001' href: /objects/general-ledger/statistical-account/397 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a statistical account description: >+ Deletes a statistical account. You can delete an account from the Accounts list unless the account is used in a book transaction. Deleted accounts cannot be recovered.
Permissions and other requirements
SubscriptionCompany, General Ledger
User ypeBusiness, Employee
PermissionsDelete Statistical Accounts
tags: - General_Ledger_Statistical accounts operationId: delete-statistical-account-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/account-group: get: summary: List account groups description: >- Returns up to 100 account groups from the collection with a key, ID, and link for each group. This operation is mostly for use in testing; use the query service to find account groups that meet specific criteria and to specify the properties that you want in the response. tags: - General_Ledger_Account groups operationId: list-general-ledger-account-group responses: '200': description: OK content: application/json: schema: type: object title: List of account group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of account groups: value: ia::result: - key: '1' id: Accts_Payable href: /objects/general-ledger/account-group/1 - key: '2' id: Accts_Receivable href: /objects/general-ledger/account-group/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an account group description: Creates a new account group. tags: - General_Ledger_Account groups operationId: create-general-ledger-account-group requestBody: description: Account group to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-account-group' - $ref: '#/components/schemas/general-ledger-account-groupRequiredProperties' examples: Creates a GL account group: {} responses: '201': description: Created content: application/json: schema: type: object title: New gl-account-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New GL account group: value: ia::result: key: '41' id: Budget1 href: /objects/general-ledger/account-group/41 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/account-group/{key}: parameters: - name: key description: System-assigned key for the account group. in: path required: true schema: type: string get: summary: Get an account group description: Returns detailed information for a specified account group. tags: - General_Ledger_Account groups operationId: get-general-ledger-account-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the account group properties: ia::result: $ref: '#/components/schemas/general-ledger-account-group' ia::meta: $ref: '#/components/schemas/metadata' examples: GL account group details: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an account group description: >- Updates an existing account group by setting field values. Any fields not provided remain unchanged. tags: - General_Ledger_Account groups operationId: update-general-ledger-account-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-account-group' - type: object properties: id: readOnly: true examples: Update a GL account group: {} responses: '200': description: OK content: application/json: schema: type: object title: Updated gl-account-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: GL account group updated: value: ia::result: key: '21' id: Accts_Payable href: /objects/general-ledger/account-group/21 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an account group description: Deletes an account group. tags: - General_Ledger_Account groups operationId: delete-general-ledger-account-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/account-group-purpose: get: summary: List account group purposes description: >+ Returns up to 100 account group purposes from the collection with a key, ID, and link for each purpose. This operation is mostly for use in testing; use the query service to find account group purposes that meet specific criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionGeneral Ledger
Regional availabilityAll supported regions
User ypeBusiness, Employee, Approver
PermissionsList Account Groups
tags: - General_Ledger_Account group purposes operationId: list-general-ledger-account-group-purpose responses: '200': description: OK content: application/json: schema: type: object title: List of account group purposes properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of account groups purposes: value: ia::result: - key: '1' id: Budgeted Expenses href: /objects/general-ledger/account-group-purposes/19 - key: '2' id: Capital Expenses href: /objects/general-ledger/account-group-purposes/21 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an account group purpose description: >+ Creates a new account group purpose.
Permissions and other requirements
SubscriptionGeneral Ledger
Regional availabilityAll supported regions
User ypeBusiness
PermissionsAdd Account Groups
tags: - General_Ledger_Account group purposes operationId: create-general-ledger-account-group-purpose requestBody: description: Account group purpose to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-account-group-purpose' - $ref: '#/components/schemas/general-ledger-account-group-purposeRequiredProperties' examples: Create an account group purpose: value: id: Budget1 status: active responses: '201': description: Created content: application/json: schema: type: object title: New account group purpose properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new account group purpose: value: ia::result: key: '35' id: Budget1 href: /objects/general-ledger/account-group-purpose/35 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/account-group-purpose/{key}: parameters: - name: key description: System-assigned key of the account group purpose. in: path required: true schema: type: string example: '3906' get: summary: Get an account group purpose description: >+ Returns detailed information for a specified GL account group purpose.
Permissions and other requirements
SubscriptionGeneral Ledger
Regional availabilityAll supported regions
User ypeBusiness, Employee, Approver
PermissionsView Account Groups
tags: - General_Ledger_Account group purposes operationId: get-general-ledger-account-group-purpose-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the account group purpose properties: ia::result: $ref: '#/components/schemas/general-ledger-account-group-purpose' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the account group purpose: value: ia::result: id: P&L - New status: active key: '32' audit: createdDateTime: '2021-02-22T16:30:48Z' modifiedDateTime: '2021-02-22T16:30:48Z' createdBy: '1' modifiedBy: '1' href: /objects/general-ledger/account-group-purpose/32 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a GL account group purpose description: >+ Updates an existing account group purpose by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionGeneral Ledger
Regional availabilityAll supported regions
User ypeBusiness
PermissionsEdit Account Groups
tags: - General_Ledger_Account group purposes operationId: update-general-ledger-account-group-purpose-key requestBody: content: application/json: schema: $ref: '#/components/schemas/general-ledger-account-group-purpose' examples: Update an account group purpose: value: id: Budgeted Expenses responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated account group purpose properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated account group purpose: value: ia::result: key: '35' id: Budgeted Expenses href: /objects/general-ledger/account-group-purpose/35 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an account group purpose description: >+ Deletes an account group purpose.
Permissions and other requirements
SubscriptionGeneral Ledger
Regional availabilityAll supported regions
User ypeBusiness
PermissionsDelete Account Groups
tags: - General_Ledger_Account group purposes operationId: delete-general-ledger-account-group-purpose-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/journal: get: summary: List journals description: >+ Returns up to 100 journals from the collection with a key, ID, and link for each journal. This operation is mostly for use in testing; use the query service to find journals that meet certain criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness, Employee, Approver, Project Manager, and Warehouse
PermissionsList, View Journals
tags: - General_Ledger_Journals operationId: list-general-ledger-journal responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of GL Journals: value: ia::result: - key: '1' id: AR href: /objects/general-ledger/journal/1 - key: '2' id: AP href: /objects/general-ledger/journal/2 - key: '14' id: ADJ href: /objects/general-ledger/journal/14 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a journal description: >- Creates a new journal object. New journals are immediately available for users to enter journal entries through the General Ledger. They are also available to be used in the configuration of other applications. For example, you might create a Labor Cost journal to be used by the Projects application. tags: - General_Ledger_Journals operationId: create-general-ledger-journal requestBody: description: Journal to create content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-journal' - $ref: '#/components/schemas/general-ledger-journalRequiredProperties' examples: Create a journal: value: id: EJ name: Expense Journal bookType: accrual responses: '201': description: Created content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Journal created: value: ia::result: key: '3' id: EJ href: /objects/general-ledger/journal/3 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/journal/{key}: parameters: - name: key description: System-assigned key for the journal. in: path schema: type: string required: true example: '411' get: summary: Get a journal description: >+ Returns detailed information for a specified journal.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness, Employee, Approver, Project Manager, and Warehouse
PermissionsList, View Journals
tags: - General_Ledger_Journals responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/general-ledger-journal' ia::meta: $ref: '#/components/schemas/metadata' examples: Single gl-journal: value: ia::result: key: '3' id: EJ status: active name: Expense Journal isAdjustment: true bookId: Accrual bookType: accrual audit: createdDateTime: '2023-01-20T10:25:30Z' modifiedDateTime: '2023-11-02T08:30:22Z' createdBy: '68' modifiedBy: '72' isBillable: false href: /objects/general-ledger/journal/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' operationId: get-general-ledger-journal-key security: - OAuth2: [] patch: summary: Update a journal description: >+ Updates an existing journal by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness user with admin privileges
PermissionsEdit Journals
tags: - General_Ledger_Journals operationId: update-general-ledger-journal-key requestBody: content: application/json: schema: $ref: '#/components/schemas/general-ledger-journal' examples: Change the name and billable status of a journal: value: name: Expense Journal isBillable: true responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update gl-journal successful: value: ia::result: key: '3' id: EJ href: /objects/general-ledger/journal/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a journal description: >+ Deletes a journal. You can only delete a journal if it does not have any transactions in it. Deleted journals cannot be recovered.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness user with admin privileges
PermissionsDelete Journals
tags: - General_Ledger_Journals operationId: delete-general-ledger-journal-key responses: '200': description: OK '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/statistical-journal: get: summary: List statistical journals description: >+ Returns up to 100 journals from the collection with a key, ID, and link for each journal. This operation is mostly for use in testing; use the query service to find journals that meet certain criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness, Employee, Approver
PermissionsList, View Statistical Journals
tags: - General_Ledger_Statistical journals operationId: list-general-ledger-statistical-journal responses: '200': description: OK content: application/json: schema: type: object title: List of statistical journals properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List statistical journals: value: ia::result: - key: '36' id: SMAXIMUM href: /objects/general-ledger/statistical-journal/36 - key: '34' id: TSSJ href: /objects/general-ledger/statistical-journal/34 - key: '35' id: SINAJ href: /objects/general-ledger/statistical-journal/35 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a statistical journal description: |+ Creates a new statistical Journal
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness
PermissionsAdd Statistical Journals
tags: - General_Ledger_Statistical journals operationId: create-general-ledger-statistical-journal requestBody: description: Statistical journal to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-statistical-journal' - $ref: '#/components/schemas/general-ledger-statistical-journalRequiredProperties' examples: Simple POST request: value: id: TSSJ name: Timesheet Statistical Journal status: active responses: '201': description: Created content: application/json: schema: type: object title: New statistical journal properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Simple POST response: value: ia::result: key: '88' id: TSSJ href: /objects/general-ledger/statistical-journal/88 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/statistical-journal/{key}: parameters: - name: key description: System-assigned key for a statistical journal. in: path required: true schema: type: string example: '88' get: summary: Get a statistical Journal description: >+ Get complete details for a specified statistical journal.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness, Employee, Approver
PermissionsList, View Statistical Journals
tags: - General_Ledger_Statistical journals operationId: get-general-ledger-statistical-journal-key responses: '200': description: OK content: application/json: schema: type: object title: Statistical journal details properties: ia::result: $ref: '#/components/schemas/general-ledger-statistical-journal' ia::meta: $ref: '#/components/schemas/metadata' examples: Simple GET response: value: ia::result: id: TSSJ name: Timesheet Statistical Journal status: active audit: createdDateTime: '2021-06-27T17:16:13Z' modifiedDateTime: '2021-06-27T17:16:13Z' createdBy: '1' modifiedBy: '1' key: '36' href: /objects/general-ledger/statistical-journal/36 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a statistical journal description: >+ Updates an existing statistical journal by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness
PermissionsEdit Statistical Journals
tags: - General_Ledger_Statistical journals operationId: update-general-ledger-statistical-journal-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-statistical-journal' - type: object properties: id: readOnly: true examples: Update name and status: value: name: Timesheet Statistical Journal status: active responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Simple PATCH response: value: ia::result: key: '88' id: TSSJ href: /objects/general-ledger/statistical-journal/88 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a statistical journal description: >+ Deletes a statistical journal. You can only delete a journal if there are no transactions in it.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness
PermissionsDelete Statistical Journals
tags: - General_Ledger_Statistical journals operationId: delete-general-ledger-statistical-journal-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/journal-entry: get: summary: List journal entries description: >+ Returns up to 100 journal entries from the collection with a key, ID, and link for each entry. This operation is mostly for use in testing; use the query service to find journal entries that meet certain criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness user with Admin privileges, Employee, Payment Approver
PermissionsList, View Journal Entries
tags: - General_Ledger_Journal entries operationId: list-general-ledger-journal-entry responses: '200': description: OK content: application/json: schema: type: object title: List of journal entry objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: list of journal entries: value: ia::result: - key: '256' id: '256' href: /objects/general-ledger/journal-entry/256 - key: '132' id: '132' href: /objects/general-ledger/journal-entry/132 - key: '56' id: '56' href: /objects/general-ledger/journal-entry/56 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a journal entry description: >+ Creates a new journal entry (transaction). You can post a transaction to a journal right away, or save it as a draft. - Draft transactions do not have to be complete; they can be reviewed and updated before they are posted. - In order to post a journal entry, the entire transaction must balance and all required information must be entered.
Permissions and other requirements
SubscriptionGeneral Ledger, Projects (for revenue recognition of projects)
User ypeBusiness
PermissionsAdd Journal Entries
tags: - General_Ledger_Journal entries operationId: create-general-ledger-journal-entry requestBody: description: Journal entry to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-journal-entry' - $ref: '#/components/schemas/general-ledger-journal-entryRequiredProperties' examples: Create a journal entry: value: glJournal: id: GJ postingDate: '2022-04-01' description: March Revenue Posting lines: - lineNumber: 1 txnType: credit entryDate: '2022-04-01' txnAmount: '200' glAccount: id: '1000' dimensions: department: key: '11' location: key: '192' documentId: Revenue_attachment - lineNumber: 2 txnType: debit entryDate: '2022-04-01' txnAmount: '200' glAccount: id: '1000' dimensions: department: key: '11' location: key: '192' documentId: Revenue_attachment responses: '201': description: Created content: application/json: schema: type: object title: New journal-entry properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Sample POST response: value: ia::result: key: '41' id: '41' href: /objects/general-ledger/journal-entry/41 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/journal-entry/{key}: parameters: - name: key description: System-assigned key for the journal entry. in: path required: true schema: type: string example: '132' get: summary: Get journal entry description: Returns detailed information for a specified journal entry. tags: - General_Ledger_Journal entries operationId: get-general-ledger-journal-entry-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the journal entry properties: ia::result: $ref: '#/components/schemas/general-ledger-journal-entry' ia::meta: $ref: '#/components/schemas/metadata' examples: Journal entry details: value: ia::result: id: '132' key: '132' txnNumber: 40 description: Revenue Entries glJournal: key: '23' id: CRJ isAdjustment: false href: /objects/general-ledger/journal/23 postingDate: '2021-09-24' moduleName: 2.GL referenceId: CR0 automaticReversalDate: null reversedBy: key: null reversedFromDate: null baseLocation: id: null key: null audit: createdDateTime: '2023-06-09T00:33:58Z' modifiedDateTime: '2023-06-09T00:33:59Z' createdBy: '68' modifiedBy: '68' state: posted sequenceNumber: null taxSolutionId: id: null lines: - id: '8434' key: '8434' journalEntry: id: '3235' key: '3235' href: /objects/general-ledger/journal-entry/3235 lineNumber: 1 txnType: credit entryDate: '2021-09-24' txnAmount: '100' account: key: '9' id: '4000' name: Revenue href: /objects/general-ledger/account/9 dimensions: department: key: '1' id: '01' name: Sales href: /objects/company-config/department/1 location: key: '1' id: CA name: California href: /objects/company-config/location/1 class: key: null id: null name: null item: key: null id: null name: null customer: key: null id: null name: null vendor: key: null id: null name: null project: key: null id: null name: null employee: key: null id: null name: null warehouse: key: null id: null name: null task: key: null id: null name: null documentId: Revenue_attachment description: null numberOfUnits: null currency: baseCurrency: USD txnCurrency: USD exchangeRateDate: '2023-06-08' exchangeRateTypeId: null exchangeRate: 1 accountAllocationTimePeriod: null allocation: id: null key: null audit: createdDateTime: '2023-06-09T00:33:58Z' modifiedDateTime: '2023-06-09T00:33:59Z' createdBy: '68' modifiedBy: '68' state: posted isBillable: false isBilled: null href: /objects/general-ledger/journal-entry-line/8434 - id: '8435' key: '8435' journalEntry: id: '3235' key: '3235' href: /objects/general-ledger/journal-entry/3235 lineNumber: 2 transactionType: Debit entryDate: '2023-06-08' transactionAmount: 200 glAccount: key: '81' id: '1000' name: Checking href: /objects/general-ledger/account/81 dimensions: department: key: '1' id: '01' name: Sales href: /objects/company-config/department/1 location: key: '1' id: CA name: California href: /objects/company-config/location/1 class: key: null id: null name: null item: key: null id: null name: null customer: key: null id: null name: null vendor: key: null id: null name: null project: key: null id: null name: null employee: key: null id: null name: null warehouse: key: null id: null name: null task: key: null id: null name: null documentId: Revenue_attachment description: null numberOfUnits: null currency: baseCurrency: USD txnCurrency: USD exchangeRateDate: '2023-06-08' exchangeRateTypeId: null exchangeRate: 1 accountAllocationTimePeriod: null allocation: id: null key: null audit: createdDateTime: '2023-06-09T00:33:59Z' modifiedDateTime: '2023-06-09T00:33:59Z' createdBy: '68' modifiedBy: '68' state: posted isBillable: false isBilled: null href: /objects/general-ledger/journal-entry-line/8435 href: /objects/general-ledger/journal-entry/3235 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a journal entry description: >- Updates an existing journal entry by setting field values. Any fields not provided remain unchanged. tags: - General_Ledger_Journal entries operationId: update-general-ledger-journal-entry-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-journal-entry' - type: object properties: id: readOnly: true examples: Update 2 lines and add 1: value: postingDate: '2023-12-11' state: posted lines: - key: 195 txnType: debit txnAmount: '100' glAccount: id: '1000' dimensions: department: id: '11' location: id: '1' documentId: test currency: txnCurrency: USD - key: 196 txnType: debit txnAmount: '100' glAccount: id: '1000' dimensions: department: id: '11' location: id: '1' documentId: test currency: txnCurrency: USD - txnType: credit txnAmount: '200' glAccount: id: '4000' dimensions: department: id: '11' location: id: '1' documentId: Test1 currency: txnCurrency: USD responses: '200': description: OK content: application/json: schema: type: object title: Updated journal-entry properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: key: '1' id: '1' href: /objects/general-ledger/journal-entry/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a journal entry description: Deletes a journal entry. tags: - General_Ledger_Journal entries operationId: delete-general-ledger-journal-entry-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/journal-entry-line: get: summary: List journal entry lines description: >+ Returns up to 100 journal entry lines from the collection with a key, ID, and link for each entry. This operation is mostly for use in testing; use the query service to find journal entry lines that meet certain criteria and to specify the properties that are returned.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness user, Employee, Payment Approver
PermissionsList, View Journal Entries
tags: - General_Ledger_Journal entry lines operationId: list-general-ledger-journal-entry-line responses: '200': description: OK content: application/json: schema: type: object title: List of journal-entry-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get Journal entry lines: value: ia::result: - key: '2503' id: '2503' href: /objects/general-ledger/journal-entry-line/2503 - key: '2499' id: '2499' href: /objects/general-ledger/journal-entry-line/2499 - key: '2497' id: '2497' href: /objects/general-ledger/journal-entry-line/2497 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/journal-entry-line/{key}: parameters: - name: key description: System-assigned key for the journal entry line. in: path required: true example: '2647' schema: type: string get: summary: Get a journal entry line description: >+ Returns detailed information for a specified journal entry line.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness user, Employee, Payment Approver
PermissionsList, View Journal Entries
tags: - General_Ledger_Journal entry lines operationId: get-general-ledger-journal-entry-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the journal-entry-line properties: ia::result: $ref: '#/components/schemas/general-ledger-journal-entry-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get journal entry line: value: ia::result: id: '18' key: '18' lines: - id: '6' key: '6' lineNumber: 1 txnType: debit entryDate: '2023-12-18' txnAmount: '5000' baseAmount: '8562.13' exchangeRate: date: '2023-12-17' typeId: EUR-Rate rate: 2.15 glAccount: key: '207' id: '6280' name: Professional Fees href: /objects/general-ledger/account/207 dimensions: department: key: '1' id: '01' name: Sales href: /objects/company-config/department/1 location: key: '1' id: CA name: California href: /objects/company-config/location/1 class: key: null id: null name: null item: key: '4' id: SVC01-01 name: Implementation Services href: /objects/inventory-control/item/4 customer: key: '14' id: C-00003 name: Burlington Textiles Corp of America href: /objects/accounts-receivable/customer/14 vendor: key: null id: null name: null project: key: null id: null name: null employee: key: null id: null name: null warehouse: key: null id: null name: null task: key: null id: null name: null documentId: null description: null numberOfUnits: null currency: baseCurrency: USD txnCurrency: USD exchangeRateDate: null exchangeRateType: null exchangeRate: 1 reconciliationGroup: cleared: 'false' clearingDate: null reconciliationDate: null accountingPeriod: null allocation: allocation: null allocationKey: null audit: createdDateTime: '1970-01-01T00:00:00Z' modifiedDateTime: '2015-07-21T07:40:24Z' createdBy: null modifiedBy: null state: posted isBillable: null isBilled: null href: /objects/general-ledger/journal-entry-line/6 - id: 7 key: 7 lineNumber: 2 txnType: credit entryDate: '2009-12-18' txnAmount: '5000' baseAmount: '8562.13' exchangeRate: date: '2009-12-17' typeId: EUR-Rate rate: 2.15 glAccount: key: '207' id: '6280' name: Professional Fees href: /objects/general-ledger/account/207 dimensions: department: key: '1' id: '01' name: Sales href: /objects/company-config/department/1 location: key: '1' id: CA name: California href: /objects/company-config/location/1 class: key: null id: null name: null item: key: '4' id: SVC01-01 name: Implementation Services href: /objects/inventory-control/item/4 customer: key: '14' id: C-00003 name: Burlington Textiles Corp of America href: /objects/accounts-receivable/customer/14 vendor: key: null id: null name: null project: key: null id: null name: null employee: key: null id: null name: null warehouse: key: null id: null name: null task: key: null id: null name: null documentId: null description: null numberOfUnits: null currency: baseCurrency: USD txnCurrency: USD exchangeRateDate: null exchangeRateType: null exchangeRate: 1 reconciliationGroup: cleared: 'false' clearingDate: null reconciliationDate: null accountingPeriod: null allocation: allocation: null allocationKey: null audit: createdDateTime: '1970-01-01T00:00:00Z' modifiedDateTime: '2015-07-21T07:40:24Z' createdBy: null modifiedBy: null state: posted isBillable: null isBilled: null href: /objects/general-ledger/journal-entry-line/7 href: /objects/general-ledger/journal-entry/6 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a Journal entry line description: |+ Deletes a journal entry line.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness user
PermissionsDelete Journal Entries
tags: - General_Ledger_Journal entry lines operationId: delete-general-ledger-journal-entry-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/budget: get: summary: List budgets description: >+ Returns up to 100 budgets from the collection with a key, ID, and link for each budget. This operation is mostly for use in testing; use the query service to find budgets that meet specific criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness, Employee, Approver
PermissionsList, View Budgets
tags: - General_Ledger_Budgets operationId: list-general-ledger-budget responses: '200': description: OK content: application/json: schema: type: object title: List budget objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List budgets: value: ia::result: - key: '1' id: Std_Budget href: /objects/general-ledger/budget/1 - key: '2' id: KPI Budgets href: /objects/general-ledger/budget/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a budget description: |+ Creates a new budget.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness User
PermissionsAdd Budgets
tags: - General_Ledger_Budgets operationId: create-general-ledger-budget requestBody: description: Budget to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-budget' - $ref: '#/components/schemas/general-ledger-budgetRequiredProperties' examples: Create a budget: value: id: Budget1 description: First budget isDefault: true status: active consolidateAmounts: false currency: null postProjectEstimate: false lines: - glAccount: id: '1000' dimensions: location: id: '1' reportingPeriod: id: Month ended January 2022 amount: '100' budgetGrowth: basedOn: budget growBy: null perPeriod: percentage - glAccount: id: '1000' dimensions: location: id: '1' reportingPeriod: id: Month ended February 2022 amount: '150' budgetGrowth: basedOn: budget growBy: null perPeriod: percentage - glAccount: id: '1000' dimensions: location: id: '1' reportingPeriod: id: Month ended March 2022 amount: '100' budgetGrowth: basedOn: budget growBy: null perPeriod: percentage responses: '201': description: Created content: application/json: schema: type: object title: New budget properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Sample POST response: value: ia::result: key: '41' id: Budget1 href: /objects/general-ledger/budget/41 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/budget/{key}: parameters: - name: key description: System-assigned key for the budget. in: path schema: type: string required: true example: '291' get: summary: Get a budget description: >+ Returns detailed information for a specified budget.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness, Employee, Approver
PermissionsList, View Budgets
tags: - General_Ledger_Budgets operationId: get-general-ledger-budget-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the budget properties: ia::result: $ref: '#/components/schemas/general-ledger-budget' ia::meta: $ref: '#/components/schemas/metadata' examples: Get budget details: value: ia::result: key: '5' id: Employee Expense Budget description: Employee Expense Budget isDefault: false userName: Admin status: active audit: createdDateTime: '2022-02-16T05:13:36Z' modifiedDateTime: '2022-02-16T05:13:36Z' createdBy: '1' modifiedBy: '1' consolidateAmounts: false currency: USD postProjectEstimate: false lines: - id: '291' key: '291' budget: key: '5' id: Employee Expense Budget href: /objects/general-ledger/budget/291 currency: txnCurrency: USD reportingPeriod: key: '79' id: Month Ended January 2022 name: Month Ended January 2022 href: /objects/reportingperiod/79 glAccount: key: '9' id: '4000' name: Revenue href: /objects/general-ledger/account/9 dimensions: department: key: '9' id: '11' name: Sales href: /objects/company-config/department/9 location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 employee: key: '1' id: '1' name: Joe Smith href: /objects/company-config/employee/10 item: key: '101' id: '101' name: Widgets href: /objects/inventory-control/item/101 class: key: '2' id: '2' name: Mid Market href: /objects/company-config/class/2 warehouse: key: '1' id: '1' name: Main href: /objects/inventory-control/warehouse/1 customer: key: '1' id: '1' name: Big Buyer href: /objects/accounts-receivable/customer/1 vendor: key: '1' id: '1' name: Widget Wholesales href: /objects/accounts-payable/vendor/1 amount: '100' budgetGrowth: basedOn: budget growBy: null perPeriod: percentage notes: Projection for 2021 href: /objects/general-ledger/budget-detail/291 href: /objects/general-ledger/budget/5 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a budget description: >+ Updates an existing budget and its budget details by setting field values. Any fields not provided remain unchanged. * To update an existing budget-detail line within a budget, provide the budget-detail `key` value. * To add a new budget-detail line to a budget, do not include a `key` value. * To delete a budget-detail line, send a `DELETE /objects/general-ledger/budget-detail/{key}` request.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness User
PermissionsEdit Budgets
tags: - General_Ledger_Budgets operationId: update-general-ledger-budget-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-budget' - type: object properties: id: readOnly: true examples: Set a budget to inactive: value: status: inactive Update the amount in a budget detail line: value: lines: - key: '4120' amount: '1229' Set a budget as default, update a line and add a line: value: isDefault: true lines: - key: '135' budgetGrowth: basedOn: budget growBy: 15 perPeriod: percentage - glAccount: id: '1000' dimensions: location: id: '1' reportingPeriod: id: Month ended June 2022 amount: '100' budgetGrowth: basedOn: budget growBy: 18 perPeriod: percentage responses: '200': description: OK content: application/json: schema: type: object title: Budget updated properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Budget updated: value: ia::result: key: '21' id: Std_Budget href: /objects/general-ledger/budget/21 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete budget description: >+ Deletes a budget. You cannot delete the default budget or any budget that is being used by a financial report. Carefully consider the implications before you delete a budget. After you delete a budget, you will no longer be able to use its data to create future budgets and it can no longer be used in financial reports.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness User
PermissionsDelete Budgets
tags: - General_Ledger_Budgets operationId: delete-general-ledger-budget-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/budget-detail: get: summary: List budget details description: >+ Returns up to 100 budget details from the collection with a key, ID, and link for each budget detail object. This operation is mostly for use in testing; use the query service to find budget details that meet certain criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness, Employee, Approver
PermissionsList, View Budgets
tags: - General_Ledger_Budget details operationId: list-general-ledger-budget-detail responses: '200': description: OK content: application/json: schema: type: object title: List budget detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List budget header: value: ia::result: - key: '284' id: '284' href: /objects/general-ledger/budget-detail/284 - key: '285' id: '285' href: /objects/general-ledger/budget-detail/285 - key: '286' id: '286' href: /objects/general-ledger/budget-detail/286 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/budget-detail/{key}: parameters: - name: key description: System-assigned key for the budget detail. in: path schema: type: string required: true example: '153' get: summary: Get budget details description: >+ Returns detailed information for a specified budget detail.
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness, Employee, Approver
PermissionsList, View Budgets
tags: - General_Ledger_Budget details operationId: get-general-ledger-budget-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of budget properties: ia::result: $ref: '#/components/schemas/general-ledger-budget-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get budget details: value: ia::result: id: '13' key: '13' budget: key: '2' id: Proj-budget href: /objects/general-ledger/budget/2 currency: txnCurrency: null reportingPeriod: key: '127' id: Month ended January 2023 name: Month ended January 2023 href: /objects/general-ledger/reporting-period/127 glAccount: key: '279' id: '9501' name: Labor Costing - Billable href: /objects/general-ledger/account/279 dimensions: department: key: null id: null name: null location: key: null id: null name: null class: key: null id: null name: null item: key: null id: null name: null customer: key: null id: null name: null vendor: key: null id: null name: null project: key: null id: null name: null employee: key: null id: null name: null warehouse: key: null id: null name: null task: key: null id: null name: null amount: '1000.00' budgetGrowth: basedOn: budget growBy: null perPeriod: percentage notes: Notes href: /objects/general-ledger/budget-detail/13 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete budget detail description: |+ Deletes a budget detail
Permissions and other requirements
SubscriptionGeneral Ledger
User ypeBusiness User
PermissionsDelete Budgets
tags: - General_Ledger_Budget details operationId: delete-general-ledger-budget-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/reporting-period: get: summary: List reporting periods description: >- Returns up to 100 reporting periods from the collection with a key, ID, and link for each period. This operation is mostly for use in testing; use the query service to find reporting periods that meet specific criteria and to specify the properties that you want in the response. tags: - General_Ledger_Reporting periods operationId: list-general-ledger-reporting-period responses: '200': description: OK content: application/json: schema: type: object title: List of reporting-period objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List reporting periods: value: ia::result: - key: '1' id: Current Month href: /objects/general-ledger/reporting-period/1 - key: '2' id: Next Month href: /objects/general-ledger/reporting-period/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a reporting period description: Creates a new reporting period. tags: - General_Ledger_Reporting periods operationId: create-general-ledger-reporting-period requestBody: description: Reporting period to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-reporting-period' - $ref: '#/components/schemas/general-ledger-reporting-periodRequiredProperties' examples: Create a reporting period: value: startDate: '2023-01-01' endDate: '2023-12-31' id: Current Year 2023 columnHeader1: Current Year isBudgetable: false responses: '201': description: Created content: application/json: schema: type: object title: Reference to new reporting period properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new reporting period: value: ia::result: key: '1023' id: Current Year 2023 href: /objects/general-ledger/reporting-period/1023 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/reporting-period/{key}: parameters: - name: key description: System-assigned unique key for the reporting period. in: path required: true schema: type: string example: '240' get: summary: Get a reporting period description: Returns detailed information for a specified reporting period. tags: - General_Ledger_Reporting periods operationId: get-general-ledger-reporting-period-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the reporting period properties: ia::result: $ref: '#/components/schemas/general-ledger-reporting-period' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the reporting period: value: ia::result: id: Current Year 2023 key: '1023' href: /objects/general-ledger/reporting-period/1023 startDate: '2023-02-01' endDate: '2023-12-31' isBudgetable: false columnHeader1: Current Year columnHeader2: null status: active audit: createdDateTime: '2021-10-18T12:30:47Z' modifiedDateTime: '2022-01-07T04:07:21Z' createdBy: '1' modifiedBy: '1' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a reporting period description: >- Updates an existing reporting period by setting field values. Any fields not provided remain unchanged. tags: - General_Ledger_Reporting periods operationId: update-general-ledger-reporting-period-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-reporting-period' - type: object properties: id: readOnly: true examples: Update a reporting period: value: startDate: '2023-01-01' endDate: '2023-11-30' columnHeader1: Current Year till nov isBudgetable: false responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated reporting period properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated reporting period: value: ia::result: key: '1023' id: Current Year 2023 href: /objects/general-ledger/reporting-period/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a reporting period description: Deletes a reporting period. tags: - General_Ledger_Reporting periods operationId: delete-general-ledger-reporting-period-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/txn-allocation-template: get: summary: List transaction allocation templates description: >+ Returns up to 100 transaction allocation templates from the collection with a key, ID, and link for each one. This operation is mostly for use in testing; use the query service to find allocation templates that meet specific criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsList transaction allocations
tags: - General_Ledger_Transaction allocation templates operationId: list-general-ledger-txn-allocation-template responses: '200': description: OK content: application/json: schema: type: object title: List allocation template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of allocations: value: ia::result: - key: '1' id: Fixed Amount Allocation href: /objects/general-ledger/txn-allocation-template/1 - key: '2' id: Percentage Allocation href: /objects/general-ledger/txn-allocation-template/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a transaction allocation template description: >+ Creates a new transaction allocation template, optionally including allocation template lines.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsAdd transaction allocations
tags: - General_Ledger_Transaction allocation templates operationId: create-general-ledger-txn-allocation-template requestBody: description: Transaction allocation template to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-txn-allocation-template' - $ref: '#/components/schemas/general-ledger-txn-allocation-templateRequiredProperties' examples: Creates an allocation template: value: id: Fixed amount allocation description: Fixed dollar amount allocation status: active allocateBy: exactAmount lines: - value: '100' dimensions: department: id: '1' location: id: '1' responses: '201': description: Created content: application/json: schema: type: object title: Reference to new allocation template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new allocation template: value: ia::result: key: '4' id: Fixed amount allocation href: /objects/general-ledger/txn-allocation-template/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/txn-allocation-template/{key}: parameters: - name: key description: System-assigned key for the transaction allocation template. in: path required: true schema: type: string example: '2' get: summary: Get a transaction allocation template description: >+ Returns detailed information for a specified transaction allocation template.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsList, View transaction allocations
tags: - General_Ledger_Transaction allocation templates operationId: get-general-ledger-txn-allocation-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the allocation template properties: ia::result: $ref: '#/components/schemas/general-ledger-txn-allocation-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the allocation template: value: ia::result: key: '3' id: Fixed amount allocation description: Fixed dollar amount allocation allocateBy: exactAmount documentNumber: REJCAL status: active audit: createdDateTime: '2023-06-23T11:32:17Z' modifiedDateTime: '2023-06-23T12:25:08Z' createdBy: '1' modifiedBy: '1' lines: - key: '8' id: Fixed Amount Allocation txnAllocationTemplate: id: Fixed amount allocation key: '3' href: /objects/general-ledger/txn-allocation-template/3 unit: amount value: '100' dimensions: location: id: '1' name: United States of America key: '1' href: /objects/company-config/location/1 department: id: '11' name: Accounting key: '9' href: /objects/company-config/department/9 project: key: '13' id: CO name: Contract - Platinum - Modulus Industries href: /objects/projects/project/13 customer: key: '3' id: MI name: Modulus Industries href: /objects/accounts-receivable/customer/3 vendor: key: '47' id: '201' name: PG & E href: /objects/accounts-payable/vendor/47 employee: key: '2' id: '2' name: Hatcher href: /objects/company-config/employee/2 item: key: '29' id: A001 name: Desktop-HP href: /objects/inventory-control/item/29 class: key: '6' id: '4' name: Professional Services href: /objects/company-config/class/6 task: key: '1' id: T-001 name: Task-1 href: /objects/projects/task/1 warehouse: key: '19' id: WareHouse10004 name: Warehouse Name 10004 (CN) href: /objects/inventory-control/warehouse/19 audit: createdDateTime: '2023-06-23T12:25:09Z' modifiedDateTime: '2023-06-23T12:25:09Z' createdBy: '1' modifiedBy: '1' lineNumber: 1 href: '/objects/general-ledger/txn-allocation-template-line/8' href: /objects/general-ledger/txn-allocation-template/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction allocation template description: >+ Updates an existing allocation template and template lines by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsEdit transaction allocations
tags: - General_Ledger_Transaction allocation templates operationId: update-general-ledger-txn-allocation-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/general-ledger-txn-allocation-template' - type: object properties: id: readOnly: true examples: Update an allocation description and one existing line: value: description: All Shop Allocation lines: - key: '3' unit: amount value: '95' responses: '200': description: OK content: application/json: schema: type: object title: Reference to updated allocation template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated allocation template: value: ia::result: key: '3' id: Fixed amount allocation href: /objects/general-ledger/txn-allocation-template/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction allocation template description: >+ Deletes a transaction allocation template.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsDelete transaction allocations
tags: - General_Ledger_Transaction allocation templates operationId: delete-general-ledger-txn-allocation-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/txn-allocation-template-line: get: summary: List transaction allocation template lines description: >+ Returns up to 100 transaction allocation template lines from the collection with a key, ID, and link for each one. This operation is mostly for use in testing; use the query service to find allocation template lines that meet specific criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsList transaction allocations
tags: - General_Ledger_Transaction allocation template lines operationId: list-general-ledger-txn-allocation-template-line responses: '200': description: OK content: application/json: schema: type: object title: List transaction allocation template lines properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction allocation template lines: value: ia::result: - key: '4' id: '4' href: /objects/general-ledger/txn-allocation-template-line/1 - key: '8' id: '8' href: /objects/general-ledger/txn-allocation-template-line/1 - key: '1' id: '1' href: /objects/general-ledger/txn-allocation-template-line/2 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/general-ledger/txn-allocation-template-line/{key}: parameters: - name: key description: System-assigned key for the transaction allocation template line. in: path required: true schema: type: string example: '209856' get: summary: Get a transaction allocation template line description: >+ Returns detailed information for a specified transaction allocation template line.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness user with admin privileges
PermissionsList, View transaction allocations
tags: - General_Ledger_Transaction allocation template lines operationId: get-general-ledger-txn-allocation-template-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the transaction allocation template line properties: ia::result: $ref: '#/components/schemas/general-ledger-txn-allocation-template-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the transaction allocation template line: value: ia::result: key: '8' id: '8' allocation: id: Fixed amount allocation key: '3' href: /objects/general-ledger/txn-allocation-template/3 unit: amount value: '100' dimensions: location: id: '1' name: United States of America key: '1' href: /objects/company-config/location/1 department: id: '11' name: Accounting key: '9' href: /objects/company-config/department/9 project: key: '13' id: CO name: Contract - Platinum - Modulus Industries href: /objects/projects/project/13 customer: key: '3' id: MI name: Modulus Industries href: /objects/accounts-receivable/customer/3 vendor: key: '47' id: '201' name: PG & E href: /objects/accounts-payable/vendor/47 employee: key: '2' id: '2' name: Hatcher href: /objects/company-config/employee/2 item: key: '29' id: A001 name: Desktop-HP href: /objects/inventory-control/item/29 class: key: '6' id: '4' name: Professional Services href: /objects/company-config/class/6 task: key: '1' id: T-001 name: Task-1 href: /objects/projects/task/1 warehouse: key: '19' id: WareHouse10004 name: Warehouse Name 10004 (CN) href: /objects/inventory-control/warehouse/19 audit: createdDateTime: '2022-06-23T12:25:09Z' modifiedDateTime: '2022-06-23T12:25:09Z' createdBy: '1' modifiedBy: '1' lineNumber: 1 href: /objects/general-ledger/txn-allocation-template-line/8 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /services/gl/reports/get-account-balances-by-dimensions: post: summary: Get account balances by dimension description: >- Returns account balances filtered and grouped specified dimensions (standard or user-defined) such as location and department. You can use this function to return budget data or both actual and budget data. tags: - General_Ledger_Reports operationId: post-gl-reports-get-account-balances-by-dimensions requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/gl-reports-get-account-balances-by-dimensions-request' examples: Get account balances by location and user-defined dimension: value: startDate: '2018-01-01' endDate: '2023-12-31' startAccountNumber: '4000' endAccountNumber: '4999' locationId: PNW userDefinedDimension: - objectName: category recordName: CAT1 groupBy: location,department,category responses: '200': description: Executed content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/gl-reports-get-account-balances-by-dimensions-response' ia::meta: $ref: '#/components/schemas/metadata' examples: Account balances by specified dimension: value: ia::result: accountBalances: GLACCOUNTNO: '4000' STARTBALANCE: '0.00' PERIODBALANCE: '-36.00' ENDBALANCE: '-36.00' CURRENCY: USD LOCATIONID: '1' LOCATIONNAME: United States of America CATEGORY: CAT1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/aisle: get: summary: List aisles description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each aisle. 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
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Aisles
tags: - Inventory_Control_Aisles operationId: list-inventory-control-aisle responses: '200': description: OK content: application/json: schema: type: object title: List of aisle objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List aisles: value: ia::result: - key: '145' id: A12 href: /objects/inventory-control/aisle/145 - key: '146' id: A14 href: /objects/inventory-control/aisle/146 - key: '147' id: A16 href: /objects/inventory-control/aisle/147 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an aisle description: >+ Creates a new aisle.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Add Aisles
tags: - Inventory_Control_Aisles operationId: create-inventory-control-aisle requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-aisle' - $ref: '#/components/schemas/inventory-control-aisleRequiredProperties' examples: Create an aisle: value: id: A12 description: Aisle 12 Dishwashers responses: '201': description: Created content: application/json: schema: type: object title: New aisle properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create an aisle: value: ia::result: key: '145' id: AD12 href: /objects/inventory-control/aisle/145 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/aisle/{key}: parameters: - schema: type: string example: '145' name: key in: path required: true description: System-assigned key for the aisle. get: summary: Get an aisle description: >+ Returns detailed information for a specified aisle.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Aisles
tags: - Inventory_Control_Aisles operationId: get-inventory-control-aisle-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the aisle properties: ia::result: $ref: '#/components/schemas/inventory-control-aisle' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an aisle: value: ia::result: key: '145' id: A12 description: Aisle 12 of dishwashers audit: createdDateTime: '2021-05-07T01:15:23Z' modifiedDateTime: '2021-05-07T01:15:23Z' createdBy: '13' modifiedBy: '13' href: /objects/inventory-control/aisle/145 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an aisle description: >+ Updates an existing aisle by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Edit Aisles
tags: - Inventory_Control_Aisles operationId: update-inventory-control-aisle-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-aisle' - type: object properties: id: readOnly: true examples: Update a single value: value: description: Aisle 1 dishwashers responses: '200': description: OK content: application/json: schema: type: object title: Updated aisle properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated aisle: value: ia::result: key: '145' id: A12 href: /objects/inventory-control/aisle/145 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an aisle description: >+ Deletes an aisle. You can delete an aisle if it is not being used and you no longer need it. Deleted aisles cannot be recovered.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Delete Aisles
tags: - Inventory_Control_Aisles operationId: delete-inventory-control-aisle-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/bin-face: get: summary: List bin faces description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each bin face. 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
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Bin Faces
tags: - Inventory_Control_Bin faces operationId: list-inventory-control-bin-face responses: '200': description: OK content: application/json: schema: type: object title: List of bin-face objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bin faces: value: ia::result: - key: '12' id: BF11 href: /objects/inventory-control/bin-face/12 - key: '14' id: BF22 href: /objects/inventory-control/bin-face/14 ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a bin face description: >+ Creates a new bin face.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Add Bin Faces
tags: - Inventory_Control_Bin faces operationId: create-inventory-control-bin-face requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-bin-face' - $ref: '#/components/schemas/inventory-control-bin-faceRequiredProperties' examples: Create a bin face: value: id: BF2 description: Bin Face 2 responses: '201': description: Created content: application/json: schema: type: object title: New bin-face properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a bin face: value: ia::result: key: '22' id: BF2 href: /objects/inventory-control/bin-face/22 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/bin-face/{key}: parameters: - schema: type: string example: '1232' name: key in: path required: true description: System-assigned key for the bin-face. get: summary: Get a bin face description: >+ Returns detailed information for a specified bin face.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Bin Faces
tags: - Inventory_Control_Bin faces operationId: get-inventory-control-bin-face-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bin-face properties: ia::result: $ref: '#/components/schemas/inventory-control-bin-face' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bin face: value: ia::result: key: '1232' id: BF123 description: Bin Face 123 audit: createdDateTime: '2021-05-07T01:15:23Z' modifiedDateTime: '2021-05-07T01:15:23Z' createdBy: '13' modifiedBy: '13' href: /objects/inventory-control/bin-face/1232 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a bin face description: >+ Updates an existing bin face by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Edit Bin Faces
tags: - Inventory_Control_Bin faces operationId: update-inventory-control-bin-face-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-bin-face' - type: object properties: id: readOnly: true examples: Update a single value: value: description: W1 G1 Bestsellers responses: '200': description: OK content: application/json: schema: type: object title: Updated bin-face properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated bin face: value: ia::result: key: '1232' id: BF123 href: /objects/inventory-control/bin-face/1232 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a bin face description: >+ Deletes a bin face.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Delete Bin Faces
tags: - Inventory_Control_Bin faces operationId: delete-inventory-control-bin-face-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/bin-size: get: summary: List all bin sizes description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each bin size. 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
SubscriptionInventory Control
Configurationnull
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Bin Sizes
tags: - Inventory_Control_Bin sizes operationId: list-inventory-control-bin-size responses: '200': description: OK content: application/json: schema: type: object title: List of bin-size objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bin sizes: value: ia::result: - key: '1322' id: BS14 href: /objects/inventory-control/bin-size/1322 - key: '1323' id: BS13 href: /objects/inventory-control/bin-size/1323 ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a bin size description: >+ Creates a new bin size.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Add Bin Sizes
tags: - Inventory_Control_Bin sizes operationId: create-inventory-control-bin-size requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-bin-size' - $ref: '#/components/schemas/inventory-control-bin-sizeRequiredProperties' examples: Create a bin size: value: id: BS12 description: Bin size 12 responses: '201': description: Created content: application/json: schema: type: object title: New bin-size properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New bin size: value: ia::result: key: '1323' id: BS12 href: /objects/inventory-control/bin-size/1323 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/bin-size/{key}: parameters: - schema: type: string example: '1324' name: key in: path required: true description: System-assigned key for the bin size. get: summary: Get a bin size description: >+ Returns detailed information for a specified bin size.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Bin Sizes
tags: - Inventory_Control_Bin sizes operationId: get-inventory-control-bin-size-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bin-size properties: ia::result: $ref: '#/components/schemas/inventory-control-bin-size' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bin size: value: ia::result: key: '1324' id: BS132 description: Bin size 132 audit: createdDateTime: '2021-05-07T01:15:23Z' modifiedDateTime: '2021-05-07T01:15:23Z' createdBy: '13' modifiedBy: '13' href: /objects/inventory-control/bin-size/1324 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a bin size description: >+ Updates an existing bin size by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Edit Bin Sizes
tags: - Inventory_Control_Bin sizes operationId: update-inventory-control-bin-size-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-bin-size' - type: object properties: id: readOnly: true examples: Update a single value: value: description: Size 1 2024 dimensions responses: '200': description: OK content: application/json: schema: type: object title: Updated bin-size properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated bin size: value: ia::result: key: '1324' id: BS132 href: /objects/inventory-control/bin-size/1324 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a bin size description: >+ Deletes a bin size. You can delete a bin size if it is not being used and you no longer need it.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Delete Bin Sizes
tags: - Inventory_Control_Bin sizes operationId: delete-inventory-control-bin-size-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/bin: get: summary: List bins description: >+ Returns up to 100 objects from the collection with a key, ID, and link for each bin. 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
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Bins
tags: - Inventory_Control_Bins operationId: list-inventory-control-bin responses: '200': description: OK content: application/json: schema: type: object title: List of bin objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bins: value: ia::result: - key: '12' id: Z4-A2-R3a-BF2-B10 href: /objects/inventory-control/bin/122 - key: '32' id: Z4-A2-R3a-BF2-B11 href: /objects/inventory-control/bin/132 - key: '44' id: Z4-A2-R3a-BF2-B12 href: /objects/inventory-control/bin/44 - key: '13' id: Z4-A2-R3a-BF2-B13 href: /objects/inventory-control/bin/13 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: 2 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a bin description: >+ Creates a new bin.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Add Bins
tags: - Inventory_Control_Bins operationId: create-inventory-control-bin requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-bin' - $ref: '#/components/schemas/inventory-control-binRequiredProperties' examples: Create a bin: value: id: Z4-A2-R3a-BF2-B10 description: Bin Adapters 2 sequenceNumber: '4432' isPortable: true warehouse: id: WA2 responses: '201': description: Created content: application/json: schema: type: object title: New bin properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New bin: value: ia::result: key: '111' id: Z4-A2-R3a-BF2-B10 href: /objects/inventory-control/bin/111 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/bin/{key}: parameters: - name: key in: path required: true description: System-assigned key for the bin. schema: type: string example: '111' get: summary: Get a bin description: >+ Returns detailed information for a specified bin.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Bins
tags: - Inventory_Control_Bins operationId: get-inventory-control-bin-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bin properties: ia::result: $ref: '#/components/schemas/inventory-control-bin' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bin: value: ia::result: key: '111' id: Z4-A2-R3a-BF2-B10 description: Bin of adapters 2 warehouse: key: '2' id: WA2 href: /objects/inventory-control/warehouse/2 aisle: key: '13' id: A2 href: /objects/inventory-control/aisle/13 row: key: '23' id: R3a href: /objects/inventory-control/row/23 zone: key: '12' id: Z4 href: /objects/inventory-control/zone/12 binFace: key: '3' id: BF2 href: /objects/inventory-control/bin-face/3 binSize: key: '5' id: B10 href: /objects/inventory-control/bin-size/5 href: /objects/inventory-control/bin/111 sequenceNumber: '1221' status: active isPortable: false audit: createdDateTime: '2021-05-07T21:30:03Z' modifiedDateTime: '2021-05-07T21:30:03Z' createdBy: '13' modifiedBy: '13' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a bin description: >+ Updates an existing bin by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Edit Bins
tags: - Inventory_Control_Bins operationId: update-inventory-control-bin-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-bin' examples: Update a single value: value: description: Bin of adapters 3 responses: '200': description: OK content: application/json: schema: type: object title: Updated bin properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated bin: value: ia::result: key: '2' id: Z4-A2-R3a-BF2-B10 href: /objects/inventory-control/bin/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a bin description: >+ Deletes a bin. You can delete a bin if it is not being used and you no longer need it.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Delete Bins
tags: - Inventory_Control_Bins operationId: delete-inventory-control-bin-key responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error-response' security: - OAuth2: [] /objects/inventory-control/item: get: summary: List items description: >- Returns up to 100 object references from the collection with a key, ID, and link for each item. 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: - Inventory_Control_Items responses: '200': description: OK content: application/json: schema: type: object title: List of item objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List items: value: ia::result: - key: '79' id: FVP-020 href: /objects/inventory-control/item/79 - key: '73' id: FVP-016 href: /objects/inventory-control/item/73 - key: '70' id: FVP-014 href: /objects/inventory-control/item/70 ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' operationId: list-inventory-control-item security: - OAuth2: [] post: summary: Create an item description: Creates a new item. tags: - Inventory_Control_Items operationId: create-inventory-control-item responses: '201': description: Created content: application/json: schema: type: object title: New item properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New item: value: ia::result: key: '2458' id: Dell_15_6_XPS_15_Multi_Touch href: /objects/inventory-control/item/104 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item' - $ref: '#/components/schemas/inventory-control-itemRequiredProperties' examples: Create an item: value: id: Dell_15_6_XPS_15_Multi_Touch name: Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver) status: active description: Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver) costMethod: standard notes: Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver) itemType: inventory productLine: id: '2' kitRevenuePosting: null substituteItemId: '' inventory: shippingWeight: 120 glGroup: id: Auto GL Group sales: isTaxable: true basePrice: '1300' taxGroup: id: Goods Standard Rate taxSolution: id: United Kingdom - VAT isAvailableForDropShip: false isAvailableForBuyToOrder: false allowMultipleTaxGroups: false purchasing: standardCost: '1200' unitOfMeasure: id: Count precision: inventoryPrecision: 10 purchasingPrecision: 10 salesPrecision: 10 upc: '23342' tracking: enableSerialNo: true serialMask: '' enableLotCategory: false lotCategory: '' enableBins: false enableExpiration: false replenishment: enableReplenishment: true replenishmentMethod: reorderPoint unitOfMeasureDefault: Each reorderPoint: 1 safetyStock: 1 reorderQuantity: 1 maximumOrderQuantity: 10 measurements: weightUnitOfMeasure: id: Grams netWeight: 12 lengthWidthHeightUnitOfMeasure: id: Centimeters length: 12.4554 width: 12 height: 12 thicknessUnitOfMeasure: id: Centimeters thickness: 12 minimumThickness: 12 maximumThickness: 13 areaUnitOfMeasure: id: Square Inch area: 12 volumeUnitOfMeasure: id: Cubic Centimeters volume: 22 diameterUnitOfMeasure: id: Centimeters innerDiameter: 12 outerDiameter: 12 durometerUnitOfMeasure: '22' densityUnitOfMeasure: grams per cubic centimeter density: 22 itemDetails: universalProductCode: 123456789123 internationalArticleNumber: 1234567891234 isSafetyItem: true isRestrictedItem: false isCompliantItem: false condition: Good engineeringAlert: Verification of Item specification1: Dell 15.6 XPS 15 isApprovedByEngineering: true isApprovedByQualityControl: true isApprovedBySales: true primaryCountryOfOrigin: USA contractTerm: periodsMeasuredIn: weeks numberOfPeriods: 99 isProratedPricingAllowed: false defaultRenewalTemplate: id: SUBInvoiceSameAsOriginalPrcie commercial: brand: Dell Inspiron subBrand: Dell 15 inch category: Dell 15.6 XPS 15 subCategory: Dell 15.6 XPS 15 catalogReference: Dell 15.6 XPS 15 Multi color: Platinum Silver size1: '12' size2: '12' isGiftCard: true isWebEnabled: true webName: Dell Inspiration 15 inch LED webShortDiscription: Dell Inspiration 15 inch LED webLongDescription: Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver) defaultConversionType: quantity enableFulfillment: false itemVendor: - vendor: key: '12' stockNumber: '#5678901234' leadTime: 15 demandForecastDuringLeadTime: 5 economicalOrderQuantity: 10 vendorMinimumOrderQuantity: 10 isPreferredVendor: true warehouseInfo: - warehouse: key: '2' storageArea: Bella economicOrderQuantity: 10 reorderPoint: 1 reorderQuantity: 10 minOrderQuantity: 10 maxOrderQuantity: 100 maximumStock: 300 minimumStock: 50 safetyStock: 20 replenishmentMethod: reorderPoint enableReplenishment: false landedCost: enableLandedCost: true security: - OAuth2: [] /objects/inventory-control/item/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned unique key for the item. get: summary: Get an item description: Returns detailed information for a specified item. tags: - Inventory_Control_Items responses: '200': description: OK content: application/json: schema: type: object title: Details of the item properties: ia::result: $ref: '#/components/schemas/inventory-control-item' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an item: value: ia::result: key: '2458' id: Dell_15_6_XPS_15_Multi_Touch_1 status: active isItemEnabledForMRR: false name: Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver) description: >- 12th Gen Core™ i3-1215U (10 MB cache, 6 cores, 8 threads, up to 4.40 GHz Turbo) poDescription: >- XPS 12th Gen Core™ i3-1215U (10 MB cache, 6 cores, 8 threads, up to 4.40 GHz Turbo) soDescription: >- XPS 12th Gen Core™ i3-1215U (10 MB cache, 6 cores, 8 threads, up to 4.40 GHz Turbo) productLine: id: '2' key: '2' href: /objects/inventory-control/product-line/2 contractDefault: billingTemplate: key: '8' id: 100_Advance_One_time revRecTemplate1: key: '6' id: Daily_Rate_Auto href: /objects/contracts/revenue-template/6 revRecTemplate2: key: '6' id: Daily_Rate_Auto href: /objects/contracts/revenue-template/6 expenseTemplate1: key: '1' id: Exp_Daily_Auto href: /objects/contracts/expense-template/1 expenseTemplate2: key: '1' id: Exp_Daily_Auto href: /objects/contracts/expense-template/1 isDefaultBundle: false contractFairValueCategory: key: '6' id: Miscellaneous on demand services defaultContractDeliveryStatus: delivered defaultContractDeferralStatus: deferRevenueUntilItemIsDelivered substituteItemId: '' inventory: shippingWeight: 120 glGroup: incomeGLAccount: '1300' expenseGLAccount: '1200' inventoryGLAccount: '1500' cogsGLAccount: '1200' arGLAccountNumber: '1400' apGLAccountNumber: '1100' deferredRevenueGLAccountNumber: '1250' defaultRevenueRecognitionTemplate: '' id: Auto GL Group autoPrintLabel: false dateLastSold: '2023-12-15' dateLastReceived: '2023-12-16' sales: isTaxable: true taxGroup: id: Goods Standard Rate key: '6' href: /objects/tax/item-tax-group/19 taxSolution: id: United Kingdom - VAT key: '3' href: /objects/tax/tax-solution/3 isAvailableForDropShip: false isAvailableForBuyToOrder: false basePrice: '1300' allowMultiPleTaxGroups: false costMethod: standard purchasing: standardCost: '1200' unitOfMeasureGroup: id: Count key: '1' href: /objects/inventory-control/unit-of-measure-group/1 notes: Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver) precision: inventoryPrecision: 10 purchasingPrecision: 10 salesPrecision: 10 upc: '2' itemType: inventory tracking: enableSerialNo: true serialMask: '' enableLotCategory: false lotCategory: '' enableBins: false enableExpiration: false kitRevenuePosting: null kitRevenuePrinting: null vsoeCategory: productSpecified vsoeDefaultDeliveryStatus: delivered vsoeDefaultDeferralStatus: deferUntilItemIsDelivered contractTerm: isStartDateAndEndDateEnabled: false periodsMeasuredIn: weeks numberOfPeriods: 99 isProratedPricingAllowed: false defaultRenewalTemplate: id: SUBInvoiceSameAsOriginalPrcie key: '18' landedCost: enableLandedCost: true audit: createdDateTime: '2023-12-15T10:53:10Z' modifiedDateTime: '2023-12-15T10:53:10Z' createdBy: '1' modifiedBy: '1' quantityOnOrder: '2' quantityOnHand: '2' quantityOnHold: '1' quantityAllocated: '0' quantityReserved: '0' quantityUncommitted: '0' quantityInTransit: '0' replenishment: enableReplenishment: true replenishmentMethod: reorderPoint unitOfMeasureDefault: Each reorderPoint: 1 safetyStock: 1 reorderQuantity: 1 maximumOrderQuantity: 10 measurements: weightUnitOfMeasure: id: Grams key: '15' href: /objects/inventory-control/unit-of-measure/15 netWeight: 500 lengthWidthHeightUnitOfMeasure: id: inch key: '8' href: /objects/inventory-control/unit-of-measure/8 length: 12.4554 width: 12 height: 12 thicknessUnitOfMeasure: id: inch key: '8' href: /objects/inventory-control/unit-of-measure/8 thickness: 2 minimumThickness: 1 maximumThickness: 3 areaUnitOfMeasure: id: Square Inch key: '37' href: /objects/inventory-control/unit-of-measure/37 area: 12 volumeUnitOfMeasure: id: Cubic Centimeters key: '28' href: /objects/inventory-control/unit-of-measure/28 volume: 22 diameterUnitOfMeasure: id: inch key: '8' href: /objects/inventory-control/unit-of-measure/8 innerDiameter: 15 outerDiameter: 16 durometerUnitOfMeasure: '22' densityUnitOfMeasure: grams per cubic centimeter density: 22 itemDetails: universalProductCode: 123456789123 internationalArticleNumber: 1234567891234 isSafetyItem: true isRestrictedItem: false isCompliantItem: false condition: Good engineeringAlert: Verification of Item specification1: Dell Inspiration 15 inch LED specification2: '' specification3: '' isApprovedByEngineering: true isApprovedByQualityControl: true isApprovedBySales: true primaryCountryOfOrigin: USA commercial: brand: Dell Inspiron subBrand: Dell 15 inch category: Dell 15.6 XPS 15 subCategory: Dell 15.6 XPS 15 catalogReference: Dell 15.6 XPS 15 Multi color: Silver style: 15 inch multi touch size1: '12' size2: '12' isGiftCard: false isWebEnabled: true webName: Dell Inspiration 15 inch LED webShortDiscription: Dell Inspiration 15 inch LED webLongDescription: Dell Inspiration 15 inch LED defaultConversionType: quantity enableFulfillment: false isEnabledForContracts: false itemVendor: - id: '84' key: '84' item: id: Dell_15_6_XPS_15_Multi_Touch_1 key: '2458' href: /objects/inventory-control/item/2458 vendor: id: vendorId-1702543576--vendorId-1702543576 key: '2386' href: /objects/accounts-payable/vendor/2386 stockNumber: '#5678901234' leadTime: 15 demandForecastDuringLeadTime: 5 economicalOrderQuantity: 10 vendorMinimumOrderQuantity: 10 bestPrice: '1000.00' latestPrice: '1100.00' unitOfMeasure: id: Each key: '3' href: /objects/inventory-control/unit-of-measure/3 conversionFactor: '1' isPreferredVendor: true href: /objects/inventory-control/item-vendor/84 warehouseInfo: - id: '80' key: '80' item: key: '2458' id: Dell_15_6_XPS_15_Multi_Touch_1 href: /objects/inventory-control/item/2458 warehouse: key: '2' id: WH02 href: /objects/inventory-control/warehouse/2 storageArea: Bella inventoryCycle: key: '' id: '' standardCost: '1200.00' lastCost: '1500.00' averageCost: '1450.00' reorderMethod: null economicOrderQuantity: 10 reorderPoint: 1 reorderQuantity: 10 minOrderQuantity: 10 maxOrderQuantity: 100 maximumStock: 300 minimumStock: 50 lastSoldDate: '2024-12-01' lastReceivedDate: '2023-12-12' defaultBin: id: '' key: '' onOrder: 2 inTransit: 0 onHand: 2 onHold: 1 reserved: 0 allocated: 0 unCommitted: 0 warehouseLocation: key: '' currency: '' id: '' safetyStock: 20 replenishmentMethod: reorderPoint enableReplenishment: true standardCostEntries: [] itemWarehouseVendor: [] href: '/objects/inventory-control/item-warehouse-inventory/80' kitComponents: [] itemLandedCost: - id: '74' key: '74' item: id: Dell_15_6_XPS_15_Multi_Touch_1 key: '2458' href: /objects/inventory-control/item/2458 distributionMethod: count distributionMethodBaseUnit: Each landedCostValue: '1.000000000' active: false href: /objects/inventory-control/item-landed-cost/74 - id: '75' key: '75' item: id: Dell_15_6_XPS_15_Multi_Touch_1 key: '2458' href: /objects/inventory-control/item/2458 distributionMethod: volume distributionMethodBaseUnit: Teaspoon landedCostValue: '' active: false href: /objects/inventory-control/item-landed-cost/75 - id: '76' key: '76' item: id: Dell_15_6_XPS_15_Multi_Touch_1 key: '2458' href: /objects/inventory-control/item/2458 distributionMethod: weight distributionMethodBaseUnit: Ounce landedCostValue: '' active: false href: /objects/inventory-control/item-landed-cost/76 href: /objects/inventory-control/item/2458 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' operationId: get-inventory-control-item-key security: - OAuth2: [] patch: summary: Update an item description: >- Updates an existing item by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Items operationId: update-inventory-control-item-key responses: '200': description: OK content: application/json: schema: type: object title: Updated item properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated item: value: ia::result: key: '2458' id: Dell_15_6_XPS_15_Multi_Touch href: /objects/inventory-control/item/104 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item' - type: object properties: id: readOnly: true costMethod: readOnly: true itemType: readOnly: true examples: Update an item: value: description: >- 12th Gen Core™ i3-1215U (10 MB cache, 6 cores, 8 threads, up to 4.40 GHz Turbo) itemLandedCost: - key: '74' distributionMethod: count landedCostValue: '1.000000000' active: true security: - OAuth2: [] delete: summary: Delete an item description: Deletes an item. tags: - Inventory_Control_Items operationId: delete-inventory-control-item-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/item-gl-group: get: summary: List item GL groups description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each item GL group. 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
SubscriptionInventory Control
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsList, View Item GL groups
tags: - Inventory_Control_Item GL groups responses: '200': description: OK content: application/json: schema: type: object title: List of item GL group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List item GL groups: value: ia::result: - key: '2' id: OS GL Group href: /objects/inventory-control/item-gl-group/2 - key: '3' id: Auto GL Group href: /objects/inventory-control/item-gl-group/3 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' operationId: list-inventory-control-item-gl-group security: - OAuth2: [] post: summary: Create an item GL group description: >+ Creates a new item GL group.
Permissions and other requirements
SubscriptionInventory Control
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsAdd, Edit Item GL groups
tags: - Inventory_Control_Item GL groups operationId: create-inventory-control-item-gl-group responses: '201': description: Created content: application/json: schema: type: object title: New item-gl-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New item GL group: value: ia::result: key: '13' id: Stockable Kit href: /objects/inventory-control/item-gl-group/13 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item-gl-group' - $ref: '#/components/schemas/inventory-control-item-gl-groupRequiredProperties' examples: Create an item GL group: value: id: Stockable Kit deferredRevenueGLAccount: key: '411' id: '1501.04' name: Expense Account defaultRevenueRecognitionTemplate: key: '1' id: '100' security: - OAuth2: [] /objects/inventory-control/item-gl-group/{key}: parameters: - schema: type: string name: key in: path required: true example: '13' description: System-assigned key for the item GL group. get: summary: Get an item GL group description: >+ Returns detailed information for a specified item GL group.
Permissions and other requirements
SubscriptionInventory Control
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsList, View Item GL groups
tags: - Inventory_Control_Item GL groups responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/inventory-control-item-gl-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an item GL group: value: key: '13' id: Stockable Kit deferredRevenueGLAccount: key: '411' id: '1501.04' name: Expense Account href: /objects/general-ledger/account/411 defaultRevenueRecognitionTemplate: key: '1' id: '100' href: '/objects/accounts-receivable/revenue-recognition-template/1' isSystemGenerated: false href: /objects/inventory-control/item-gl-group/13 audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' '400': description: Bad Request operationId: get-inventory-control-item-gl-group-key security: - OAuth2: [] patch: summary: Update an item GL group description: >+ Updates an existing item GL group by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionInventory Control
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsAdd, Edit Item GL groups
tags: - Inventory_Control_Item GL groups operationId: update-inventory-control-item-gl-group-key responses: '200': description: OK content: application/json: schema: type: object title: Updated item-gl-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated item GL group: value: ia::result: key: '13' id: Stockable Kit href: /objects/inventory-control/item-gl-group/13 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item-gl-group' - $ref: '#/components/schemas/inventory-control-item-gl-groupRequiredProperties' - type: object properties: id: readOnly: true example: Stockable Kit examples: Update an item GL group: value: id: '13' deferredRevenueGLAccount: key: '411' id: '1501.04' name: Expense Account security: - OAuth2: [] delete: summary: Delete an item GL group description: >+ Deletes a item GL group. An item GL group can be deleted if it has not been used by any transactions or assigned to any items.
Permissions and other requirements
SubscriptionInventory Control
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsDelete Item GL groups
tags: - Inventory_Control_Item GL groups operationId: delete-inventory-control-item-gl-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/item-warehouse-inventory: get: summary: List item warehouse inventory information objects description: >+ Returns a collection with a key, ID, and link for each item warehouse inventory information 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
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsList, View Items
tags: - Inventory_Control_Item warehouse inventory information responses: '200': description: OK content: application/json: schema: type: object title: List of item-warehouse-inventory objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List item warehouse information objects: value: ia::result: - key: '1' id: '1' href: /objects/inventory-control/item-warehouse-inventory/1 - key: '2' id: '2' href: /objects/inventory-control/item-warehouse-inventory/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' operationId: list-inventory-control-item-warehouse-inventory security: - OAuth2: [] post: summary: Create an item warehouse inventory information object description: >+ Creates a new item warehouse inventory information object.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsAdd, Edit Items
tags: - Inventory_Control_Item warehouse inventory information operationId: create-inventory-control-item-warehouse-inventory responses: '201': description: Created content: application/json: schema: type: object title: New item warehouse info properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a new item warehouse information object: value: key: '1' id: '1' href: /objects/inventory-control/item-warehouse-inventory/1 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item-warehouse-inventory' - $ref: '#/components/schemas/inventory-control-item-warehouse-inventoryRequiredProperties' examples: New item warehouse information object: value: id: '1' item: key: '9' id: Prnt_Paper warehouse: key: '1' id: WH10001 storageArea: bin inventoryCycle: key: '2' id: Daily Cycle economicOrderQuantity: 10 standardCost: '110' lastCost: '100' averageCost: '100' reorderMethod: economicQuantity reorderPoint: 121 reorderQuantity: 10 minOrderQuantity: 10 maxOrderQuantity: 100 maximumStock: 300 minimumStock: 50 lastSoldDate: '2022-04-08' lastReceivedDate: '2022-04-10' safetyStock: 20 replenishmentMethod: reorderPoint enableReplenishment: true security: - OAuth2: [] /objects/inventory-control/item-warehouse-inventory/{key}: parameters: - schema: type: string name: key in: path required: true description: >- System-assigned unique key for the item warehouse inventory information. example: '1' get: summary: Get item warehouse inventory information description: >+ Returns detailed information for a specified item warehouse inventory object.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsList, View Items
tags: - Inventory_Control_Item warehouse inventory information responses: '200': description: OK content: application/json: schema: type: object title: Details of the item warehouse inventory properties: ia::result: $ref: '#/components/schemas/inventory-control-item-warehouse-inventory' ia::meta: $ref: '#/components/schemas/metadata' examples: Get warehouse inventory information: value: ia::result: key: '1' id: '1' item: key: '9' id: Prnt_Paper href: /objects/inventory-control/item/9 warehouse: key: '1' id: WH10001 href: /objects/inventory-control/warehouse/1 storageArea: bin inventoryCycle: key: '2' id: Daily Cycle href: /objects/inventory-control/cycle/2 economicOrderQuantity: 10 standardCost: '110' lastCost: '100' averageCost: '100' reorderMethod: economicQuantity reorderPoint: 121 reorderQuantity: 10 minOrderQuantity: 10 maxOrderQuantity: 100 maximumStock: 300 minimumStock: 50 lastSoldDate: '2022-04-08' lastReceivedDate: '2022-04-10' defaults: bin: key: '45' id: '45' href: /objects/inventory-control/bin/45 warehouseCurrency: key: '3' id: LOC-USA-0778 currency: USD href: /objects/location-entity/3 safetyStock: 20 replenishmentMethod: reorderPoint enableReplenishment: true onOrder: 100 inTransit: 50 onHand: 200 onHold: 10 reserved: 0 allocated: 0 unCommitted: 0 href: /objects/inventory-control/item-warehouse-inventory/1 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' operationId: get-inventory-control-item-warehouse-inventory-key security: - OAuth2: [] patch: summary: Update item warehouse inventory information description: >+ Updates an existing item warehouse inventory information object by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsAdd, Edit Items
operationId: update-inventory-control-item-warehouse-inventory-key tags: - Inventory_Control_Item warehouse inventory information responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated item warehouse information: value: ia::result: key: '41' id: '41' href: /objects/inventory-control/item-warehouse-inventory/41 ia::meta: totalCount: 1 application/xml: schema: type: object properties: {} multipart/form-data: schema: type: object properties: {} requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item-warehouse-inventory' - type: object properties: id: readOnly: true example: 41 item: readOnly: true examples: Update a single value: value: storageArea: Bin 5 security: - OAuth2: [] delete: summary: Delete item warehouse inventory information description: >+ Deletes an item warehouse inventory information object.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsDelete Items
tags: - Inventory_Control_Item warehouse inventory information operationId: delete-inventory-control-item-warehouse-inventory-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/row: get: summary: List rows description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each row. 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
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Rows
tags: - Inventory_Control_Rows operationId: list-inventory-control-row responses: '200': description: OK content: application/json: schema: type: object title: List of row objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List rows: value: ia::result: - key: '354' id: R1ADW href: /objects/inventory-control/row/354 - key: '355' id: R1BDW href: /objects/inventory-control/row/355 - key: '356' id: R2ADW href: /objects/inventory-control/row/356 ia::meta: totalCount: 3 start: 1 pageRow: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a row description: >+ Creates a new row.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Add Rows
tags: - Inventory_Control_Rows operationId: create-inventory-control-row requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-row' - $ref: '#/components/schemas/inventory-control-rowRequiredProperties' examples: Create a row: value: id: R3ADW description: Row 3A Dishwashers responses: '201': description: Created content: application/json: schema: type: object title: New row properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a row: value: ia::result: key: '543' id: R3ADW href: /objects/inventory-control/row/543 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/row/{key}: parameters: - schema: type: string example: '354' name: key in: path required: true description: System-assigned key for the row. get: summary: Get a row description: >+ Returns detailed information for a specified row.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Rows
tags: - Inventory_Control_Rows operationId: get-inventory-control-row-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the row properties: ia::result: $ref: '#/components/schemas/inventory-control-row' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a row: value: ia::result: key: '354' id: R3ADW description: Row 3 A Dishwashers audit: createdDateTime: '2021-05-07T01:15:23Z' modifiedDateTime: '2021-05-07T01:15:23Z' createdBy: '13' modifiedBy: '13' href: /objects/inventory-control/row/354 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a row description: >+ Updates an existing row by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Edit Rows
tags: - Inventory_Control_Rows operationId: update-inventory-control-row-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-row' - type: object properties: id: readOnly: true examples: Update a single value: value: description: Row 3A1 Dishwashers responses: '200': description: OK content: application/json: schema: type: object title: Updated row properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: key: '2' id: R3ADW href: /objects/inventory-control/row/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a row description: >+ Deletes a row. You can delete a row if it is not being used and you no longer need it. Deleted rows cannot be recovered.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Delete Rows
tags: - Inventory_Control_Rows operationId: delete-inventory-control-row-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/unit-of-measure-group: get: summary: List all unit of measure groups description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each unit of measure group. 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
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Unit of Measure groups
tags: - Inventory_Control_Unit of measure groups operationId: list-inventory-control-unit-of-measure-group responses: '200': description: OK content: application/json: schema: type: object title: List of unit of measure group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List unit of measure groups: value: ia::result: - key: '17' id: Data storage href: /objects/inventory-control/unit-of-measure-group/17 - key: '11' id: Count href: /objects/inventory-control/unit-of-measure-group/11 - key: '12' id: Length href: /objects/inventory-control/unit-of-measure-group/12 - key: '13' id: Weight href: /objects/inventory-control/unit-of-measure-group/13 - key: '14' id: Volume href: /objects/inventory-control/unit-of-measure-group/14 - key: '15' id: Area href: /objects/inventory-control/unit-of-measure-group/15 - key: '16' id: Time href: /objects/inventory-control/unit-of-measure-group/16 ia::meta: totalCount: 7 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a unit of measure group description: >+ Creates a new custom unit of measure group.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
ConfigurationInventory Control, Order Entry, or Purchasing must be enabled for custom units of measure to add, edit, or delete unit of measure groups.
User ypeBusiness
PermissionsList, View, Add Unit of Measure groups
tags: - Inventory_Control_Unit of measure groups operationId: create-inventory-control-unit-of-measure-group requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-unit-of-measure-group' - $ref: '#/components/schemas/inventory-control-unit-of-measure-groupRequiredProperties' - type: object properties: defaults: readOnly: true example: {} examples: Create a unit of measure group: value: id: Data storage baseUnit: Gigabytes abbreviation: GB unitsOfMeasure: - id: Terabytes abbreviation: TB conversionFactor: 1000 numberOfDecimalPlaces: 2 - id: Petabytes abbreviation: PB conversionFactor: 100000 numberOfDecimalPlaces: 2 responses: '201': description: Created content: application/json: schema: type: object title: New Unit of measure group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New unit of measure group: value: ia::result: key: '17' id: Data storage href: /objects/inventory-control/unit-of-measure-group/17 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/unit-of-measure-group/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned unique key for the unit of measure group. example: '11' get: summary: Get a unit of measure group description: >+ Returns detailed information for a specified unit of measure group.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Unit of Measure groups
tags: - Inventory_Control_Unit of measure groups operationId: get-inventory-control-unit-of-measure-group-key responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/inventory-control-unit-of-measure-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a unit of measure group: value: key: '11' id: Count baseUnit: Each abbreviation: null defaults: inventory: key: '13' id: Each href: /objects/inventory-control/unit-of-measure/13 purchaseOrder: key: '13' id: Each href: /objects/inventory-control/unit-of-measure/13 orderEntry: key: '13' id: Each href: /objects/inventory-control/unit-of-measure/13 unitsOfMeasure: - key: '13' id: Each abbreviation: null numberOfDecimalPlaces: null isBase: true parent: key: '11' id: Count href: /objects/inventory-control/unit-of-measure-group/11 conversionFactor: 1 href: /objects/inventory-control/unit-of-measure/13 - key: '14' id: Pair abbreviation: null numberOfDecimalPlaces: null isBase: false parent: key: '11' id: Count href: /objects/inventory-control/unit-of-measure-group/11 conversionFactor: 2 href: /objects/inventory-control/unit-of-measure/14 - key: '15' id: Dozen abbreviation: null numberOfDecimalPlaces: null isBase: false parent: key: '11' id: Count href: /objects/inventory-control/unit-of-measure-group/11 conversionFactor: 12 href: /objects/inventory-control/unit-of-measure/15 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' href: /objects/inventory-control/unit-of-measure-group/11 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2014-01-08T11:28:12Z' createdBy: '1' modifiedBy: '95' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a unit of measure group description: >+ Updates an existing unit of measure group by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
ConfigurationInventory Control, Order Entry, or Purchasing must be enabled for custom units of measure to add, edit, or delete unit of measure groups.
User ypeBusiness
PermissionsList, View, Edit Unit of Measure groups
tags: - Inventory_Control_Unit of measure groups operationId: update-inventory-control-unit-of-measure-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-unit-of-measure-group' - type: object properties: id: example: Each readOnly: true examples: Update a single value: value: defaults: inventory: key: '3' responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated unit of measure group: value: ia::result: key: '17' id: Data Storage href: /objects/inventory-control/unit-of-measure-group/17 ia::meta: totalCount: 1 security: - OAuth2: [] delete: summary: Delete a unit of measure group description: >+ Deletes a unit of measure group. Unit of measure groups that come with Sage Intacct such as Length,Time, Area, and Count cannot be deleted. Only custom unit of measure groups that are not in use can be deleted.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
ConfigurationInventory Control, Order Entry, or Purchasing must be enabled for custom units of measure to add, edit, or delete unit of measure groups.
User ypeBusiness
PermissionsList, View, Delete Unit of Measure groups
tags: - Inventory_Control_Unit of measure groups operationId: delete-inventory-control-unit-of-measure-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/unit-of-measure: get: summary: List unit of measure objects description: >+ Returns a collection with a key, ID, and link for each unit of measure. This operation is mostly for use in testing; use the [query service](/openapi/inv/inventory-control-unit-of-measure/tag/Units-of-measure/#tag/Unit-of-measure/operation/post-services-core-query-inventory-control-unit-of-measure) to find units of measure that meet certain criteria and to specify the properties that you want in the response.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Units of Measure
tags: - Inventory_Control_Units of measure responses: '200': description: OK content: application/json: schema: type: object title: List of unit of measure objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List units of measure: value: ia::result: - key: '135' id: GigaBytes href: /objects/inventory-control/unit-of-measure/135 - key: '136' id: KiloBytes href: /objects/inventory-control/unit-of-measure/136 - key: '137' id: MegaBytes href: /objects/inventory-control/unit-of-measure/137 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' operationId: list-inventory-control-unit-of-measure security: - OAuth2: [] post: summary: Create a unit of measure description: >+ Create one or more custom units of measure within an existing unit of measure group.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
ConfigurationInventory Control, Order Entry, Purchasing must be enabled for custom units of measure to add, edit, or delete units of measure.
User ypeBusiness
PermissionsList, View, Add Units of Measure
tags: - Inventory_Control_Units of measure operationId: create-inventory-control-unit-of-measure requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-unit-of-measure' - $ref: '#/components/schemas/inventory-control-unit-of-measureRequiredProperties' - type: object properties: defaults: readOnly: true example: {} examples: Create a unit of measure: value: id: GigaBytes abbreviation: GB numberOfDecimalPlaces: 0 parent: key: '17' conversionFactor: 1024 responses: '201': description: Created content: application/json: schema: type: object title: New Unit of measure properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New unit of measure: value: ia::result: key: '135' href: /objects/unit-of-measure/135 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/unit-of-measure/{key}: parameters: - schema: type: string name: key in: path required: true example: '135' description: System-assigned unique key for the unit of measure. get: summary: Get a unit of measure description: >+ Returns detailed information for a specified unit of measure.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Units of Measure
tags: - Inventory_Control_Units of measure responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/inventory-control-unit-of-measure' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a unit of measure: value: ia::result: key: '135' id: GigaBytes abbreviation: GB parent: key: '17' id: ComputerStorage href: /objects/inventory-control-unit-of-measure/17 conversionFactor: 1024 numberOfDecimalPlaces: 0 isBase: false audit: createdDateTime: '2021-09-15T16:46:11Z' modifiedDateTime: '2021-09-15T16:46:11Z' createdBy: '1' modifiedBy: '1' href: /objects/inventory-control/unit-of-measure/135 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': description: Bad Request operationId: get-inventory-control-unit-of-measure-key security: - OAuth2: [] patch: summary: Update a unit of measure description: >+ Updates an existing custom unit of measure by setting field values. Any fields not provided remain unchanged. Units of measure already in use cannot be modified.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
ConfigurationInventory Control, Order Entry, or Purchasing must be enabled for custom units of measure to add, edit, or delete units of measure.
User ypeBusiness
PermissionsList, View, Edit Units of Measure
tags: - Inventory_Control_Units of measure operationId: update-inventory-control-unit-of-measure-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-unit-of-measure' - type: object properties: id: readOnly: true examples: Update a unit of measure: value: abbreviation: GB responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated unit of measure: value: ia::result: key: '135' href: /objects/inventory-control/unit-of-measure/135 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 security: - OAuth2: [] delete: summary: Delete a unit of measure description: >+ Deletes a unit of measure. Units of measure that are provided with Sage Intacct and included in default unit of measure groups such as Time, Area, and Count cannot be deleted. Only custom units of measure that are not in use can be deleted.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
ConfigurationInventory Control, Order Entry, or Purchasing must be enabled for custom units of measure to add, edit, or delete unit of measure groups.
User ypeBusiness
PermissionsList, View, Delete Units of Measure
tags: - Inventory_Control_Units of measure operationId: delete-inventory-control-unit-of-measure-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/warehouse: get: summary: List warehouses description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each warehouse. 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
SubscriptionInventory Control
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Warehouses
tags: - Inventory_Control_Warehouses operationId: list-inventory-control-warehouse responses: '200': description: OK content: application/json: schema: type: object title: List of warehouse objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List warehouses: value: ia::result: - key: '5' id: '103' href: /objects/inventory-control/warehouse/5 - key: '8' id: '101' href: /objects/inventory-control/warehouse/8 - key: '9' id: '100' href: /objects/inventory-control/warehouse/9 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a warehouse description: >+ Creates a new warehouse. For a warehouse hierarchy, create the parent warehouses before adding child warehouses.
Permissions and other requirements
SubscriptionInventory Control
User ypeBusiness
PermissionsList, View, Add Warehouses
tags: - Inventory_Control_Warehouses operationId: create-inventory-control-warehouse requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-warehouse' - $ref: '#/components/schemas/inventory-control-warehouseRequiredProperties' examples: Create a warehouse: value: id: childId2 name: child2 location: id: 1--Chicago parent: id: 101--Distribution Center manager: id: 1--Courtney, Bill contacts: primary: id: Sam Smith shipTo: id: Bill North status: active isReplenishmentEnabled: true responses: '201': description: Created content: application/json: schema: type: object title: New warehouse properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New warehouse: value: ia::result: key: '12' id: '103' href: /objects/inventory-control/warehouse/12 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/warehouse/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned unique key for the warehouse. get: summary: Get a warehouse description: >+ Returns detailed information for a specified warehouse.
Permissions and other requirements
SubscriptionInventory Control
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Warehouses
tags: - Inventory_Control_Warehouses operationId: get-inventory-control-warehouse-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the warehouse properties: ia::result: $ref: '#/components/schemas/inventory-control-warehouse' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a warehouse: value: ia::result: key: '3' name: US NA Warehouse-1 id: USNAWA1 parent: id: US NA--1 key: '22' href: /objects/inventory-control/warehouse/22 location: id: North America--North America key: '10' href: /objects/company-config/location/10 manager: id: EM 1--Aman key: '14' href: /objects/company-config/employee/14 contacts: primary: id: Sam Smith key: '210' href: /objects/company-config/contact/210 shipTo: id: Bill North key: '229' href: /objects/company-config/contact/229 status: active isReplenishmentEnabled: true enableNegativeInv: false href: /objects/inventory-control/warehouse/15 audit: createdDateTime: '2021-04-21T23:57:50Z' modifiedDateTime: '2021-04-21T23:59:40Z' createdBy: '1' modifiedBy: '1' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a warehouse description: >+ Updates an existing warehouse by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionInventory Control
User ypeBusiness
PermissionsList, View, Edit Warehouses
tags: - Inventory_Control_Warehouses operationId: update-inventory-control-warehouse-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-warehouse' - type: object properties: id: readOnly: true examples: Update a single value: value: manager: id: 2--Lapus, Alan responses: '200': description: OK content: application/json: schema: type: object title: Updated warehouse properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated warehouse: value: ia::result: key: '9' id: US NA Warehouse-2 href: /objects/inventory-control/warehouse/9 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a warehouse description: >+ Deletes a warehouse.
Permissions and other requirements
SubscriptionInventory Control
User ypeBusiness
PermissionsList, View, Delete Warehouses
tags: - Inventory_Control_Warehouses operationId: delete-inventory-control-warehouse-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/zone: get: summary: List zones description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each zone. 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
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Zones
tags: - Inventory_Control_Zones operationId: list-inventory-control-zone responses: '200': description: OK content: application/json: schema: type: object title: List of zone objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List zones: value: ia::result: - key: '546' id: RZ1A href: /objects/inventory-control/zone/546 - key: '547' id: RZ2A href: /objects/inventory-control/zone/547 - key: '548' id: RZ3A href: /objects/inventory-control/zone/548 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 2 previous: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a zone description: >+ Creates a new zone.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Add Zones
tags: - Inventory_Control_Zones operationId: create-inventory-control-zone requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-zone' - $ref: '#/components/schemas/inventory-control-zoneRequiredProperties' examples: Create a zone: value: id: Z2 description: Refrigeration zone 2 responses: '201': description: Created content: application/json: schema: type: object title: New zone properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New zone: value: ia::result: key: '546' id: RZ2 href: /objects/inventory-control/zone/546 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/zone/{key}: parameters: - schema: type: string example: '564' name: key in: path required: true description: System-assigned unique key for the zone. get: summary: Get a zone description: >+ Returns detailed information for a specified zone.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Zones
tags: - Inventory_Control_Zones operationId: get-inventory-control-zone-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the zone properties: ia::result: $ref: '#/components/schemas/inventory-control-zone' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a zone: value: ia::result: key: '564' id: RZ2 description: Refrigeration zone 2 audit: createdDateTime: '2021-05-07T01:15:23Z' modifiedDateTime: '2021-05-07T01:15:23Z' createdBy: '13' modifiedBy: '13' href: /objects/inventory-control/zone/564 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a zone description: >+ Updates an existing zone by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Edit Zones
tags: - Inventory_Control_Zones operationId: update-inventory-control-zone-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-zone' - type: object properties: id: readOnly: true examples: Update a single value: value: description: Refrigeration zone 2A responses: '200': description: OK content: application/json: schema: type: object title: Updated zone properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated zone: value: ia::result: key: '564' id: RZ2 href: /objects/inventory-control/zone/564 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a zone description: >+ Deletes a zone. You can delete a zone if it is not being used and you no longer need it. Deleted zones cannot be recovered.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows is enabled.
User ypeBusiness
PermissionsList, View, Delete Zones
tags: - Inventory_Control_Zones operationId: delete-inventory-control-zone-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/product-line: get: summary: List product lines description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each product 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
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Product Lines
tags: - Inventory_Control_Product lines operationId: list-inventory-control-product-line responses: '200': description: OK content: application/json: schema: type: object title: List product line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List product lines: value: ia::result: - key: '23' id: Adapters href: /objects/inventory-control/product-line/23 - key: '25' id: Telephones href: /objects/inventory-control/product-line/25 - key: '29' id: Auto Product Line href: /objects/inventory-control/product-line/29 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a product line description: >+ Creates a new product line.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness
PermissionsList, View, Add Product Lines
tags: - Inventory_Control_Product lines operationId: create-inventory-control-product-line requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-product-line' - $ref: '#/components/schemas/inventory-control-product-lineRequiredProperties' examples: Create a product line: value: id: OCA description: Other Computer Accessories parent: id: PCCS responses: '201': description: Created content: application/json: schema: type: object title: New product-line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New product line: value: ia::result: key: '26' id: OCA href: /objects/inventory-control/product-line/26 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/product-line/{key}: parameters: - name: key description: System-assigned key for the product line. in: path required: true schema: type: string get: summary: Get a product line description: >+ Returns detailed information for a specified product line.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness, CRM, Employee, Warehouse
PermissionsList, View Product Lines
tags: - Inventory_Control_Product lines operationId: get-inventory-control-product-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the product line properties: ia::result: $ref: '#/components/schemas/inventory-control-product-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a product line: value: ia::result: key: '25' id: Telephones description: Telephones parent: id: Adapters key: '28' href: /objects/inventory-control/product-line/28 status: active audit: createdDateTime: '2017-04-27T17:29:36Z' modifiedDateTime: '2022-03-15T14:40:30Z' createdBy: '1' modifiedBy: '1' href: /objects/inventory-control/product-line/25 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a product line description: >+ Updates an existing product line by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness
PermissionsList, View, Edit Product Lines
tags: - Inventory_Control_Product lines operationId: update-inventory-control-product-line-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-product-line' - type: object properties: id: readOnly: true examples: Update a single value: value: description: Telephones for US markets responses: '200': description: OK content: application/json: schema: type: object title: Updated product-line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated product line: value: ia::result: key: '25' id: Telephones href: /objects/inventory-control/product-line/25 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a Product line description: >+ Deletes a product line.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
User ypeBusiness
PermissionsList, View, Delete Product Lines
tags: - Inventory_Control_Product lines operationId: delete-inventory-control-product-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/item-cross-reference: get: summary: List item cross references description: >+ Returns a collection with a key, ID, and link for each item cross reference.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, Purchasing
User ypeEmployee, Business, Project Manager, Warehouse
PermissionsList, View Item cross references
tags: - Inventory_Control_Item cross references operationId: list-inventory-control-item-cross-reference responses: '200': description: OK content: application/json: schema: type: object title: List item cross reference objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List item cross references: value: ia::result: - key: '1' id: '1' href: /objects/inventory-control/item-cross-reference/1 - key: '2' id: '2' href: /objects/inventory-control/item-cross-reference/2 - key: '3' id: '3' href: /objects/inventory-control/item-cross-reference/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an item cross reference description: >+ Creates a new item cross reference.
Permissions and other requirements
SubscriptionInventory Control, Order Entry
User ypeBusiness
PermissionsAdd, List, View Item cross references
tags: - Inventory_Control_Item cross references operationId: create-inventory-control-item-cross-reference requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item-cross-reference' - $ref: '#/components/schemas/inventory-control-item-cross-referenceRequiredProperties' examples: Create an item cross reference: value: item: key: '649' alternateItem: key: '64' unitOfMeasure: key: '3' referenceType: substitute responses: '201': description: Created content: application/json: schema: type: object title: New item-cross-reference properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New item cross reference: value: ia::result: key: '6' id: '6' href: /objects/inventory-control/item-cross-reference/6 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/item-cross-reference/{key}: parameters: - name: key description: System-assigned unique key for the item cross reference. in: path required: true schema: type: string get: summary: Get an item cross reference description: >+ Returns detailed information for a specified item cross reference.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, Purchasing
User ypeEmployee, Business, Project Manager, Warehouse
PermissionsList, View Item cross references
tags: - Inventory_Control_Item cross references operationId: get-inventory-control-item-cross-reference-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the item cross reference properties: ia::result: $ref: '#/components/schemas/inventory-control-item-cross-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an internal item cross reference: value: ia::result: key: '6' id: '6' referenceType: substitute referenceTypeContext: internal item: key: '649' id: Logitech-MK830 name: MK830 Keyboard and Mouse Combo href: /objects/inventory-control/item/649 alternateItem: key: '64' id: Logitech-MK825 name: MK825 Keyboard and Mouse Combo href: /objects/inventory-control/item/64 vendor: key: null id: null name: null customer: key: null id: null name: null itemAliasId: null itemAliasDescription: null unitOfMeasure: key: '3' id: Each href: /objects/inventory-control/unit-of-measure/3 href: /objects/inventory-control/item-cross-reference/6 audit: createdDateTime: '2023-11-09T06:20:34Z' modifiedDateTime: '2023-11-09T07:02:22Z' createdBy: '1' modifiedBy: '22' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Get an external item cross reference: value: ia::result: key: '7' id: '7' referenceType: customer referenceTypeContext: external item: key: '649' id: Logitech-MK830 name: MK830 Keyboard and Mouse Combo href: /objects/inventory-control/item/649 alternateItem: key: null id: null name: null vendor: key: null id: null name: null customer: key: '20' id: C00012 name: Future Products Inc href: /objects/accounts-receivable/customer/20 itemAliasId: Logitech-MK830 itemAliasDescription: Logitech-MK800 series keyboard and mouse combo unitOfMeasure: key: '3' id: Each href: /objects/inventory-control/unit-of-measure/3 href: /objects/inventory-control/item-cross-reference/7 audit: createdDateTime: '2023-11-09T06:20:34Z' modifiedDateTime: '2023-11-09T07:02:22Z' createdBy: '1' modifiedBy: '22' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an item cross reference description: >+ Updates an existing item cross reference by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionInventory Control, Order Entry
User ypeBusiness
PermissionsEdit, List, View Item cross references
tags: - Inventory_Control_Item cross references operationId: update-inventory-control-item-cross-reference-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item-cross-reference' - type: object properties: referenceType: readOnly: true examples: Update an item cross reference: value: alternateItem: key: '10' unitOfMeasure: key: '3' responses: '200': description: OK content: application/json: schema: type: object title: Updated item cross reference properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated item cross reference: value: ia::result: key: '6' id: '6' href: /objects/inventory-control/item-cross-reference/6 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an item cross reference description: >+ Deletes an item cross reference. An item cross reference can be deleted if it hasn't been used in a transaction. Deleting an item cross reference removes it from the system so that it cannot be recovered.
Permissions and other requirements
SubscriptionInventory Control, Order Entry
User ypeBusiness
PermissionsEdit, List, View Item cross references
tags: - Inventory_Control_Item cross references operationId: delete-inventory-control-item-cross-reference-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/item-landed-cost: get: summary: List item landed costs description: >+ Returns a collection with a key, ID, and link for each item landed cost.
Permissions and other requirements
SubscriptionInventory Control
User ypeBusiness
PermissionsList, View Item landed cost
tags: - Inventory_Control_Item landed costs operationId: list-inventory-control-item-landed-cost responses: '200': description: OK content: application/json: schema: type: object title: List item landed cost objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List item landed costs: value: ia::result: - key: '25' id: '25' href: /objects/inventory-control/item-landed-cost/25 - key: '26' id: '26' href: /objects/inventory-control/item-landed-cost/26 - key: '27' id: '27' href: /objects/inventory-control/item-landed-cost/27 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/item-landed-cost/{key}: parameters: - name: key description: System-assigned unique key for the item landed cost. in: path required: true schema: type: string get: summary: Get an item landed cost description: >+ Returns detailed information for a specified item landed cost.
Permissions and other requirements
SubscriptionInventory Control
User ypeBusiness
PermissionsList, View Item landed cost
tags: - Inventory_Control_Item landed costs operationId: get-inventory-control-item-landed-cost-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the item-landed-cost properties: ia::result: $ref: '#/components/schemas/inventory-control-item-landed-cost' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an item landed cost: value: ia::result: key: '87' id: '87' item: id: Dell Touch Screen key: '234' href: /objects/inventory-control/item/234 distributionMethod: weight distributionMethodBaseUnit: Ounce landedCostValue: '24.000000000' active: true href: /objects/inventory-control/item-landed-cost/87 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/item-vendor: get: summary: List item vendors description: >+ Returns a collection with a key, ID, and link for each item vendor.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, Purchasing
User ypeEmployee, Business, Project Manager, Warehouse
PermissionsList, View Items
tags: - Inventory_Control_Item vendors responses: '200': description: OK content: application/json: schema: type: object title: List of item vendor objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List item vendors: value: ia::result: - key: '5' id: '5' href: /objects/inventory-control/item-vendor/5 - key: '6' id: '6' href: /objects/inventory-control/item-vendor/6 - key: '7' id: '7' href: /objects/inventory-control/item-vendor/7 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' operationId: list-inventory-control-item-vendor security: - OAuth2: [] /objects/inventory-control/item-vendor/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned unique key for the item vendor. example: '5' get: summary: Get an item vendor description: >+ Returns detailed information for a specified item vendor.
Permissions and other requirements
SubscriptionInventory Control, Order Entry, Purchasing
User ypeEmployee, Business, Project Manager, Warehouse
PermissionsList, View Items
tags: - Inventory_Control_Item vendors responses: '200': description: OK content: application/json: schema: type: object title: Details of the item vendor properties: ia::result: $ref: '#/components/schemas/inventory-control-item-vendor' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an item vendor: value: ia::result: key: '5' id: '5' item: key: '13' id: Phones href: /objects/inventory-control/item/13 vendor: key: '38' id: Office_Supplies href: /objects/accounts-payable/vendor/38 stockNumber: '#5678901234' leadTime: 15 demandForecastDuringLeadTime: 5 economicalOrderQuantity: 10 vendorMinimumOrderQuantity: 10 bestPrice: '100' latestPrice: '110' unitOfMeasure: key: '38' id: Each href: /objects/inventory-control/unit-of-measure/38 conversionFactor: '1' isPreferredVendor: false ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' operationId: get-inventory-control-item-vendor-key security: - OAuth2: [] /objects/inventory-control/item-warehouse-standard-cost: get: summary: List item warehouse standard costs description: >- Returns a collection with a key, ID, and link for each item warehouse standard cost. tags: - Inventory_Control_Item warehouse standard costs operationId: list-inventory-control-item-warehouse-standard-cost responses: '200': description: OK content: application/json: schema: type: object title: List of item-warehouse-standard-cost objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of item warehouse standard costs: value: ia::result: - key: '21' id: '21' href: '/objects/inventory-control/item-warehouse-standard-cost/21' - key: '24' id: '24' href: '/objects/inventory-control/item-warehouse-standard-cost/24' ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an item warehouse standard cost description: Creates a new item warehouse standard cost. tags: - Inventory_Control_Item warehouse standard costs operationId: create-inventory-control-item-warehouse-standard-cost requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item-warehouse-standard-cost' - $ref: '#/components/schemas/inventory-control-item-warehouse-standard-costRequiredProperties' examples: Creates an item warehouse standard cost: value: effectiveStartDate: '2021-01-23' standardCost: '21' itemWarehouse: key: '13' responses: '201': description: Created content: application/json: schema: type: object title: New item-warehouse-standard-cost properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Creates an item warehouse standard cost: value: ia::result: key: '23' id: '23' href: '/objects/inventory-control/item-warehouse-standard-cost/23' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/item-warehouse-standard-cost/{key}: parameters: - name: key description: system-assigned unique key for the item warehouse standard cost. in: path required: true schema: type: string get: summary: Get an item warehouse standard cost description: >- Returns detailed information for a particular item warehouse standard cost. tags: - Inventory_Control_Item warehouse standard costs operationId: get-inventory-control-item-warehouse-standard-cost-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the item-warehouse-standard-cost properties: ia::result: $ref: '#/components/schemas/inventory-control-item-warehouse-standard-cost' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the item warehouse standard cost: value: ia::result: key: '23' id: '23' effectiveStartDate: '2021-01-23' standardCost: '122' itemWarehouse: key: '13' id: '13' itemId: LapTop Kit 1 warehouseId: WS001 href: /objects/inventory-control/item-warehouse-inventory/13 href: '/objects/inventory-control/item-warehouse-standard-cost/23' audit: createdDateTime: '2021-05-07T21:30:03Z' modifiedDateTime: '2021-05-07T21:30:03Z' createdBy: '13' modifiedBy: '13' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an item warehouse standard cost description: >- Updates an existing item warehouse standard cost by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Item warehouse standard costs operationId: update-inventory-control-item-warehouse-standard-cost-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item-warehouse-standard-cost' - type: object examples: Updates an item warehouse standard cost: value: standardCost: '125' responses: '200': description: OK content: application/json: schema: type: object title: Updated item-warehouse-standard-cost properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated item warehouse standard cost: value: ia::result: key: '23' id: '23' href: '/objects/inventory-control/item-warehouse-standard-cost/23' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an item warehouse standard cost description: Deletes an item warehouse standard cost. tags: - Inventory_Control_Item warehouse standard costs operationId: delete-inventory-control-item-warehouse-standard-cost-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/item-warehouse-vendor: get: summary: List item warehouse vendors description: >- Returns a collection with a key, ID, and link for each item warehouse vendor. tags: - Inventory_Control_Item warehouse vendors operationId: list-inventory-control-item-warehouse-vendor responses: '200': description: OK content: application/json: schema: type: object title: List of item-warehouse-vendor objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of item warehouse vendors: value: ia::result: - key: '21' id: '21' href: /objects/inventory-control/item-warehouse-vendor/21 - key: '22' id: '22' href: /objects/inventory-control/item-warehouse-vendor/22 ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an item warehouse vendor description: Creates a new item warehouse vendor. tags: - Inventory_Control_Item warehouse vendors operationId: create-inventory-control-item-warehouse-vendor requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item-warehouse-vendor' - $ref: '#/components/schemas/inventory-control-item-warehouse-vendorRequiredProperties' examples: Creates an item warehouse vendor: value: itemWarehouse: key: '12' vendor: key: '122' stockNumber: '#5678901234' unitOfMeasure: key: '38' leadTime: 15 demandForecastDuringLeadTime: 5 economicalOrderQuantity: 10 vendorMinimumOrderQuantity: 10 isPreferredVendor: true responses: '201': description: Created content: application/json: schema: type: object title: New item-warehouse-vendor properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New item warehouse vendor: value: ia::result: key: '66' id: '66' href: /objects/inventory-control/item-warehouse-vendor/66 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/item-warehouse-vendor/{key}: parameters: - name: key description: system-assigned unique key for the item warehouse vendor. in: path required: true schema: type: string get: summary: Get an item warehouse vendor description: Returns detailed information for a particular item warehouse vendor. tags: - Inventory_Control_Item warehouse vendors operationId: get-inventory-control-item-warehouse-vendor-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the item-warehouse-vendor properties: ia::result: $ref: '#/components/schemas/inventory-control-item-warehouse-vendor' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the item warehouse vendor: value: ia::result: id: '66' key: '66' itemWarehouse: id: '76' key: '76' href: /objects/item-warehouse-inventory/76 vendor: id: vendorId-1702552731 key: '2387' href: /objects/vendor/2387 stockNumber: '#5678901234' leadTime: 15 demandForecastDuringLeadTime: 5 economicalOrderQuantity: 10 vendorMinimumOrderQuantity: 10 bestPrice: '112.23' latestPrice: '112.23' unitOfMeasure: key: '38' id: Each href: /objects/inventory-control/unit-of-measure/38 conversionFactor: '1' isPreferredVendor: true href: /objects/inventory-control/item-warehouse-vendor/66 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an item warehouse vendor description: >- Updates an existing item warehouse vendor by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Item warehouse vendors operationId: update-inventory-control-item-warehouse-vendor-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item-warehouse-vendor' - type: object examples: Updates an item warehouse vendor: value: stockNumber: '#5678901234222' leadTime: 15 demandForecastDuringLeadTime: 5 economicalOrderQuantity: 10 vendorMinimumOrderQuantity: 10 isPreferredVendor: true responses: '200': description: OK content: application/json: schema: type: object title: Updated item-warehouse-vendor properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated item warehouse vendor: value: ia::result: key: '66' id: '66' href: /objects/inventory-control/item-warehouse-vendor/66 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an item warehouse vendor description: Deletes an item warehouse vendor. tags: - Inventory_Control_Item warehouse vendors operationId: delete-inventory-control-item-warehouse-vendor-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/kit-component: get: summary: List kit components description: Returns a collection with a key, ID, and link for each kit component. tags: - Inventory_Control_Kit components responses: '200': description: OK content: application/json: schema: type: object title: List of Kit Components objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: example-1: value: ia::result: - key: '1' id: '1' href: /object/kit-component/1 - key: '2' id: '2' href: /object/kit-component/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' operationId: list-inventory-control-kit-component security: - OAuth2: [] post: summary: Create a kit component description: Creates a new kit component. tags: - Inventory_Control_Kit components operationId: create-inventory-control-kit-component responses: '201': description: Created content: application/json: schema: type: object title: New Item with kit Components properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New kit component: value: ia::result: key: '1' id: '1' href: /objects/inventory-control/kit-component/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-kit-component' - $ref: '#/components/schemas/inventory-control-kit-componentRequiredProperties' examples: Create a kit component: value: kit: key: '1' component: key: '2' revenuePercentage: 90 defaultDeliveryStatus: undelivered defaultDeferralStatus: deferUntilItemIsDelivered numberOfUnits: 1 security: - OAuth2: [] /objects/inventory-control/kit-component/{key}: parameters: - schema: type: string example: '1' name: key in: path required: true description: System-assigned key for the kit-component. get: summary: Get a kit component description: Returns detailed information for a particular kit component. tags: - Inventory_Control_Kit components responses: '200': description: OK content: application/json: schema: type: object title: Details of the kit-component properties: ia::result: $ref: '#/components/schemas/inventory-control-kit-component' ia::meta: $ref: '#/components/schemas/metadata' examples: example-1: value: ia::result: key: '1' id: '1' kit: key: '27' id: Kit_1 href: /objects/inventory-control/item/27 component: key: '10' id: Prnt_Paper name: Paper for Printer costMethod: standard itemType: inventory unitOfMeasure: 10 Pack standardCost: '100' href: /objects/inventory-control/item/10 numberOfUnits: 1 revenuePercentage: 10 defaultDeliveryStatus: delivered defaultDeferralStatus: deferUntilItemIsDelivered lineNumber: 1 href: /objects/inventory-control/kit-component/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' operationId: get-inventory-control-kit-component-key security: - OAuth2: [] patch: summary: Update a kit component description: >- Updates an existing kit component by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Kit components operationId: update-inventory-control-kit-component-key responses: '200': description: OK content: application/json: schema: type: object title: Updated Kit Component properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: example-1: value: ia::result: key: '1' id: '1' href: /objects/inventory-control/kit-component/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-kit-component' - type: object properties: id: readOnly: true examples: example-1: value: component: key: '10' numberOfUnits: 1 security: - OAuth2: [] delete: summary: Delete a kit component description: Deletes a kit component. tags: - Inventory_Control_Kit components operationId: delete-inventory-control-kit-component-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/lot-category: get: summary: List lot categories description: Returns a collection with a key, ID, and link for each lot category. tags: - Inventory_Control_Lot categories responses: '200': description: OK content: application/json: schema: type: object title: List of lot category objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List lot category objects: value: ia::result: - key: '2' id: Medi-Lot href: /objects/inventory-control/lot-category/2 - key: '3' id: Chemical-Lot href: /objects/inventory-control/lot-category/3 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' operationId: list-inventory-control-lot-category security: - OAuth2: [] post: summary: Create a lot category description: Creates a new lot category. tags: - Inventory_Control_Lot categories operationId: create-inventory-control-lot-category responses: '201': description: Created content: application/json: schema: type: object title: New lot category properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New lot category: value: ia::result: key: '2' id: Medi-Lot href: /objects/inventory-control/lot-category/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-lot-category' - $ref: '#/components/schemas/inventory-control-lot-categoryRequiredProperties' examples: Create a lot category: value: id: Medi-Lot name: Medical Item Lot security: - OAuth2: [] /objects/inventory-control/lot-category/{key}: parameters: - schema: type: string example: '2' name: key in: path required: true description: System-assigned unique key for the lot category. get: summary: Get a lot category description: Returns detailed information for a specified lot category. tags: - Inventory_Control_Lot categories responses: '200': description: OK content: application/json: schema: type: object title: Details of the lot category properties: ia::result: $ref: '#/components/schemas/inventory-control-lot-category' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a lot category: value: ia::result: key: '2' id: Medi-Lot name: Medical Item Lot href: /objects/inventory-control/lot-category/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' operationId: get-inventory-control-lot-category-key security: - OAuth2: [] patch: summary: Update a lot category description: >- Updates an existing lot category by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Lot categories operationId: update-inventory-control-lot-category-key responses: '200': description: OK content: application/json: schema: type: object title: Updated lot-category properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated lot category: value: ia::result: key: '2' id: Medi-Lot href: /objects/inventory-control/lot-category/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-lot-category' - type: object properties: id: readOnly: true examples: Update a lot category: value: name: Medical Item Lot security: - OAuth2: [] delete: summary: Delete a lot-category description: Deletes a lot category. tags: - Inventory_Control_Lot categories operationId: delete-inventory-control-lot-category-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/price-list: get: summary: List inventory price lists description: >- Returns a collection with a key, ID, and link for each inventory 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. tags: - Inventory_Control_Inventory price lists responses: '200': description: OK content: application/json: schema: type: object title: List inventory 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/inventory-control/price-list/1 - key: '2' id: Initial Purchase Cost href: /objects/inventory-control/price-list/2 - key: '3' id: Initial Sales Price href: /objects/inventory-control/price-list/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' operationId: list-inventory-control-price-list security: - OAuth2: [] post: summary: Create an inventory price list description: Creates a new inventory price list. tags: - Inventory_Control_Inventory price lists operationId: create-inventory-control-price-list responses: '201': description: Created content: application/json: schema: type: object title: New inventory-price-list properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New price list: value: ia::result: key: '1' id: Base Price List href: /objects/inventory-control/price-list/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-price-list' - $ref: '#/components/schemas/inventory-control-price-listRequiredProperties' examples: Create a price list: value: id: Base Price List startDate: '2015-01-01' endDate: '2022-01-01' appliesTo: orderEntry status: active security: - OAuth2: [] /objects/inventory-control/price-list/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the inventory price list. example: '1' get: summary: Get an inventory price list description: Returns detailed information for a specified inventory price list. tags: - Inventory_Control_Inventory price lists responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory-price-list properties: ia::result: $ref: '#/components/schemas/inventory-control-price-list' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an inventory price list: value: ia::result: key: '1' id: Base Price List href: /objects/inventory-control/price-list/1 startDate: '2000-01-01' endDate: '2100-12-31' appliesTo: orderEntry status: active ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' operationId: get-inventory-control-price-list-key security: - OAuth2: [] patch: summary: Update an inventory price list description: >- Updates an existing inventory price list by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Inventory price lists operationId: update-inventory-control-price-list-key responses: '200': description: OK content: application/json: schema: type: object title: Updated inventory-price-list properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated price list: value: ia::result: key: '1' id: Base Price List href: /objects/inventory-control/price-list/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-price-list' - type: object properties: id: readOnly: true example: '1' examples: Update a price list: value: startDate: '2018-02-01' security: - OAuth2: [] delete: summary: Delete an inventory price list description: Deletes an inventory price list. tags: - Inventory_Control_Inventory price lists operationId: delete-inventory-control-price-list-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/price-schedule: get: summary: List inventory price schedules description: >- Returns a collection with a key, ID, and link for each inventory price schedule. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Inventory_Control_Inventory price schedules responses: '200': description: OK content: application/json: schema: type: object title: List of inventory-price-schedule objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' '400': $ref: '#/components/responses/400error' operationId: list-inventory-control-price-schedule security: - OAuth2: [] post: summary: Create an inventory price schedule description: Creates a new inventory price schedule. tags: - Inventory_Control_Inventory price schedules operationId: create-inventory-control-price-schedule responses: '201': description: Created content: application/json: schema: type: object title: New inventory-price-schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New inventory price schedule: value: ia::result: key: '1' id: S1 href: /objects/inventory-control/price-schedule/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-price-schedule' - $ref: '#/components/schemas/inventory-control-price-scheduleRequiredProperties' examples: Create an inventory price schedule: value: id: S1 description: Inventory Price Schedule 1 priceList: id: '1' discountPercent: '' status: active security: - OAuth2: [] /objects/inventory-control/price-schedule/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned unique key for the inventory price schedule. get: summary: Get an inventory price schedule description: Returns detailed information for a specified inventory price schedule. tags: - Inventory_Control_Inventory price schedules responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory-price-schedule properties: ia::result: $ref: '#/components/schemas/inventory-control-price-schedule' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' operationId: get-inventory-control-price-schedule-key security: - OAuth2: [] patch: summary: Update an inventory price schedule description: >- Updates an existing inventory price schedule by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Inventory price schedules operationId: update-inventory-control-price-schedule-key responses: '200': description: OK content: application/json: schema: type: object title: Updated inventory-price-schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-price-schedule' - type: object properties: id: readOnly: true security: - OAuth2: [] delete: summary: Delete an inventory price schedule description: Deletes an inventory price schedule. tags: - Inventory_Control_Inventory price schedules operationId: delete-inventory-control-price-schedule-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/total: get: summary: List inventory totals description: >+ Returns a collection with a key, ID, and link for each inventory total.
Permissions and other requirements
SubscriptionInventory Control
User ypeBusiness, Employee, Warehouse
PermissionsList, View Inventory totals
tags: - Inventory_Control_Inventory totals operationId: list-inventory-control-total responses: '200': description: OK content: application/json: schema: type: object title: List inventory total objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List inventory total objects: value: ia::result: - key: '51' id: ONORDER href: /objects/inventory-control/total/51 - key: '52' id: ONHAND href: /objects/inventory-control/total/52 - key: '53' id: ONHOLD href: /objects/inventory-control/total/53 - key: '54' id: REQUESITIONED href: /objects/inventory-control/total/54 - key: '55' id: DAMAGED href: /objects/inventory-control/total/55 - key: '56' id: SCRAP OR SPOILAGE href: /objects/inventory-control/total/56 - key: '57' id: ALLOCATED href: /objects/inventory-control/total/57 - key: '58' id: RESERVED href: /objects/inventory-control/total/58 - key: '59' id: INTRANSIT href: /objects/inventory-control/total/59 ia::meta: totalCount: 9 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an inventory total description: >+ Creates a new inventory total.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows must be enabled to add inventory totals
User ypeBusiness
PermissionsList, View, Add Inventory totals
tags: - Inventory_Control_Inventory totals operationId: create-inventory-control-total requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-total' - $ref: '#/components/schemas/inventory-control-totalRequiredProperties' examples: Create an inventory total: value: id: SHIPPED status: active responses: '201': description: Created content: application/json: schema: type: object title: New inventory total properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New inventory total: value: ia::result: key: '60' id: SHIPPED href: /objects/inventory-control/total/60 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/total/{key}: parameters: - name: key description: System-assigned unique key for the inventory total. in: path required: true schema: type: string get: summary: Get an inventory total description: >+ Returns detailed information for a specified inventory total.
Permissions and other requirements
SubscriptionInventory Control
User ypeBusiness, Employee, Warehouse
PermissionsList, View Inventory totals
tags: - Inventory_Control_Inventory totals operationId: get-inventory-control-total-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory total properties: ia::result: $ref: '#/components/schemas/inventory-control-total' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an inventory total: value: ia::result: key: '60' id: SHIPPED status: active updateType: accumulative href: /objects/inventory-control/total/60 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an inventory total description: >+ Updates an existing inventory total by setting field values. Any fields not provided remain unchanged. User-defined totals can be edited, but only the status of preset inventory totals can be edited. To prevent a preset inventory total from being selected in a transaction definition, change its status to `inactive`.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows must be enabled to edit inventory totals
User ypeBusiness
PermissionsList, View, Edit Inventory totals
tags: - Inventory_Control_Inventory totals operationId: update-inventory-control-total-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-total' - type: object properties: id: readOnly: true examples: Update an inventory total: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Updated inventory total properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated inventory total: value: ia::result: key: '60' id: SHIPPED href: /objects/inventory-control/total/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an inventory total description: >+ Deletes an inventory total. Only user-defined inventory totals can be deleted.
Permissions and other requirements
SubscriptionInventory Control
ConfigurationAdvanced workflows must be enabled to delete inventory totals
User ypeBusiness
PermissionsList, View, Delete Inventory totals
tags: - Inventory_Control_Inventory totals operationId: delete-inventory-control-total-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/txn-definition: get: summary: List inventory transaction definitions description: >- Returns a collection with a key, ID, and link for each inventory transaction definition. tags: - Inventory_Control_Inventory transaction definitions operationId: list-inventory-control-txn-definition responses: '200': description: OK content: application/json: schema: type: object title: List of inventory-txn-definition objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List inventory transaction definitions: value: ia::result: - key: '715' id: SYS-CC Adjustment Decrease href: /objects/inventory-control/txn-definition/715 - key: '716' id: SYS-CC Adjustment Increase href: /objects/inventory-control/txn-definition/716 - key: '424' id: SYS-LC Estimates Adj Incr href: /objects/inventory-control/txn-definition/424 - key: '425' id: SYS-LC Estimates Rev Adj Decr href: /objects/inventory-control/txn-definition/425 - key: '521' id: SYS-Warehouse In Transit href: /objects/inventory-control/txn-definition/521 - key: '198' id: SYS-Warehouse Transfer Out href: /objects/inventory-control/txn-definition/198 - key: '309' id: SYS-Warehouse Transfer In href: /objects/inventory-control/txn-definition/309 - key: '763' id: SYS-CC Adjustment Damaged href: /objects/inventory-control/txn-definition/763 ia::meta: totalCount: 8 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an inventory transaction definition description: Creates a new inventory transaction definition. tags: - Inventory_Control_Inventory transaction definitions operationId: create-inventory-control-txn-definition requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-txn-definition' - $ref: '#/components/schemas/inventory-control-txn-definitionRequiredProperties' examples: Create an inventory transaction definition: value: id: Adjustment Decrease description: Adjustment Decrease (Quantity - Value) templateType: adjustment workflowCategory: adjustment enableUserOrGroupPermmission: false documentPermissions: editPolicy: all deletePolicy: all createPolicy: newDocumentOrConvert multiEntityRuleForTxn: topLevelOrEntity txnNumbering: numberingSequence: key: '12' preserveSequenceNumbers: false inheritSourceDocumentNumber: false inventoryControl: enableWarnOnLowQty: true warehouseSelectionMethod: sortByID defaultWarehouse: key: '32' accounting: txnPosting: postToGeneralLedger isSubTotalsEnabled: false conversionType: closeTxn pricingAndTerms: initialPriceList: key: '33' specialPriceList: key: '34' userOverrides: allowLocationOverride: true allowDepartmentOverride: true print: documentTemplate: Adjustment_US_Template defaultText: Document template is not selected. status: active inventoryTotalDetail: - operation: subtract inventoryTotal: id: ONHAND maintainType: quantityAndValue inventoryAccountMapping: - txnType: debit glAccount: key: '415' lineNumber: 0 - txnType: credit glAccount: key: '85' lineNumber: 1 reportingCategory: inventoryAdjustment responses: '201': description: Created content: application/json: schema: type: object title: New inventory-txn-definition properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New inventory transaction definition: value: ia::result: key: '833' href: /objects/inventory-control/txn-definition/833 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/txn-definition/{key}: parameters: - name: key description: System-assigned unique key for the inventory transaction definition. in: path required: true schema: type: string get: summary: Get an inventory transaction definition description: >- Returns detailed information for a specified inventory transaction definition. tags: - Inventory_Control_Inventory transaction definitions operationId: get-inventory-control-txn-definition-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory-txn-definition properties: ia::result: $ref: '#/components/schemas/inventory-control-txn-definition' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an inventory transaction definition: value: ia::result: key: '834' id: Adjustment Decrease-dd description: Adjustment Decrease (Quantity - Value) templateType: adjustment workflowCategory: adjustment enableUserOrGroupPermmission: false documentPermissions: editPolicy: all deletePolicy: beforePrinting createPolicy: newDocumentOrConvert multiEntityRuleForTxn: topLevelOnly txnNumbering: numberingSequence: key: '12' id: Adjustment Decrease href: /objects/company-config/document-sequence/23 preserveSequenceNumbers: false inheritSourceDocumentNumber: false inventoryControl: updatesInventory: quantityAndValue increaseOrDecreaseInventory: decrease updatesCost: false enableWarnOnLowQty: true warehouseSelectionMethod: sortByID defaultWarehouse: key: '21' id: ARZ href: /objects/inventory-control/warehouse/21 accounting: txnPosting: postToGeneralLedger isSubTotalsEnabled: false conversionType: closeTxn pricingAndTerms: initialPriceList: id: Base Price List key: '33' href: /objects/inventory-control/price-list/21 specialPriceList: id: Discounted Price key: '34' href: /objects/inventory-control/price-list/21 userOverrides: allowLocationOverride: true allowDepartmentOverride: true print: documentTemplate: Adjustment_US_Template defaultText: Document template is not selected. status: active audit: createdDateTime: '2023-12-09T01:23:56Z' modifiedDateTime: '2023-12-09T02:09:37Z' createdBy: '1' modifiedBy: '1' reportingCategory: inventoryAdjustment inventoryAccountMapping: - id: '1242' key: '1242' inventoryTxnDefinition: key: '834' id: Adjustment Decrease href: /objects/inventory-control/txn-definition/834 itemGLGroup: key: '13' id: Inventory- Computers and parts href: /objects/inventory-control/item-gl-group/13 dimensions: warehouse: key: '21' id: ARZ href: /objects/inventory-control/warehouse/21 department: key: '28' id: Finance name: Finance href: /objects/company-config/department/28 location: key: '22' id: CA name: California href: /objects/company-config/location/22 isOffset: false txnType: debit moduleType: inventory glAccount: id: '5000.03' key: '415' href: /objects/general-ledger/account/415 lineNumber: 0 href: '/objects/inventory-control/txn-definition-cogs-gl-detail/1242' - id: '1243' key: '1243' inventoryTxnDefinition: key: '834' id: Adjustment Decrease href: /objects/inventory-control/txn-definition/834 itemGLGroup: key: '13' id: Inventory- Computers and parts href: /objects/inventory-control/item-gl-group/13 dimensions: warehouse: key: '21' id: ARZ href: /objects/inventory-control/warehouse/21 department: key: '28' id: Finance name: Finance href: /objects/company-config/department/28 location: key: '22' id: CA name: California href: /objects/company-config/location/22 isOffset: false txnType: credit moduleType: inventory glAccount: id: '1400' key: '85' href: /objects/general-ledger/account/85 lineNumber: 1 href: '/objects/inventory-control/txn-definition-cogs-gl-detail/1243' inventoryTotalDetail: - id: '1094' key: '1094' inventoryTxnDefinition: key: '834' id: Adjustment Decrease href: /objects/inventory-control/txn-definition/834 maintainType: quantityAndValue inventoryTotal: id: ONHAND key: '52' href: /objects/inventory-control/total/52 operation: subtract href: '/objects/inventory-control/txn-definition-total-detail/1094' subtotalDetail: [] sourceDocumentDetail: [] entitySettingDetail: [] href: /objects/inventory-control/txn-definition/834 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an inventory transaction definition description: >- Updates an existing inventory transaction definition by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Inventory transaction definitions operationId: update-inventory-control-txn-definition-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-txn-definition' - type: object properties: id: readOnly: true examples: Update an inventory transaction definition: value: workflowCategory: adjustment documentPermissions: editPolicy: all deletePolicy: beforePrinting createPolicy: newDocumentOrConvert multiEntityRuleForTxn: topLevelOnly responses: '200': description: OK content: application/json: schema: type: object title: Updated inventory-txn-definition properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update inventory transaction definition: value: ia::result: key: '833' href: /objects/inventory-control/txn-definition/833 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an inventory transaction definition description: Deletes an inventory transaction definition. tags: - Inventory_Control_Inventory transaction definitions operationId: delete-inventory-control-txn-definition-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/txn-definition-source: get: summary: List inventory transaction definition sources description: >- Returns a collection with a key, ID, and link for each inventory transaction definition source. tags: - Inventory_Control_Inventory transaction definition sources operationId: list-inventory-control-txn-definition-source responses: '200': description: OK content: application/json: schema: type: object title: List of inventory-txn-definition-source objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List inventory transaction definition sources: value: ia::result: - key: '208' id: '208' href: /object/inventory-txn-definition-source/208 - key: '209' id: '209' href: /object/inventory-txn-definition-source/209 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an inventory transaction definition source description: Creates a new inventory transaction definition source. tags: - Inventory_Control_Inventory transaction definition sources operationId: create-inventory-control-txn-definition-source requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-txn-definition-source' - $ref: '#/components/schemas/inventory-control-txn-definition-sourceRequiredProperties' examples: Create an inventory transaction definition source: value: inventoryTxnDefinition: key: '171' convertedFrom: key: '172' responses: '201': description: Created content: application/json: schema: type: object title: New inventory-txn-definition-source properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New inventory transaction definition source: value: ia::result: key: '208' id: '208' href: /objects/inventory-control/txn-definition-source/208 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/txn-definition-source/{key}: parameters: - name: key description: >- System-assigned unique key for the inventory transaction definition source. in: path required: true schema: type: string get: summary: Get an inventory transaction definition source description: >- Returns detailed information for a specified inventory transaction definition source. tags: - Inventory_Control_Inventory transaction definition sources operationId: get-inventory-control-txn-definition-source-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory-txn-definition-source properties: ia::result: $ref: '#/components/schemas/inventory-control-txn-definition-source' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an inventory transaction definition source: value: ia::result: key: '208' id: '208' inventoryTxnDefinition: key: '173' id: Adjustment Decrease href: /objects/inventory-control/txn-definition/172 convertedFrom: key: '172' id: Adjustment Increase href: /objects/inventory-control/txn-definition/173 href: /objects/inventory-control/txn-definition-source/208 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an inventory transaction definition source description: >- Updates an existing inventory transaction definition source by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Inventory transaction definition sources operationId: update-inventory-control-txn-definition-source-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-txn-definition-source' - type: object examples: Update an inventory transaction definition source: value: inventoryTxnDefinition: key: '173' convertedFrom: key: '172' responses: '200': description: OK content: application/json: schema: type: object title: Updated inventory-txn-definition-source properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated inventory transaction definition source: value: ia::result: key: '208' id: '208' href: /objects/inventory-control/txn-definition-source/208 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an inventory transaction definition source description: Deletes an inventory transaction definition source. tags: - Inventory_Control_Inventory transaction definition sources operationId: delete-inventory-control-txn-definition-source-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/txn-definition-cogs-gl-detail: get: summary: List inventory transaction definition COGS GL details description: >- Returns a collection with a key, ID, and link for each inventory transaction definition COGS GL detail. tags: - Inventory_Control_Inventory transaction definition COGS GL details operationId: list-inventory-control-txn-definition-cogs-gl-detail responses: '200': description: OK content: application/json: schema: type: object title: List of inventory-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 inventory transaction definition COGS GL details: value: ia::result: - key: '15' id: '15' href: '/objects/inventory-control/txn-definition-cogs-gl-detail/15' - key: '19' id: '19' href: '/objects/inventory-control/txn-definition-cogs-gl-detail/19' - key: '3' id: '3' href: '/objects/inventory-control/txn-definition-cogs-gl-detail/3' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an inventory transaction definition COGS GL detail description: Creates a new inventory transaction definition COGS GL detail. tags: - Inventory_Control_Inventory transaction definition COGS GL details operationId: create-inventory-control-txn-definition-cogs-gl-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-txn-definition-cogs-gl-detail' - $ref: '#/components/schemas/inventory-control-txn-definition-cogs-gl-detailRequiredProperties' examples: Create an inventory transaction definition COGS GL detail: value: inventoryTxnDefinition: key: '12' itemGLGroup: key: '13' dimensions: warehouse: key: '21' department: key: '28' location: key: '22' txnType: debit glAccount: key: '384' lineNumber: 0 responses: '201': description: Created content: application/json: schema: type: object title: New inventory-txn-definition-cogs-gl-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New inventory transaction definition COGS GL detail: value: ia::result: key: '208' id: '208' href: '/objects/inventory-control/txn-definition-cogs-gl-detail/208' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/txn-definition-cogs-gl-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the inventory transaction definition COGS GL detail. in: path required: true schema: type: string get: summary: Get an inventory transaction definition COGS GL detail description: >- Returns detailed information for a particular inventory transaction definition COGS GL detail. tags: - Inventory_Control_Inventory transaction definition COGS GL details operationId: get-inventory-control-txn-definition-cogs-gl-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory-txn-definition-cogs-gl-detail properties: ia::result: $ref: '#/components/schemas/inventory-control-txn-definition-cogs-gl-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an inventory transaction definition COGS GL detail: value: ia::result: key: '208' id: '208' inventoryTxnDefinition: key: '12' id: Inventory Adjustment href: /objects/inventory-control/txn-definition/12 txnType: debit moduleType: inventory lineNumber: 0 glAccount: key: '384' id: '1501.04' href: /objects/general-ledger/account/384 itemGLGroup: key: '13' id: Inventory- Computers and parts href: /objects/inventory-control/item-gl-group/13 dimensions: warehouse: key: '21' id: ARZ href: /objects/inventory-control/warehouse/21 department: key: '28' id: Finance name: Finance href: /objects/company-config/department/28 location: key: '22' id: CA name: California href: /objects/company-config/location/22 href: '/objects/inventory-control/txn-definition-cogs-gl-detail/208' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an inventory transaction definition COGS GL detail description: >- Updates an existing inventory transaction definition COGS GL detail by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Inventory transaction definition COGS GL details operationId: update-inventory-control-txn-definition-cogs-gl-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-txn-definition-cogs-gl-detail' - type: object examples: Update an inventory txn definition subtotal COGS GL detail: value: glAccount: key: '232' responses: '200': description: OK content: application/json: schema: type: object title: Updated inventory-txn-definition-cogs-gl-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated inventory transaction definition COGS GL detail: value: ia::result: key: '208' id: '208' href: '/objects/inventory-control/txn-definition-cogs-gl-detail/208' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an inventory transaction definition COGS GL detail description: Deletes an inventory transaction definition COGS GL detail. tags: - Inventory_Control_Inventory transaction definition COGS GL details operationId: delete-inventory-control-txn-definition-cogs-gl-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/txn-definition-entity-detail: get: summary: List inventory transaction definition entity details description: >- Returns a collection with a key, ID, and link for each inventory transaction definition entity detail. tags: - Inventory_Control_Inventory transaction definition entity details operationId: list-inventory-control-txn-definition-entity-detail responses: '200': description: OK content: application/json: schema: type: object title: List of inventory-txn-definition-entity-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: example-1: value: ia::result: - key: '223' id: '223' href: /object/inventory-txn-definition-entity-detail/223 - key: '224' id: '224' href: /object/inventory-txn-definition-entity-detail/224 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an inventory transaction definition entity detail description: Creates a new inventory transaction definition entity detail. tags: - Inventory_Control_Inventory transaction definition entity details operationId: create-inventory-control-txn-definition-entity-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-txn-definition-entity-detail' - $ref: '#/components/schemas/inventory-control-txn-definition-entity-detailRequiredProperties' examples: Create an inventory transaction definition entity detail: value: inventoryTxnDefinition: key: '172' entity: key: '1' txnNumbering: preserveSequenceNumbering: true inheritSourceDocumentNumber: false sequenceNumber: key: '30' documentTemplate: id: Intacct Inventory Adjustment responses: '201': description: Created content: application/json: schema: type: object title: New inventory-txn-definition-entity-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New inventory transaction definition entity detail: value: ia::result: key: '225' id: '225' href: '/objects/inventory-control/txn-definition-entity-detail/225' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/txn-definition-entity-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the inventory transaction definition entity detail. in: path required: true schema: type: string get: summary: Get an inventory transaction definition entity detail description: >- Returns detailed information for a specified inventory transaction definition entity detail. tags: - Inventory_Control_Inventory transaction definition entity details operationId: get-inventory-control-txn-definition-entity-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory-txn-definition-entity-detail properties: ia::result: $ref: '#/components/schemas/inventory-control-txn-definition-entity-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an inventory transaction definition entity detail: value: ia::result: key: '225' id: '225' inventoryTxnDefinition: key: '172' id: Adjustment Decrease href: /objects/inventory-control/txn-definition/172 entity: key: '1' id: 1-us href: /objects/company-config/entity/1 txnNumbering: preserveSequenceNumbering: true inheritSourceDocumentNumber: false sequenceNumber: key: '30' id: Inventory_Adjustment href: /objects/company-config/document-sequence/30 documentTemplate: key: '65' id: Intacct Inventory Adjustment href: '/objects/inventory-control/txn-definition-entity-detail/225' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an inventory transaction definition entity detail description: >- Updates an existing inventory transaction definition entity detail by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Inventory transaction definition entity details operationId: update-inventory-control-txn-definition-entity-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-txn-definition-entity-detail' - type: object examples: Update an inventory transaction definition entity detail: value: inventoryTxnDefinition: key: '172' txnNumbering: preserveSequenceNumbering: false responses: '200': description: OK content: application/json: schema: type: object title: Updated inventory-txn-definition-entity-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated inventory transaction definition entity detail: value: ia::result: key: '225' id: '225' href: '/objects/inventory-control/txn-definition-entity-detail/225' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an inventory transaction definition entity detail description: Deletes an inventory transaction definition entity detail. tags: - Inventory_Control_Inventory transaction definition entity details operationId: delete-inventory-control-txn-definition-entity-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/txn-definition-subtotal-detail: get: summary: List inventory transaction definition subtotal details description: >- Returns a collection with a key, ID, and link for each inventory txn definition subtotal detail. tags: - Inventory_Control_Inventory transaction definition subtotal details operationId: list-inventory-control-txn-definition-subtotal-detail responses: '200': description: OK content: application/json: schema: type: object title: List of inventory-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 of inventory txn definition subtotal details: value: ia::result: - key: '15' id: '15' href: '/objects/inventory-control/txn-definition-subtotal-detail/15' - key: '19' id: '19' href: '/objects/inventory-control/txn-definition-subtotal-detail/19' - key: '3' id: '3' href: '/objects/inventory-control/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/an inventory transaction definition subtotal detail description: Creates a new inventory transaction definition subtotal detail. tags: - Inventory_Control_Inventory transaction definition subtotal details operationId: create-inventory-control-txn-definition-subtotal-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-txn-definition-subtotal-detail' - $ref: '#/components/schemas/inventory-control-txn-definition-subtotal-detailRequiredProperties' examples: Creates a/an inventory transaction definition subtotal detail: value: inventoryTxnDefinition: key: '64' subtotalType: discount lineNumber: 0 description: Discount valueType: percent txnType: debit subtotalValue: '10.10' appliedToLineNumber: 1 isTax: false glAccount: key: '10' offsetGLAccount: key: '22' dimensions: department: key: '13' location: key: '11' responses: '201': description: Created content: application/json: schema: type: object title: New inventory-txn-definition-subtotal-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: example-1: value: ia::result: key: '98' id: '98' href: '/objects/inventory-control/txn-definition-subtotal-detail/98' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/txn-definition-subtotal-detail/{key}: parameters: - name: key description: >- system-assigned unique key for the inventory txn definition subtotal detail. in: path required: true schema: type: string get: summary: Get a/an inventory transaction definition subtotal detail description: >- Returns detailed information for a particular inventory txn definition subtotal detail. tags: - Inventory_Control_Inventory transaction definition subtotal details operationId: get-inventory-control-txn-definition-subtotal-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory-txn-definition-subtotal-detail properties: ia::result: $ref: '#/components/schemas/inventory-control-txn-definition-subtotal-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the inventory transaction definition total: value: ia::result: key: '98' id: '98' inventoryTxnDefinition: key: '64' id: Inventory Adjustment href: /objects/inventory-control/txn-definition/64 subtotalType: discount lineNumber: 0 description: Discount valueType: percent subtotalValue: '10.10' txnType: debit appliedLineNumber: '1' isTax: false glAccount: key: '10' id: '1000' href: /objects/general-ledger/account/3 offsetGLAccount: key: '20' id: '1000.01' href: /objects/general-ledger/account/160 dimensions: department: key: '13' id: '8' name: Finance href: /objects/company-config/department/13 location: key: '12' id: CA name: California href: /objects/company-config/location/12 enableAvaTax: false href: '/objects/inventory-control/txn-definition-subtotal-detail/98' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a/an inventory transaction definition subtotal detail description: >- Updates an existing inventory transaction definition subtotal detail by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Inventory transaction definition subtotal details operationId: update-inventory-control-txn-definition-subtotal-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-txn-definition-subtotal-detail' - type: object examples: Updates a/an inventory txn definition subtotal detail: value: inventoryTxnDefinition: key: '64' subtotalType: discount value: '11.00' responses: '200': description: OK content: application/json: schema: type: object title: Updated inventory-txn-definition-subtotal-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: example-1: value: ia::result: key: '98' id: '98' href: '/objects/inventory-control/txn-definition-subtotal-detail/98' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a/an inventory transaction definition subtotal detail description: Deletes a/an inventory transaction definition subtotal detail. tags: - Inventory_Control_Inventory transaction definition subtotal details operationId: delete-inventory-control-txn-definition-subtotal-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/txn-definition-total-detail: get: summary: List inventory transaction definition total details. description: >- Returns a collection with a key, ID, and link for each inventory transaction definition total detail. tags: - Inventory_Control_Inventory transaction definition total details operationId: list-inventory-control-txn-definition-total-detail responses: '200': description: OK content: application/json: schema: type: object title: List of inventory-txn-definition-total-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: example-1: value: ia::result: - key: '208' id: '208' href: '/object/inventory-control/txn-definition-total-detail/208' - key: '209' id: '209' href: '/object/inventory-control/txn-definition-total-detail/209' ia::meta: totalCount: 2 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a/an inventory transaction definition total detail. description: Creates a new inventory transaction definition total detail. tags: - Inventory_Control_Inventory transaction definition total details operationId: create-inventory-control-txn-definition-total-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-txn-definition-total-detail' - $ref: '#/components/schemas/inventory-control-txn-definition-total-detailRequiredProperties' examples: example-1: value: inventoryTotal: key: '51' inventoryTxnDefinition: key: '172' operation: subtract maintainType: quantityAndValue responses: '201': description: Created content: application/json: schema: type: object title: New inventory-txn-definition-total-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: example-1: value: ia::result: key: '208' id: '208' href: '/objects/inventory-control/txn-definition-total-detail/208' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/txn-definition-total-detail/{key}: parameters: - name: key description: >- system-assigned unique key for the inventory transaction definition total. in: path required: true schema: type: string get: summary: Get a/an inventory transaction definition total detail description: >- Returns detailed information for a particular inventory transaction definition total detail. tags: - Inventory_Control_Inventory transaction definition total details operationId: get-inventory-control-txn-definition-total-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory-txn-definition-total-detail properties: ia::result: $ref: '#/components/schemas/inventory-control-txn-definition-total-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: example-1: value: ia::result: key: '208' id: '208' inventoryTxnDefinition: key: '172' id: Adjustment Decrease href: /objects/inventory-control/txn-definition/172 inventoryTotal: key: '51' id: ONHAND href: /objects/inventory-control/total/51 maintainType: quantityAndValue operation: subtract href: '/objects/inventory-control/txn-definition-total-detail/208' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a/an inventory transaction definition total detail. description: >- Updates an existing inventory transaction definition total detail by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Inventory transaction definition total details operationId: update-inventory-control-txn-definition-total-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-txn-definition-total-detail' - type: object examples: example-1: value: inventoryTxnDefinition: key: '172' inventoryTotal: key: '51' maintainType: quantity operation: subtract responses: '200': description: OK content: application/json: schema: type: object title: Updated inventory-txn-definition-total-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: example-1: value: ia::result: key: '208' id: '208' href: '/objects/inventory-control/txn-definition-total-detail/208' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a/an inventory transaction definition total detail. description: Deletes a/an inventory transaction definition total detail. tags: - Inventory_Control_Inventory transaction definition total details operationId: delete-inventory-control-txn-definition-total-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/warehouse-group: get: summary: List warehouse groups description: >- Returns up to 100 object references from the collection with a key, ID, and link for each warehouse group. 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: - Inventory_Control_Warehouse groups operationId: list-inventory-control-warehouse-group responses: '200': description: OK content: application/json: schema: type: object title: List of warehouse-group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of warehouse groups: value: ia::result: - key: '1' id: Top Level warehouses href: /objects/inventory-control/warehouse-group/1 - key: '5' id: warehouses without Activity href: /objects/inventory-control/warehouse-group/5 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a warehouse group description: Creates a new warehouse group. tags: - Inventory_Control_Warehouse groups operationId: create-inventory-control-warehouse-group requestBody: description: Create a new warehouse group required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-warehouse-group' - $ref: '#/components/schemas/inventory-control-warehouse-groupRequiredProperties' examples: Creates a warehouse group: value: id: EastCoastWarehouses name: EastCoast Warehouses description: Warehouses on eastcoast groupType: specific createDimensionComponents: true memberFilter: [] maxMatches: 0 sortField: warehouseId conditionType: and expression: '' sortOrder: ascending groupMembers: - warehouse: id: W1 sortOrder: 0 - warehouse: id: W2 sortOrder: 1 responses: '201': description: Created content: application/json: schema: type: object title: New warehouse group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New warehouse group created: value: ia::result: key: '4' id: EastCoastWarehouses href: /objects/inventory-control/warehouse-group/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/warehouse-group/{key}: parameters: - name: key description: System-assigned unique key for the warehouse group. in: path required: true schema: type: string get: summary: Get a warehouse group description: Returns detailed information for a specified warehouse group. tags: - Inventory_Control_Warehouse groups operationId: get-inventory-control-warehouse-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the warehouse-group properties: ia::result: $ref: '#/components/schemas/inventory-control-warehouse-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a warehouse group: value: ia::result: key: '12' id: BooksWarehouses name: Books Warehouses description: Warehouses store Books groupType: all memberFilter: - field: status operator: equals value: active audit: createdDateTime: '2023-12-12T23:33:05Z' modifiedDateTime: '2023-12-12T23:33:05Z' createdBy: '1' modifiedBy: '1' glAccountGroup: id: BooksWarehouses groupMembers: [] maxMatches: 10 sortField: warehouseId conditionType: and expression: '' sortOrder: ascending href: /objects/inventory-control/warehouse-group/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a warehouse group description: >- Updates an existing warehouse group by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Warehouse groups operationId: update-inventory-control-warehouse-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-warehouse-group' - type: object properties: id: example: 4 readOnly: true examples: Update a single value: value: description: Warehouses store Books and notebooks responses: '200': description: OK content: application/json: schema: type: object title: Updated warehouse-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: key: '12' id: BooksWarehouses href: /objects/inventory-control/warehouse-group/12 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a warehouse group description: >- Deletes a warehouse group. A warehouse group can be deleted if it is not being used for reporting. tags: - Inventory_Control_Warehouse groups operationId: delete-inventory-control-warehouse-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/cycle/{key}: parameters: - name: key description: System-assigned unique key for the inventory cycle. in: path required: true schema: type: string get: summary: Get an inventory cycle description: Returns detailed information for a particular inventory cycle. tags: - Inventory_Control_Inventory cycles operationId: get-inventory-control-cycle-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory-cycle properties: ia::result: $ref: '#/components/schemas/inventory-control-cycle' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/cycle: get: summary: List inventory cycles description: Returns a collection with a key, ID, and link for each inventory cycle. tags: - Inventory_Control_Inventory cycles operationId: list-inventory-control-cycle responses: '200': description: OK content: application/json: schema: type: object title: List of inventory-cycle objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/document: get: summary: List inventory documents description: >- Returns a collection with a key, ID, and link for each inventory document. tags: - Inventory_Control_Inventory Control documents operationId: list-inventory-control-document responses: '200': description: OK content: application/json: schema: type: object title: List of inventory-control-document objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of inventory documents: value: ia::result: - key: '1477' id: SYS-Warehouse Transfer Out-WHXFER-000009-doc-Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/1477' - key: '1478' id: SYS-Warehouse Transfer In-WHXFER-000009-doc-In href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/1478' - key: '298' id: Adjustment Decrease-007 href: '/objects/inventory-control/document::Adjustment%20Decrease/298' - key: '607' id: Beginning Balance-ADJINC0001 href: '/objects/inventory-control/document::Beginning%20Balance/607' ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/document/{key}: parameters: - name: key description: system-assigned unique key for the Inventory Control document. in: path required: true schema: type: string get: summary: Get an Inventory Control document description: >- Returns detailed information for a particular Inventory Control document. tags: - Inventory_Control_Inventory Control documents operationId: get-inventory-control-document-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the Inventory Control document properties: ia::result: $ref: '#/components/schemas/inventory-control-document' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the inventory document: value: ia::result: key: '3903' documentNumber: WHXFER-000033-doc-In id: SYS-Warehouse Transfer In-WHXFER-000033-doc-In sourceDocument: id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out state: closed transactionDate: '2024-02-14' audit: createdDateTime: '2024-02-14T21:43:07Z' createdBy: '1' modifiedBy: '1' modifiedDateTime: '2024-02-14T21:43:08Z' referenceNumber: HAMMER16 weekly transfer documentType: SYS-Warehouse Transfer In txnDefinition: documentType: SYS-Warehouse Transfer In id: SYS-Warehouse Transfer In key: '78' txnDefinitionTemplateClass: INVOICE updatesInventory: quantityAndValue increaseOrDecreaseInventory: increase href: '/objects/inventory-control/txn-definition::SYS-Warehouse%20Transfer%20In/78' warehouse: defaultWarehouse: null memo: CA to AZ transfer inventoryBatch: id: '791' key: '791' journalEntryKey: '1276' href: /objects/inventory-control/batch/791 isPrinted: false subTotal: '0.00' total: '0.00' txnCurrency: USD exchangeRate: date: '2024-02-14' rate: '1.0000' typeId: null typeName: null subtotalInTxnCurrency: '0.00' totalInTxnCurrency: '0.00' baseCurrency: USD lastPrintedDate: null printedBy: key: null id: null isAdjustmentDocument: false lines: - id: '3706' key: '3706' documentHeader: documentNumber: '3903' key: '3903' id: SYS-Warehouse Transfer In-WHXFER-000033-doc-In documentType: SYS-Warehouse Transfer In href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/3903' documentType: SYS-Warehouse Transfer In lineNumber: 0 dimensions: item: key: '907' id: HAMMER16--16oz framing claw hammer name: 16oz framing claw hammer href: /objects/inventory-control/item/907 warehouse: id: WareHouse10005 key: '8' href: /objects/inventory-control/warehouse/8 location: id: '1' key: '6' href: /objects/company-config/location/6 department: id: null key: null project: key: null id: null task: key: null id: null item: key: '907' id: HAMMER16--16oz framing claw hammer href: /objects/inventory-control/item/907 unit: Each memo: null quantity: '25.0000000000' quantityConverted: '0.0000000000' cost: '0.0000000000' totalCost: '0' audit: modifiedDateTime: '2024-02-14T21:43:07Z' createdDateTime: '2024-02-14T21:43:07Z' createdBy: '1' modifiedBy: '1' status: active costMethod: standard unitQuantity: '25.0000000000' multiplier: '1' unitCost: '0.0000000000' extendedCost: '0' sourceDocument: key: '3902' id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out documentType: SYS-Warehouse Transfer Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902' sourceDocumentLine: id: '3705' key: '3705' documentType: SYS-Warehouse Transfer In href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20In/3705' txnCurrency: USD baseCurrency: USD conversionType: quantity quantityRemaining: '25.0000000000' trackingDetail: - id: '3772' key: '3772' inventoryDocumentLine: id: '3706' key: '3706' documentType: SYS-Warehouse Transfer In href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20In/3706' item: id: HAMMER16 key: '907' href: /objects/inventory-control/item/907 quantity: '25.0000000000' serialNumber: null lotNumber: null aisle: key: null id: null row: key: null id: null bin: key: '8' id: B#001 href: /objects/inventory-control/bin/8 expirationDate: null audit: createdDateTime: '2024-02-14T21:43:07Z' modifiedDateTime: '2024-02-14T21:43:07Z' createdBy: '1' modifiedBy: '1' href: '/objects/inventory-control/document-line-detail/3772' href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20In/3706' history: - id: '3123' key: '3123' convertedTo: key: '3902' id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out documentType: SYS-Warehouse Transfer Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902' convertedFrom: id: null documentType: null key: null inventoryDocument: key: '3902' id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out documentType: SYS-Warehouse Transfer Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902' href: /objects/inventory-control/document-history/3123 - id: '3124' key: '3124' convertedTo: key: '3903' id: SYS-Warehouse Transfer In-WHXFER-000033-doc-In documentType: SYS-Warehouse Transfer In href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/3903' convertedFrom: id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out documentType: SYS-Warehouse Transfer Out key: '3902' href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902' inventoryDocument: key: '3902' id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out documentType: SYS-Warehouse Transfer Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902' href: /objects/inventory-control/document-history/3124 attachment: id: null key: null subtotals: - description: SUBTOTAL total: '0.00000000000000' txnTotal: '0.00000000000000' - description: TOTAL total: '0.00000000000000' txnTotal: '0.00000000000000' href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/3903' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/document::{documentName}: get: summary: List named inventory documents description: >- Returns a collection with a key, ID, and link for each inventory document with the specified name. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Inventory_Control_Inventory Control documents operationId: list-inventory-control-named-document responses: '200': description: OK content: application/json: schema: type: object title: List of Inventory Control documents properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of Inventory Control documents: value: ia::result: - key: '1477' id: SYS-Warehouse Transfer Out-WHXFER-000009-doc-Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/1477' - key: '3051' id: SYS-Warehouse Transfer Out-WHXFER-000023-doc-Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3051' - key: '2970' id: SYS-Warehouse Transfer Out-WHXFER-000021-doc-Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/2970' - key: '3166' id: SYS-Warehouse Transfer Out-WHXFER-000024-doc-Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3166' ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an Inventory Control document description: Creates a new Inventory Control document. tags: - Inventory_Control_Inventory Control documents operationId: create-inventory-control-document requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-document' - $ref: '#/components/schemas/inventory-control-documentRequiredProperties' examples: Create an Inventory Control document: value: state: pending transactionDate: '2024-02-14' referenceNumber: HAMMER16 starting quantity memo: Hammers already on hand lines: - unit: Each unitQuantity: '100' unitCost: '10' dimensions: item: id: HAMMER16 warehouse: id: WareHouse10004 location: id: '1' trackingDetail: - quantity: '100' bin: id: B1004-001 responses: '201': description: Created content: application/json: schema: type: object title: New inventory-control-document properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New Inventory document: value: ia::result: key: '13977' id: Beginning Balance-ADJINC0009 href: '/objects/inventory-control/document::Beginning%20Balance/13977' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] parameters: - $ref: '#/components/parameters/documentName' /objects/inventory-control/document::{documentName}/{key}: parameters: - name: key description: System-assigned unique key for the inventory document. in: path required: true schema: type: string - $ref: '#/components/parameters/documentName' get: summary: Get a named Inventory Control document description: Returns detailed information for a specified Inventory Control document. tags: - Inventory_Control_Inventory Control documents operationId: get-inventory-control-named-document-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory-control-document properties: ia::result: $ref: '#/components/schemas/inventory-control-document' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the Inventory Control document: value: ia::result: key: '3903' documentNumber: WHXFER-000033-doc-In id: SYS-Warehouse Transfer In-WHXFER-000033-doc-In sourceDocument: id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out state: closed transactionDate: '2024-02-14' audit: createdDateTime: '2024-02-14T21:43:07Z' createdBy: '1' modifiedBy: '1' modifiedDateTime: '2024-02-14T21:43:08Z' referenceNumber: HAMMER16 weekly transfer documentType: SYS-Warehouse Transfer In txnDefinition: documentType: SYS-Warehouse Transfer In id: SYS-Warehouse Transfer In key: '78' txnDefinitionTemplateClass: INVOICE updatesInventory: quantityAndValue increaseOrDecreaseInventory: increase href: '/objects/inventory-control/txn-definition::SYS-Warehouse%20Transfer%20In/78' warehouse: defaultWarehouse: null memo: CA to AZ transfer inventoryBatch: id: '791' key: '791' journalEntryKey: '1276' href: /objects/inventory-control/batch/791 isPrinted: false subTotal: '0.00' total: '0.00' txnCurrency: USD exchangeRate: date: '2024-02-14' rate: '1.0000' typeId: null typeName: null subtotalInTxnCurrency: '0.00' totalInTxnCurrency: '0.00' baseCurrency: USD lastPrintedDate: null printedBy: key: null id: null isAdjustmentDocument: false lines: - id: '3706' key: '3706' documentHeader: documentNumber: '3903' key: '3903' id: SYS-Warehouse Transfer In-WHXFER-000033-doc-In documentType: SYS-Warehouse Transfer In href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/3903' documentType: SYS-Warehouse Transfer In lineNumber: 0 dimensions: item: key: '907' id: HAMMER16--16oz framing claw hammer name: 16oz framing claw hammer href: /objects/inventory-control/item/907 warehouse: id: WareHouse10005 key: '8' href: /objects/inventory-control/warehouse/8 location: id: '1' key: '6' href: /objects/company-config/location/6 department: id: null key: null project: key: null id: null task: key: null id: null item: key: '907' id: HAMMER16--16oz framing claw hammer href: /objects/inventory-control/item/907 unit: Each memo: null quantity: '25.0000000000' quantityConverted: '0.0000000000' cost: '0.0000000000' totalCost: '0' audit: modifiedDateTime: '2024-02-14T21:43:07Z' createdDateTime: '2024-02-14T21:43:07Z' createdBy: '1' modifiedBy: '1' status: active costMethod: standard unitQuantity: '25.0000000000' multiplier: '1' unitCost: '0.0000000000' extendedCost: '0' sourceDocument: key: '3902' id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out documentType: SYS-Warehouse Transfer Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902' sourceDocumentLine: id: '3705' key: '3705' documentType: SYS-Warehouse Transfer In href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20In/3705' txnCurrency: USD baseCurrency: USD conversionType: quantity quantityRemaining: '25.0000000000' trackingDetail: - id: '3772' key: '3772' inventoryDocumentLine: id: '3706' key: '3706' documentType: SYS-Warehouse Transfer In href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20In/3706' item: id: HAMMER16 key: '907' href: /objects/inventory-control/item/907 quantity: '25.0000000000' serialNumber: null lotNumber: null aisle: key: null id: null row: key: null id: null bin: key: '8' id: B#001 href: /objects/inventory-control/bin/8 expirationDate: null audit: createdDateTime: '2024-02-14T21:43:07Z' modifiedDateTime: '2024-02-14T21:43:07Z' createdBy: '1' modifiedBy: '1' href: '/objects/inventory-control/document-line-detail/3772' href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20In/3706' history: - id: '3123' key: '3123' convertedTo: key: '3902' id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out documentType: SYS-Warehouse Transfer Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902' convertedFrom: id: null documentType: null key: null inventoryDocument: key: '3902' id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out documentType: SYS-Warehouse Transfer Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902' href: /objects/inventory-control/document-history/3123 - id: '3124' key: '3124' convertedTo: key: '3903' id: SYS-Warehouse Transfer In-WHXFER-000033-doc-In documentType: SYS-Warehouse Transfer In href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/3903' convertedFrom: id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out documentType: SYS-Warehouse Transfer Out key: '3902' href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902' inventoryDocument: key: '3902' id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out documentType: SYS-Warehouse Transfer Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902' href: /objects/inventory-control/document-history/3124 attachment: id: null key: null subtotals: - description: SUBTOTAL total: '0.00' txnTotal: '0.00' - description: TOTAL total: '0.00' txnTotal: '0.00' href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/3903' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an Inventory Control document description: >- Updates an existing Inventory Control document by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Inventory Control documents operationId: update-inventory-control-document-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-document' - type: object properties: id: readOnly: true examples: Update an Inventory Control document: value: referenceNumber: Updated quantity and tracking information lines: - key: '3698' unitQuantity: '3' trackingDetail: - key: '3766' quantity: '2' - key: '3767' ia::operation: delete - quantity: '1' lotNumber: Lot#666 responses: '200': description: OK content: application/json: schema: type: object title: Updated inventory-control-document properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated Inventory Control document: value: ia::result: key: '3905' id: Beginning Balance-ADJINC0020 href: '/objects/inventory-control/document::Beginning%20Balance/3905' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an Inventory Control document description: Deletes an Inventory Control document tags: - Inventory_Control_Inventory documents operationId: delete-inventory-control-document-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/document-line: get: summary: List Inventory Control document lines description: >- Returns a collection with a key, ID, and link for each Inventory Control document line. tags: - Inventory_Control_Inventory Control document lines operationId: list-inventory-control-document-line responses: '200': description: OK content: application/json: schema: type: object title: List of inventory-document-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of Inventory Control document lines: value: ia::result: - key: '2905' id: '2905' href: '/objects/inventory-control/document-line::Beginning%20Balance/2905' - key: '3703' id: '3703' href: '/objects/inventory-control/document-line::Adjustment%20Increase%20Value/3703' - key: '2751' id: '2751' href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20Out/2751' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/document-line/{key}: parameters: - name: key description: system-assigned unique key for the Inventory Control document line. in: path required: true schema: type: string get: summary: Get an Inventory Control document line description: >- Returns detailed information for a particular Inventory Control document line. tags: - Inventory_Control_Inventory Control document lines operationId: get-inventory-control-document-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory document line properties: ia::result: $ref: '#/components/schemas/inventory-control-document-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the Inventory Control document line: value: ia::result: id: '3705' key: '3705' documentHeader: documentNumber: '3902' key: '3902' id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out documentType: SYS-Warehouse Transfer Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902' documentType: SYS-Warehouse Transfer Out lineNumber: 0 dimensions: item: key: '907' id: HAMMER16 name: 16oz framing claw hammer href: /objects/inventory-control/item/907 warehouse: id: WareHouse10004 key: '4' href: /objects/inventory-control/warehouse/4 location: id: '1' key: '6' href: /objects/company-config/location/6 department: id: null key: null project: key: null id: null task: key: null id: null item: key: '907' id: HAMMER16 href: /objects/inventory-control/item/907 unit: Each memo: CA to AZ transfer quantity: '25.0000000000' quantityConverted: '25.0000000000' cost: '0.0000000000' totalCost: '0' audit: modifiedDateTime: '2024-02-14T21:43:07Z' createdDateTime: '2024-02-14T21:43:06Z' createdBy: '1' modifiedBy: '1' status: active costMethod: standard unitQuantity: '25.0000000000' multiplier: '1' unitCost: '0.0000000000' extendedCost: '0' sourceDocument: key: null id: null documentType: null sourceDocumentLine: id: null key: null documentType: SYS-Warehouse Transfer Out txnCurrency: USD baseCurrency: USD conversionType: quantity quantityRemaining: '0.0000000000' trackingDetail: - id: '3771' key: '3771' inventoryDocumentLine: id: '3705' key: '3705' documentType: SYS-Warehouse Transfer Out href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20Out/3705' item: id: HAMMER16 key: '907' href: /objects/inventory-control/item/907 quantity: '25.0000000000' serialNumber: '' lotNumber: '' aisle: key: '' id: '' row: key: '' id: '' bin: key: '4' id: B1004-001 href: /objects/inventory-control/bin/4 expirationDate: '' audit: createdDateTime: '2024-02-14T21:43:06Z' modifiedDateTime: '2024-02-14T21:43:06Z' createdBy: '1' modifiedBy: '1' href: /objects/inventory-control/document-line-detail/3771 href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20Out/3705' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/document-line::{documentName}: get: summary: List named Inventory Control document lines description: >- Returns a collection with a key, ID, and link for each named Inventory Control document line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Inventory_Control_Inventory Control document lines operationId: list-inventory-control-named-document-line responses: '200': description: OK content: application/json: schema: type: object title: List of inventory-control-document-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of Inventory Control document lines: value: ia::result: - key: '624' id: '624' href: '/objects/inventory-control/document-line::Beginning%20Balance/624' - key: '3605' id: '3605' href: '/objects/inventory-control/document-line::Beginning%20Balance/3605' - key: '3628' id: '3628' href: '/objects/inventory-control/document-line::Beginning%20Balance/3628' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] parameters: - $ref: '#/components/parameters/documentName' /objects/inventory-control/document-line::{documentName}/{key}: parameters: - name: key description: System-assigned key for the inventory document line. in: path required: true schema: type: string - $ref: '#/components/parameters/documentName' get: summary: Get a named Inventory Control document line description: >- Returns detailed information for a specified Inventory Control document line tags: - Inventory_Control_Inventory Control document lines operationId: get-inventory-control-named-document-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory-control-document-line properties: ia::result: $ref: '#/components/schemas/inventory-control-document-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the Inventory Control document line: value: ia::result: id: '3705' key: '3705' documentHeader: documentNumber: '3902' key: '3902' id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out documentType: SYS-Warehouse Transfer Out href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902' documentType: SYS-Warehouse Transfer Out lineNumber: 0 dimensions: item: key: '907' id: HAMMER16 name: 16oz framing claw hammer href: /objects/inventory-control/item/907 warehouse: id: WareHouse10004 key: '4' href: /objects/inventory-control/warehouse/4 location: id: '1' key: '6' href: /objects/company-config/location/6 department: id: null key: null project: key: null id: null task: key: null id: null item: key: '907' id: HAMMER16 href: /objects/inventory-control/item/907 unit: Each memo: CA to AZ transfer quantity: '25.0000000000' quantityConverted: '25.0000000000' cost: '0.0000000000' totalCost: '0' audit: modifiedDateTime: '2024-02-14T21:43:07Z' createdDateTime: '2024-02-14T21:43:06Z' createdBy: '1' modifiedBy: '1' status: active costMethod: standard unitQuantity: '25.0000000000' multiplier: '1' unitCost: '0.0000000000' extendedCost: '0' sourceDocument: key: null id: null documentType: null sourceDocumentLine: id: null key: null documentType: SYS-Warehouse Transfer Out txnCurrency: USD baseCurrency: USD conversionType: quantity quantityRemaining: '0.0000000000' trackingDetail: - id: '3771' key: '3771' inventoryDocumentLine: id: '3705' key: '3705' documentType: SYS-Warehouse Transfer Out href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20Out/3705' item: id: HAMMER16 key: '907' href: /objects/inventory-control/item/907 quantity: '25.0000000000' serialNumber: '' lotNumber: '' aisle: key: '' id: '' row: key: '' id: '' bin: key: '4' id: B1004-001 href: /objects/inventory-control/bin/4 expirationDate: '' audit: createdDateTime: '2024-02-14T21:43:06Z' modifiedDateTime: '2024-02-14T21:43:06Z' createdBy: '1' modifiedBy: '1' href: /objects/inventory-control/document-line-detail/3771 href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20Out/3705' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/document-subtotal: get: summary: List inventory document subtotals description: >- Returns a collection with a key, ID, and link for each inventory document subtotal. tags: - Inventory_Control_Inventory document subtotals operationId: list-inventory-control-document-subtotal responses: '200': description: OK content: application/json: schema: type: object title: List of inventory-document-subtotal objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of inventory document subtotals: value: ia::result: - key: '13' id: '13' href: /objects/inventory-control/document-subtotal/13 - key: '14' id: '14' href: /objects/inventory-control/document-subtotal/14 - key: '15' id: '15' href: /objects/inventory-control/document-subtotal/15 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/document-subtotal/{key}: parameters: - name: key description: System-assigned unique key for the inventory document subtotal. in: path required: true schema: type: string get: summary: Get an inventory document subtotal description: >- Returns detailed information for a particular inventory document subtotal. tags: - Inventory_Control_Inventory document subtotals operationId: get-inventory-control-document-subtotal-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the inventory-document-subtotal properties: ia::result: $ref: '#/components/schemas/inventory-control-document-subtotal' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the inventory document subtotal: value: ia::result: id: '7902' key: '7902' documentHeader: key: '7808' id: Inventory Receipt-IR-000253 documentType: Inventory Receipt href: '/objects/inventory-control/document::Inventory%20Receipt/7808' description: Freight absoluteValue: '1.20' percentValue: '5.0000000000' total: '1.20000000000000' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 department: key: '' id: '' project: key: '' id: '' name: '' customer: key: '' id: '' name: '' vendor: key: '' id: '' name: '' employee: key: '' id: '' name: '' class: key: '' id: '' name: '' contract: key: '' id: '' name: '' warehouse: key: '3' id: WH10001 name: US AZ Warehouse 10001 href: /objects/inventory-control/warehouse/3 item: key: '749' id: FFSTD name: FF Samples href: /objects/inventory-control/item/749 nsp::product_line1: key: null id: null txnAbsoluteValue: '1.20' txnTotal: '1.20000000000000' documentLine: id: '62991' key: '62991' documentType: Inventory Receipt href: '/objects/inventory-control/document-line::Inventory%20Receipt/62991' audit: createdDateTime: '2023-02-23T19:42:47Z' modifiedDateTime: '2023-02-23T19:42:47Z' createdBy: '1' modifiedBy: '1' nsp::GLDIMREGION: null nsp::GLDIMVERTICAL: null href: /objects/inventory-control/document-subtotal/7902 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/item-group: get: summary: List of item group objects description: >- Returns up to 100 item group references from the collection with a key, ID, and link for each item group. 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: - Inventory_Control_Item groups operationId: list-inventory-control-item-group responses: '200': description: OK content: application/json: schema: type: object title: List of item-group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of item groups: value: ia::result: - key: '1' id: Top Level Items href: /objects/inventory-control/item-group/1 - key: '5' id: Items with Activity href: /objects/inventory-control/item-group/5 - key: '6' id: Costing Group href: /objects/inventory-control/item-group/6 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an item group description: Creates a new item group. tags: - Inventory_Control_Item groups operationId: create-inventory-control-item-group requestBody: description: Create a new item group required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item-group' - $ref: '#/components/schemas/inventory-control-item-groupRequiredProperties' examples: Creates an item group: value: id: InsuranceItemsGroup name: Insurance Items Group description: Items that require insurance groupType: specific createDimensionComponents: true memberFilter: [] maxMatches: 0 sortField: itemId conditionType: and expression: '' sortOrder: ascending groupMembers: - item: id: Monitor-HP sortOrder: 0 - item: id: Monitor-Dell sortOrder: 1 - item: id: Monitor-Asus sortOrder: 2 responses: '201': description: Created content: application/json: schema: type: object title: New item group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New item group created: value: ia::result: key: '14' id: InsuranceItemsGroup href: /objects/inventory-control/item-group/14 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/inventory-control/item-group/{key}: parameters: - name: key description: System-assigned unique key for the item group. in: path required: true schema: type: string get: summary: Get an item group description: Returns detailed information for a specified item group. tags: - Inventory_Control_Item groups operationId: get-inventory-control-item-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the item-group properties: ia::result: $ref: '#/components/schemas/inventory-control-item-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an item group: value: ia::result: key: '12' id: BooksGroup name: BooksGroup description: Group for Books groupType: all memberFilter: - field: productLineId operator: contains value: BK audit: createdDateTime: '2023-12-12T23:33:05Z' modifiedDateTime: '2023-12-12T23:33:05Z' createdBy: '1' modifiedBy: '1' glAccountGroup: id: BooksGroup groupMembers: [] maxMatches: 10 sortField: itemId conditionType: and expression: '' sortOrder: ascending href: /objects/inventory-control/item-group/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an item group description: >- Updates an existing item group by setting field values. Any fields not provided remain unchanged. tags: - Inventory_Control_Item groups operationId: update-inventory-control-item-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/inventory-control-item-group' - type: object properties: id: example: 12 readOnly: true examples: Update a single value: value: description: Group for Reference Books responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: key: '12' id: BooksGroup href: /objects/inventory-control/item-group/12 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an item group description: >- Deletes an item group. An item group can be deleted if it is not being used for reporting. tags: - Inventory_Control_Item groups operationId: delete-inventory-control-item-group-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 ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Price Lists
tags: - Order_Entry_Price lists operationId: list-order-entry-price-list responses: '200': description: OK content: application/json: schema: type: object title: List price list objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List price lists: value: ia::result: - key: '1' id: Base Price List href: /objects/order-entry/price-list/1 - key: '2' id: West Coast Price List href: /objects/order-entry/price-list/2 - key: '3' id: Midwest Price List href: /objects/order-entry/price-list/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a price list description: >+ Creates a new order entry price list.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsAdd Price Lists
tags: - Order_Entry_Price lists operationId: create-order-entry-price-list requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-price-list' - $ref: '#/components/schemas/order-entry-price-listRequiredProperties' examples: Create a price list: value: id: Base Price List Sales startDate: '2023-01-01' endDate: '2030-12-31' status: active responses: '201': description: Created content: application/json: schema: type: object title: New price list properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New price list: value: ia::result: key: '5' id: Base Price List Sales href: /objects/order-entry/price-list/5 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/price-list/{key}: parameters: - name: key description: System-assigned key for the order entry price list. in: path required: true schema: type: string get: summary: Get a price list description: >+ Returns detailed information for a specified order entry price list.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Price Lists
tags: - Order_Entry_Price lists operationId: get-order-entry-price-list-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the price list properties: ia::result: $ref: '#/components/schemas/order-entry-price-list' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a price list: value: ia::result: key: '5' id: Base Price List Sales startDate: '2023-01-01' endDate: '2030-12-31' status: active href: /objects/order-entry/price-list/5 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a price list description: >+ Updates an existing order entry price list by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsEdit Price Lists
tags: - Order_Entry_Price lists operationId: update-order-entry-price-list-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-price-list' - type: object properties: id: readOnly: true examples: Update a single value: value: startDate: '2021-01-01' responses: '200': description: OK content: application/json: schema: type: object title: Updated price list properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated price list: value: ia::result: key: '5' id: Base Price List Sales href: /objects/order-entry/price-list/5 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a price list description: >+ Deletes an order entry price list. A price list can be deleted if it has not been assigned to any objects. This removes the price list and all of its associated price list entries from the system.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsDelete Price Lists
tags: - Order_Entry_Price lists operationId: delete-order-entry-price-list-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document: get: summary: List documents description: >- Returns a collection with a key, ID, and link for each order entry document. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Order_Entry_Documents operationId: list-order-entry-document responses: '200': description: OK content: application/json: schema: type: object title: List of order entry documents properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List documents: value: ia::result: - key: '453' id: Sales Invoice-SUBINV#0182#doc href: /objects/order-entry/document::Sales%20Invoice/453 - key: '442' id: Sales Order-SO0023 href: /objects/order-entry/document::Sales%20Order/442 - key: '446' id: Sales Order-SO0024 href: /objects/order-entry/document::Sales%20Order/446 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the order entry document. get: summary: Get a document description: Returns detailed information for a specified order entry document. tags: - Order_Entry_Documents operationId: get-order-entry-document-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order entry document properties: ia::result: $ref: '#/components/schemas/order-entry-document' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document: value: ia::result: key: '453' documentNumber: SUBINV#0182#doc id: Sales Invoice-SUBINV#0182#doc sourceDocument: id: Sales Order-SO0026 key: '451' documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 state: pending transactionDate: '2023-03-29' audit: createdDateTime: '2023-11-10T18:36:30Z' createdBy: '1' modifiedBy: '1' modifiedDateTime: '2023-11-10T18:36:32Z' dueDate: '2024-10-28' documentType: Sales Invoice txnDefinition: id: Sales Invoice key: '188' href: '/objects/order-entry-txn-definition::Sales%20Invoice/188' contacts: primary: key: '304' id: Power Aerospace Materials(C1) shipTo: key: '304' id: Power Aerospace Materials(C1) billTo: key: '304' id: Power Aerospace Materials(C1) isPrinted: false isBackordered: false subTotal: '750.44' total: '742.54' txnCurrency: USD exchangeRate: date: '2023-03-29' rate: '1' subtotalInTxnCurrency: '750.55' totalInTxnCurrency: '742.5' baseCurrency: USD isSystemGeneratedDocument: false postingDate: '2023-03-29' paymentStatus: open customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 lines: - id: '790' key: '790' documentHeader: key: '453' id: Sales Invoice-SUBINV#0182#doc documentType: Sales Invoice href: /objects/order-entry/document::Sales%20Invoice/453 documentType: Sales Invoice lineNumber: 0 dimensions: item: key: '1' id: 1--PC Computer name: PC Computer href: /objects/inventory-control/item/1 warehouse: id: '1' key: '1' href: /objects/inventory-control/warehouse/1 location: id: '1' key: '1' href: /objects/company-config/location/1 customer: key: '1' id: 1--Power Aerospace Materials name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 item: key: '1' id: 1--PC Computer href: /objects/inventory-control/item/1 unit: Each quantity: '1' quantityConverted: '0' retailPrice: '750' price: '742.5' audit: createdDateTime: '2023-03-29T00:00:00Z' modifiedDateTime: '2023-11-10T18:36:30Z' createdBy: '1' modifiedBy: '1' status: active costMethod: standard unitQuantity: '1' multiplier: 1 unitPrice: '750' txnCurrency: USD baseCurrency: USD priceInTxnCurrency: '750' conversionType: quantity allowDropship: false allowBuyToOrder: false quantityRemaining: '1' trackingDetail: [] href: '/objects/order-entry/document-line::Sales%20Invoice/790' history: - id: '382' key: '382' convertedTo: key: '453' id: Sales Invoice-SUBINV#0182#doc documentType: Sales Invoice href: /objects/order-entry/document::Sales%20Invoice/453 convertedFrom: id: Sales Order-SO0026 key: '451' documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 orderEntryDocument: key: '451' id: Sales Order-SO0026 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 href: /objects/order-entry/document-history/382 - id: '380' key: '380' convertedTo: key: '451' id: Sales Order-SO0026 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 orderEntryDocument: key: '451' id: Sales Order-SO0026 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 href: /objects/order-entry/document-history/380 subtotals: - id: '1204' key: '1204' description: Sales Discount absoluteValue: '0' total: '0' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 customer: key: '1' id: 1--Power Aerospace Materials href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '0' txnTotal: '0' documentLine: id: '790' key: '790' documentType: Sales Invoice href: '/objects/order-entry/document-line::Sales%20Invoice/790' audit: createdDateTime: '2023-11-10T18:36:31Z' modifiedDateTime: '2023-11-10T18:36:31Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/1204 - id: '1205' key: '1205' description: Discounted Totals absoluteValue: '7.5' percentValue: '1' total: '7.5' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 customer: key: '1' id: 1--Power Aerospace Materials href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '7.5' txnTotal: '-7.5' documentLine: id: '790' key: '790' documentType: Sales Invoice href: '/objects/order-entry/document-line::Sales%20Invoice/790' audit: createdDateTime: '2023-11-10T18:36:31Z' modifiedDateTime: '2023-11-10T18:36:31Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/1205 - id: '1206' key: '1206' description: Sales Tax absoluteValue: '0' total: '0' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '0' txnTotal: '0' documentLine: id: '790' key: '790' documentType: Sales Invoice href: '/objects/order-entry/document-line::Sales%20Invoice/790' audit: createdDateTime: '2023-11-10T18:36:31Z' modifiedDateTime: '2023-11-10T18:36:31Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/1206 href: /objects/order-entry/document::Sales%20Invoice/453 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document::{documentName}: get: summary: List named documents description: >- Returns a collection with a key, ID, and link for each order entry document with the specified name. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Order_Entry_Documents operationId: list-order-entry-named-document responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-document objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List named 'Sales Invoice' documents: value: ia::result: - key: '171' id: Sales Invoice-SUBINV#0147#doc href: /objects/order-entry/document::Sales%20Invoice/171 - key: '172' id: Sales Invoice-SUBINV#0148#doc href: /objects/order-entry/document::Sales%20Invoice/172 - key: '155' id: Sales Invoice-SUBINV#0144#doc href: /objects/order-entry/document::Sales%20Invoice/155 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a document description: Creates a new order entry document. tags: - Order_Entry_Documents operationId: create-order-entry-named-document requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-document' - $ref: '#/components/schemas/order-entry-documentRequiredProperties' examples: Create a document: value: customer: id: '1' state: submitted transactionDate: '2023-11-01' dueDate: '2024-12-12' txnCurrency: USD baseCurrency: USD lines: - dimensions: item: id: '1' warehouse: id: '1' location: id: '1' unit: Each unitQuantity: '1' unitPrice: '650' responses: '201': description: Created content: application/json: schema: type: object title: New order entry document properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New document: value: ia::result: key: '13977' id: Sales Invoice-SUBINV#0193#doc documentType: Sales Invoice href: /objects/order-entry/document::Sales%20Invoice/469 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] parameters: - $ref: '#/components/parameters/OrderEntryDocumentName' /objects/order-entry/document::{documentName}/{key}: parameters: - name: key description: System-assigned key for the order entry document. in: path required: true schema: type: string - $ref: '#/components/parameters/OrderEntryDocumentName' get: summary: Get a named document description: Returns detailed information for a specified order entry document. tags: - Order_Entry_Documents operationId: get-order-entry-named-document-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order entry document properties: ia::result: $ref: '#/components/schemas/order-entry-document' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a named document: value: ia::result: key: '453' documentNumber: SUBINV#0182#doc id: Sales Invoice-SUBINV#0182#doc sourceDocument: id: Sales Order-SO0026 key: '451' documentType: Sales Order href: /objects/order-entry/document::Sales Order/451 state: pending transactionDate: '2023-03-29' audit: createdDateTime: '2023-11-10T18:36:30Z' createdBy: '1' modifiedBy: '1' modifiedDateTime: '2023-11-10T18:36:32Z' dueDate: '2024-10-28' documentType: Sales Invoice txnDefinition: id: Sales Invoice key: '188' href: '/objects/order-entry-txn-definition::Sales%20Invoice/188' contacts: primary: key: '304' id: Power Aerospace Materials(C1) shipTo: key: '304' id: Power Aerospace Materials(C1) billTo: key: '304' id: Power Aerospace Materials(C1) isPrinted: false isBackordered: false subTotal: '750.66' total: '742.54' txnCurrency: USD exchangeRate: date: '2023-03-29' rate: '1' subtotalInTxnCurrency: '750.55' totalInTxnCurrency: '742.5' baseCurrency: USD isSystemGeneratedDocument: false postingDate: '2023-03-29' paymentStatus: open customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 lines: - id: '790' key: '790' documentHeader: key: '453' id: Sales Invoice-SUBINV#0182#doc documentType: Sales Invoice href: /objects/order-entry/document::Sales%20Invoice/453 documentType: Sales Invoice lineNumber: 0 dimensions: item: key: '1' id: 1--PC Computer name: PC Computer href: /objects/inventory-control/item/1 warehouse: id: '1' key: '1' href: /objects/inventory-control/warehouse/1 location: id: '1' key: '1' href: /objects/company-config/location/1 customer: key: '1' id: 1--Power Aerospace Materials name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 item: key: '1' id: 1--PC Computer href: /objects/inventory-control/item/1 unit: Each quantity: '1' quantityConverted: '0' retailPrice: '750' price: '742.5' audit: createdDateTime: '2023-03-29T00:00:00Z' modifiedDateTime: '2023-11-10T18:36:30Z' createdBy: '1' modifiedBy: '1' status: active costMethod: standard unitQuantity: '1' multiplier: 1 unitPrice: '750' txnCurrency: USD baseCurrency: USD priceInTxnCurrency: '750' conversionType: quantity allowDropship: false allowBuyToOrder: false quantityRemaining: '1' trackingDetail: [] href: '/objects/order-entry/document-line::Sales%20Invoice/790' history: - id: '382' key: '382' convertedTo: key: '453' id: Sales Invoice-SUBINV#0182#doc documentType: Sales Invoice href: /objects/order-entry/document::Sales%20Invoice/453 convertedFrom: id: Sales Order-SO0026 key: '451' documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 orderEntryDocument: key: '451' id: Sales Order-SO0026 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 href: /objects/order-entry/document-history/382 - id: '380' key: '380' convertedTo: key: '451' id: Sales Order-SO0026 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 orderEntryDocument: key: '451' id: Sales Order-SO0026 documentType: Sales Order href: /objects/order-entry/document::Sales%20Order/451 href: /objects/order-entry/document-history/380 subtotals: - id: '1204' key: '1204' description: Sales Discount absoluteValue: '0' total: '0' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 customer: key: '1' id: 1--Power Aerospace Materials href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '0' txnTotal: '0' documentLine: id: '790' key: '790' documentType: Sales Invoice href: '/objects/order-entry/document-line::Sales%20Invoice/790' audit: createdDateTime: '2023-11-10T18:36:31Z' modifiedDateTime: '2023-11-10T18:36:31Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/1204 - id: '1205' key: '1205' description: Discounted Totals absoluteValue: '7.5' percentValue: '1' total: '7.5' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 customer: key: '1' id: 1--Power Aerospace Materials href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '7.5' txnTotal: '7.5' documentLine: id: '790' key: '790' documentType: Sales Invoice href: '/objects/order-entry/document-line::Sales%20Invoice/790' audit: createdDateTime: '2023-11-10T18:36:31Z' modifiedDateTime: '2023-11-10T18:36:31Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/1205 - id: '1206' key: '1206' description: Sales Tax absoluteValue: '0' total: '0' isValueEditable: false isPercentEditable: true dimensions: location: key: '1' id: '1' href: /objects/company-config/location/1 customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '0' txnTotal: '0' documentLine: id: '790' key: '790' documentType: Sales Invoice href: '/objects/order-entry/document-line::Sales%20Invoice/790' audit: createdDateTime: '2023-11-10T18:36:31Z' modifiedDateTime: '2023-11-10T18:36:31Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/1206 href: /objects/order-entry/document::Sales%20Invoice/453 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a document description: >- Updates an existing order entry document by setting field values. Any fields not provided remain unchanged. tags: - Order_Entry_Documents operationId: update-order-entry-document-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-document' - type: object properties: id: readOnly: true examples: Update a document: value: referenceNumber: '1012' lines: - dimensions: item: key: '15' warehouse: key: '4' location: key: '6' item: key: '15' unit: 10 Pack - key: '22' unitQuantity: '9' price: '750' - key: '59' ia::operation: delete responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-document properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated document: value: ia::result: key: '52' id: Sales Invoice-SUBINV#0182#doc documentType: Sales Invoice href: /objects/order-entry/document::Sales%20Invoice/52 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a document description: Deletes an order entry document. tags: - Order_Entry_Documents operationId: delete-order-entry-named-document-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-line: get: summary: List document lines description: >- Returns a collection with a key, ID, and link for each order entry document line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Order_Entry_Document lines operationId: list-order-entry-document-line responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-document-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document lines: value: ia::result: - key: '19' id: '19' href: /objects/order-entry/document-line::Sales%20Invoice/19 - key: '24' id: '24' href: /objects/order-entry/document-line::Sales%20Invoice/24 - key: '25' id: '25' href: /objects/order-entry/document-line::Sales%20Quote/25 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-line/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the order entry document line. get: summary: Get a document line description: Returns detailed information for a specified order entry document line. tags: - Order_Entry_Document lines operationId: get-order-entry-document-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order-entry-document properties: ia::result: $ref: '#/components/schemas/order-entry-document-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document line: value: ia::result: id: '925' key: '925' documentHeader: key: '599' id: Sales Order-SO0066 documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/599 documentType: Sales Order lineNumber: 0 dimensions: item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 warehouse: id: '1' key: '1' href: /objects/inventory-control/warehouse/1 location: id: '1' key: '1' href: /objects/company-config/location/1 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 item: key: '1' id: '1' href: /objects/inventory-control/item/1 unit: Each quantity: '10' quantityConverted: '1' retailPrice: '222' price: '333' audit: createdDateTime: '2023-12-18T00:00:00Z' modifiedDateTime: '2023-12-18T10:27:15Z' createdBy: '1' modifiedBy: '1' status: active unitQuantity: '1' multiplier: 1 unitPrice: '333' txnCurrency: USD baseCurrency: USD priceInTxnCurrency: '333' conversionType: quantity allowDropship: false allowBuyToOrder: false quantityRemaining: '0' trackingDetail: [] href: /objects/order-entry/document-line::Sales%20Order/925 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-line::{documentName}: get: summary: List named document lines description: >- Returns a collection with a key, ID, and link for each named order entry document line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Order_Entry_Document lines operationId: list-order-entry-named-document-line responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-document-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document lines: value: ia::result: - key: '19' id: '19' href: /objects/order-entry/document-line::Sales%20Invoice/19 - key: '24' id: '24' href: /objects/order-entry/document-line::Sales%20Invoice/24 - key: '25' id: '25' href: /objects/order-entry/document-line::Sales%20Quote/25 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a document line description: Creates a new order entry document line. tags: - Order_Entry_Document lines operationId: create-order-entry-named-document-line requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-document-line' - $ref: '#/components/schemas/order-entry-document-lineRequiredProperties' examples: Create a document line: value: documentHeader: key: '469' dimensions: item: id: '1' warehouse: id: '1' location: id: '1' unit: Each unitQuantity: '1' unitPrice: '650' responses: '201': description: Created content: application/json: schema: type: object title: New order entry document line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New document line: value: ia::result: key: '807' href: /objects/order-entry/document-line::Sales%20Invoice/807 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] parameters: - $ref: '#/components/parameters/documentName' /objects/order-entry/document-line::{documentName}/{key}: parameters: - name: key description: System-assigned key for the order entry document line. in: path required: true schema: type: string - $ref: '#/components/parameters/documentName' get: summary: Get a named document line description: Returns detailed information for a specified order entry document line. tags: - Order_Entry_Document lines operationId: get-order-entry-named-document-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order-entry-document-line properties: ia::result: $ref: '#/components/schemas/order-entry-document-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a named document line: value: ia::result: id: '925' key: '925' documentHeader: key: '599' id: Sales Order-SO0066 documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/599 documentType: Sales Order lineNumber: 0 dimensions: item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 warehouse: id: '1' key: '1' href: /objects/inventory-control/warehouse/1 location: id: '1' key: '1' href: /objects/company-config/location/1 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 item: key: '1' id: '1' href: /objects/inventory-control/item/1 unit: Each quantity: '1' quantityConverted: '1' retailPrice: '222' price: '333' audit: createdDateTime: '2023-12-18T00:00:00Z' modifiedDateTime: '2023-12-18T10:27:15Z' createdBy: '1' modifiedBy: '1' status: active unitQuantity: '1' multiplier: 1 unitPrice: '333' txnCurrency: USD baseCurrency: USD priceInTxnCurrency: '333' conversionType: quantity allowDropship: false allowBuyToOrder: false quantityRemaining: '0' trackingDetail: [] href: /objects/order-entry/document-line::Sales%20Order/925 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a document line description: >- Updates an existing order entry document line by setting field values. Any fields not provided remain unchanged. tags: - Order_Entry_Document lines operationId: update-order-entry-named-document-line-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-document-line' - type: object examples: Update a document line: value: unitQuantity: '10' responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-document-line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated document line: value: ia::result: key: '52' href: /objects/order-entry/document-line::Sales%20Invoice/52 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a document line description: Deletes an order entry document line. tags: - Order_Entry_Document lines operationId: delete-order-entry-named-document-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-line-detail: get: summary: List document line details description: >- Returns a collection with a key, ID, and link for each Order Entry document line details. tags: - Order_Entry_Document line details operationId: list-order-entry-document-line-detail responses: '200': description: OK content: application/json: schema: type: object title: List of document line details properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document line details: value: value: ia::result: - key: '1' id: '1' href: /objects/order-entry/document-line-detail/1 - key: '2' id: '2' href: /objects/order-entry/document-line-detail/2 - key: '3' id: '3' href: /objects/order-entry/document-line-detail/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-line-detail/{key}: parameters: - name: key description: System-assigned unique key for the document line details. in: path required: true schema: type: string get: summary: Get a document line detail description: >- Returns detailed information for a particular Order Entry document line detail. tags: - Order_Entry_Document line details operationId: get-order-entry-document-line-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Get a document line detail properties: ia::result: $ref: '#/components/schemas/order-entry-document-line-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document line detail: value: ia::result: id: '11' key: '11' orderEntryDocumentLine: id: '883' key: '883' documentType: Sales Order href: /objects/order-entry-document-line::Sales%20Order/883 item: id: Battery key: '258' href: /objects/item/258 quantity: '1' serialNumber: SLX 728 lotNumber: '1981' aisle: key: '1' id: A1 href: /objects/inventory-control/aisle/1 row: key: '1' id: R1 href: /objects/inventory-control/row/1 bin: key: '1' id: B1 href: /objects/inventory-control/bin/1 expirationDate: '2023-12-31' audit: createdDateTime: '2023-12-14T04:58:04Z' modifiedDateTime: '2023-12-14T04:58:04Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-line-detail/11 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-subtotal: get: summary: List document subtotals description: >- Returns a collection with a key, ID, and link for each Order Entry document subtotals. tags: - Order_Entry_Document subtotals operationId: list-order-entry-document-subtotal responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-document-subtotal objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document subtotals: value: ia::result: - key: '13' id: '13' href: /objects/order-entry/document-subtotal/13 - key: '14' id: '14' href: /objects/order-entry/document-subtotal/14 - key: '15' id: '15' href: /objects/order-entry/document-subtotal/15 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-subtotal/{key}: parameters: - name: key description: System-assigned unique key for the document subtotal. in: path required: true schema: type: string get: summary: Get a document subtotal description: >- Returns detailed information for a specified Order Entry document subtotal. tags: - Order_Entry_Document subtotals operationId: get-order-entry-document-subtotal-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the Order Entry document subtotal properties: ia::result: $ref: '#/components/schemas/order-entry-document-subtotal' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document subtotal: value: ia::result: id: '307' key: '307' description: Sales Discount absoluteValue: '14.5' percentValue: '1.45' total: '-14.5' isValueEditable: false isPercentEditable: true dimensions: location: key: '36' id: YNK href: /objects/company-config/location/36 department: key: '38' id: Accounting href: /objects/company-config/department/38 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 txnAbsoluteValue: '14.5' txnTotal: '-14.5' documentLine: id: '233' key: '233' documentType: Sales Invoice href: '/objects/order-entry-document-line::Sales%20Invoice/233' documentHeader: key: '21' id: Sales Invoice-SUBINV#0100#doc documentType: Sales Invoice href: /objects/order-entry-document::Sales%20Invoice/21 audit: createdDateTime: '2023-07-11T04:58:20Z' modifiedDateTime: '2023-07-11T04:58:20Z' createdBy: '1' modifiedBy: '1' href: /objects/order-entry/document-subtotal/307 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-history: get: summary: List document histories description: >- Returns a collection with a key, ID, and link for each Order Entry document history. tags: - Order_Entry_Document histories operationId: list-order-entry-document-history responses: '200': description: OK content: application/json: schema: type: object title: List document history objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document histories: value: ia::result: - key: '15' id: '15' href: /objects/order-entry/document-history/15 - key: '16' id: '16' href: /objects/order-entry/document-history/16 - key: '17' id: '17' href: /objects/order-entry/document-history/17 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/document-history/{key}: parameters: - name: key description: System-assigned unique key for the document history. in: path required: true schema: type: string get: summary: Get a document history description: >- Returns detailed information for a specified Order Entry document history. tags: - Order_Entry_Document histories operationId: get-order-entry-document-history-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the document history properties: ia::result: $ref: '#/components/schemas/order-entry-document-history' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document history: value: ia::result: id: '411' key: '411' convertedTo: key: '483' id: Sales Invoice-SUBINV#0200#doc documentType: Sales Invoice href: /objects/order-entry-document::Sales%20Invoice/483 convertedFrom: key: '482' id: Sales Order-SO0037 documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/482 orderEntryDocument: key: '482' id: Sales Order-SO0037 documentType: Sales Order href: /objects/order-entry-document::Sales%20Order/482 href: /objects/order-entry/document-history/411 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition: get: summary: List transaction definitions description: >- Returns a collection with a key, ID, and link for each order entry transaction definition. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Order_Entry_Transaction definitions operationId: list-order-entry-txn-definition responses: '200': description: OK content: application/json: schema: type: object title: List of transaction definition objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction definitions: value: ia::result: - key: '35' id: Sales Return href: /objects/order-entry/txn-definition/35 - key: '37' id: Sales Invoice href: /objects/order-entry/txn-definition/37 - key: '40' id: Shipper href: /objects/order-entry/txn-definition/40 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a transaction definition description: Creates a new order entry transaction definition. tags: - Order_Entry_Transaction definitions operationId: create-order-entry-txn-definition requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition' - $ref: '#/components/schemas/order-entry-txn-definitionRequiredProperties' examples: Create a transaction definition: value: id: Sales Invoice docClass: invoice workflowCategory: invoice description: Sales Invoice editPolicy: all deletePolicy: all enableNumberingSequence: true preserveNumberingSequence: true inheritDocumentNumber: false inventoryUpdateType: 'no' increaseOrDecreaseInventory: decrease txnPostingMethod: noPosting disableTax: false enableFulfillment: false enableReservingAndPicking: false partialConvertMethod: closeOriginalAndCreateBackOrder affectsCost: false overrideExchangeRateType: true overridePrice: true trackDiscountAndSurcharge: false allowDiscountOnExtendedPrice: false requireMemoForDiscount: false enableSubtotals: false showExpandedTaxDetails: false enableOverrideTax: false revrecEnablementType: none renewalEnablementType: generate enableLineItemConversion: true allowRenewConvertedLineOnly: false allowLocationOverride: true allowDepartmentOverride: true xslTemplate: Intacct Sales Invoice fixedMessage: Sales Transaction contactOneTitle: Bill to printBillToContact: true allowEditingBillToContact: false printShipToContact: true contactTwoTitle: Ship to allowEditingShipToContact: false enableWarnOnLowQuantity: false enableCreditLimitCheck: false warehouseSelectionMethod: useTheDefaultWarehouse responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-txn-definition properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New transaction definition: value: ia::result: key: '53' id: '53' href: /objects/order-entry/txn-definition/53 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition/{key}: parameters: - name: key description: System-assigned unique key for the transaction definition. in: path required: true schema: type: string get: summary: Get a transaction definition description: >- Returns detailed information for a specified order entry transaction definition. tags: - Order_Entry_Transaction definitions operationId: get-order-entry-txn-definition-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the transaction definition properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition: value: ia::result: key: '63' id: Sales Invoice docClass: invoice workflowCategory: invoice description: Sales Invoice enableUserOrGroupPermmission: false editPolicy: all deletePolicy: all enableNumberingSequence: true documentSequence: id: OE-Doc printTitle: Sales Invoice preserveNumberingSequence: true inheritDocumentNumber: false inventoryUpdateType: 'no' increaseOrDecreaseInventory: decrease txnPostingMethod: noPosting disableTax: false enableFulfillment: false enableReservingAndPicking: false partialConvertMethod: closeOriginalAndCreateBackOrder affectsCost: false exchangeRateType: id: Intacct Daily Rate key: '-1' overrideExchangeRateType: true showBaseCurrency: false initialPriceList: id: Base Price List key: '1' href: /objects/order-entry-price-list/1 overridePrice: true trackDiscountAndSurcharge: false allowDiscountOnExtendedPrice: false requireMemoForDiscount: false freezeRecallValue: false enableSubtotals: false showExpandedTaxDetails: false enableOverrideTax: false revrecEnablementType: none renewalEnablementType: generate enableLineItemConversion: true allowRenewConvertedLineOnly: false allowLocationOverride: true allowDepartmentOverride: true xslTemplate: Intacct Sales Invoice fixedMessage: Sales Transaction contactOneTitle: Bill to printBillToContact: true allowEditingBillToContact: false printShipToContact: true contactTwoTitle: Ship to allowEditingShipToContact: false enableWarnOnLowQuantity: false enableCreditLimitCheck: false warehouseSelectionMethod: useTheDefaultWarehouse warehouse: id: WH02 status: active enablePayments: false postToGL: false requireSupplyOfPrices: false enableCosting: false audit: createdDateTime: '2023-06-27T14:22:49Z' modifiedDateTime: '2023-06-27T14:22:49Z' createdBy: '1' modifiedBy: '1' documentConversionPolicy: newDocumentOrConvert multiEntityRuleForTransaction: topLevelOrEntity enableProjectActualBillings: false lineLevelSimpleTax: false customerVendorEditRule: never enableRetainage: false enableAdditionalInformationScope: false enableAdditionalInformationSchedule: false enableInternalReference: false enableExternalReference: false enableBond: false documentChangeType: noChange reportingCategory: salesOrderInvoices enableContractBilling: false arPostingMethod: none href: /objects/order-entry/txn-definition/63 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition description: > Updates an existing order entry transaction definition by setting field values. Any fields not provided remain unchanged. The changes you make to a transaction definition apply to transactions that are created after the changes are made. The changes do not apply to existing transactions unless you edit and save the transaction after changes are made. tags: - Order_Entry_Transaction definitions operationId: update-order-entry-txn-definition-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition' - type: object properties: id: readOnly: true examples: Update a transaction definition: value: showBasecurrency: false canOverridePrice: true recallDocumentDetail: - isDefault: true recallTransactionDefinition: id: Vendor Invoice - key: '57' isDefault: false - key: '59' ia::operation: delete responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated transaction definition: value: ia::result: key: '52' href: /objects/order-entry/txn-definition/52 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition description: Deletes an order entry transaction definition. tags: - Order_Entry_Transaction definitions operationId: delete-order-entry-txn-definition-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-additional-gl-detail: get: summary: List additional GL posting account detail objects description: >- Returns a collection with a key, ID, and link for each transaction definition additional GL posting account detail. tags: - >- Order_Entry_Transaction definition additional GL posting account details operationId: list-order-entry-txn-definition-additional-gl-detail responses: '200': description: OK content: application/json: schema: type: object title: List of transaction definition additional GL account details properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction definition additional GL posting account details: value: ia::result: - key: '195' id: '195' href: '/objects/order-entry/txn-definition-additional-gl-detail/195' - key: '196' id: '196' href: '/objects/order-entry/txn-definition-additional-gl-detail/196' ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-additional-gl-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the transaction definition additional GL posting account details. in: path required: true schema: type: string get: summary: Get an additional GL posting account detail object description: >- Returns detailed information for a specified transaction definition additional GL posting account detail object. tags: - >- Order_Entry_Transaction definition additional GL posting account details operationId: get-order-entry-txn-definition-additional-gl-detail-key responses: '200': description: OK content: application/json: schema: type: object title: >- Get a transaction definition additional GL account detail object properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-additional-gl-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition additional GL posting account object: value: ia::result: key: '195' id: '195' order-entry-txn-definition: key: '64' id: Sales Order href: /objects/order-entry-txn-definition/64 itemGLGroup: key: '6' id: Auto GL Group href: /objects/item-gl-group/6 isOffset: false txnType: debit moduleType: additional glAccount: id: '1000' key: '3' href: /objects/gl-account/3 lineNumber: 1 href: '/objects/order-entry/txn-definition-additional-gl-detail/195' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an additional GL posting account detail object description: >- Updates an existing transaction definition additional GL posting account detail object by setting field values. Any fields not provided remain unchanged. tags: - >- Order_Entry_Transaction definition additional GL posting account details operationId: update-order-entry-txn-definition-additional-gl-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-additional-gl-detail' - type: object properties: id: readOnly: true examples: Update an additional GL posting account detail object: value: glAccount: id: '1400' order-entry-txn-definition: key: '64' responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition-additional-gl-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated additional GL posting account detail object: value: ia::result: key: '195' id: '195' href: '/objects/order-entry/txn-definition-additional-gl-detail/195' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an additional GL posting account detail object description: Deletes an additional GL posting account detail object. tags: - >- Order_Entry_Transaction definition additional GL posting account details operationId: delete-order-entry-txn-definition-additional-gl-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-ar-direct-gl-detail: get: summary: List transaction definition account detail objects description: >- Returns a collection with a key, ID, and link for each transaction definition Account Receivable or direct GL account detail object. tags: - Order_Entry_Transaction definition account details operationId: list-order-entry-txn-definition-ar-direct-gl-detail responses: '200': description: OK content: application/json: schema: type: object title: List transaction definition account detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction definition account detail objects: value: ia::result: - key: '98' id: '98' href: '/objects/order-entry/txn-definition-ar-direct-gl-detail/98' - key: '163' id: '163' href: '/objects/order-entry/txn-definition-ar-direct-gl-detail/163' - key: '164' id: '164' href: '/objects/order-entry/txn-definition-ar-direct-gl-detail/164' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-ar-direct-gl-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the transaction definition account detail object. in: path required: true schema: type: string get: summary: Get a transaction definition account detail object description: >- Returns detailed information for a specified transaction definition Account Receivable or direct GL account detail object. tags: - Order_Entry_Transaction definition account details operationId: get-order-entry-txn-definition-ar-direct-gl-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the transaction definition account detail object properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-ar-direct-gl-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition account detail object: value: ia::result: key: '167' id: '167' order-entry-txn-definition: key: '43' id: Sales Invoice href: /objects/order-entry-txn-definition/43 itemGLGroup: key: '2' id: OS GL Group href: /objects/item-gl-group/2 isOffset: false txnType: credit moduleType: subledger glAccount: id: '4030' key: '69' href: /objects/gl-account/69 lineNumber: 1 href: '/objects/order-entry/txn-definition-ar-direct-gl-detail/167' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition account detail object description: >- Updates an existing transaction definition Account Receivable or direct GL account detail object by setting field values. Any fields not provided remain unchanged. tags: - Order_Entry_Transaction definition account details operationId: update-order-entry-txn-definition-ar-direct-gl-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-ar-direct-gl-detail' - type: object properties: id: readOnly: true examples: Update a transaction definition account detail object: value: glAccount: id: '1400' order-entry-txn-definition: key: '64' responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition-ar-direct-gl-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated transaction definition account detail object: value: ia::result: key: '193' id: '193' href: '/objects/order-entry/txn-definition-ar-direct-gl-detail/193' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition account detail object description: >- Delete a transaction definition Account Receivable or direct GL account detail object. tags: - Order_Entry_Transaction definition account details operationId: delete-order-entry-txn-definition-ar-direct-gl-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-cogs-gl-detail: get: summary: List transaction definition COGS account detail objects description: >- Returns a collection with a key, ID, and link for each transaction definition COGS GL account and Inventory account detail object. tags: - Order_Entry_Transaction definition COGS account details operationId: list-order-entry-txn-definition-cogs-gl-detail responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-txn-definition-cogs-gl-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of costing GL account detail for Order Entry transaction definition: value: ia::result: - key: '159' id: '159' href: /objects/order-entry/txn-definition-cogs-gl-detail/159 - key: '160' id: '160' href: /objects/order-entry/txn-definition-cogs-gl-detail/160 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-cogs-gl-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the transaction definition COGS account detail object. definition. in: path required: true schema: type: string get: summary: Get a transaction definition COGS account detail object description: >- Returns detailed information for a specified transaction definition COGS GL account and Inventory account detail object. tags: - Order_Entry_Transaction definition COGS account details operationId: get-order-entry-txn-definition-cogs-gl-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order-entry-txn-definition-cogs-gl-detail properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-cogs-gl-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition COGS account detail object: value: ia::result: key: '160' id: '160' order-entry-txn-definition: key: '43' id: Sales Invoice href: /objects/order-entry-txn-definition/43 itemGLGroup: key: '1' id: HW GL Group href: /objects/item-gl-group/1 txnType: debit moduleType: inventory glAccount: id: '5000' key: '72' href: /objects/gl-account/72 lineNumber: 1 href: /objects/order-entry/txn-definition-cogs-gl-detail/160 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition COGS account detail object description: >- Updates an existing transaction definition COGS GL account and Inventory account detail object by setting field values. Any fields not provided remain unchanged. tags: - Order_Entry_Transaction definition COGS account details operationId: update-order-entry-txn-definition-cogs-gl-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-cogs-gl-detail' - type: object properties: id: readOnly: true examples: Updates a transaction definition COGS account detail object: value: glAccount: id: '1400' order-entry-txn-definition: key: '64' responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition-cogs-gl-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated transaction definition COGS account detail object: value: ia::result: key: '191' id: '191' href: /objects/order-entry/txn-definition-cogs-gl-detail/191 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition COGS account detail object description: >- Deletes a transaction definition COGS GL account and Inventory account detail object. tags: - Order_Entry_Transaction definition COGS account details operationId: delete-order-entry-txn-definition-cogs-gl-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-entity-setting-detail: get: summary: List transaction definition entity detail objects description: >- Returns a collection with a key, ID, and link for each transaction definition entity detail object. tags: - Order_Entry_Transaction definition entity details operationId: list-order-entry-txn-definition-entity-setting-detail responses: '200': description: OK content: application/json: schema: type: object title: List transaction definition entity detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction definition entity detail objects: value: ia::result: - key: '160' id: '160' href: '/objects/order-entry/txn-definition-entity-setting-detail/160' - key: '161' id: '161' href: '/objects/order-entry/txn-definition-entity-setting-detail/161' - key: '162' id: '162' href: '/objects/order-entry/txn-definition-entity-setting-detail/162' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a transaction definition entity detail object description: Creates a new transaction definition entity detail object. tags: - Order_Entry_Transaction definition entity details operationId: create-order-entry-txn-definition-entity-setting-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-entity-setting-detail' - $ref: '#/components/schemas/order-entry-txn-definition-entity-setting-detailRequiredProperties' examples: Create a transaction definition entity detail object: value: order-entry-txn-definition: key: '50' entity: id: Mountain Region enableNumberingSequence: false documentSequence: id: AR Inv preserveNumberingSequence: true canInheritSourceDocumentNumber: true enableCreateTransactionRule: true showExpandedTaxDetail: false enableOverrideTax: true enableLineLevelSimpleTax: false responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-txn-definition-entity-setting-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New transaction definition entity detail object: value: ia::result: key: '170' id: '170' href: '/objects/order-entry/txn-definition-entity-setting-detail/170' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-entity-setting-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the transaction definition entity detail object. in: path required: true schema: type: string get: summary: Get a transaction definition entity detail object description: >- Returns detailed information for a specified transaction definition entity detail object. tags: - Order_Entry_Transaction definition entity details operationId: get-order-entry-txn-definition-entity-setting-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the transaction definition entity detail object properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-entity-setting-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition entity detail object: value: ia::result: key: '162' id: '162' order-entry-txn-definition: key: '50' id: Sales Return href: /objects/order-entry-txn-definition/50 entity: key: '3' id: Mountain Region href: /objects/entity/3 enableNumberingSequence: false documentSequence: key: '11' id: AR Inv href: /objects/document-sequence-number/11 preserveNumberingSequence: true canInheritSourceDocumentNumber: true enableCreateTransactionRule: true showExpandedTaxDetail: false enableOverrideTax: true enableLineLevelSimpleTax: false href: '/objects/order-entry/txn-definition-entity-setting-detail/162' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition entity detail object description: >- Updates an existing transaction definition entity detail object. Any fields not provided remain unchanged. tags: - Order_Entry_Transaction definition entity details operationId: update-order-entry-txn-definition-entity-setting-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-entity-setting-detail' - type: object properties: id: readOnly: true examples: Update a transaction definition entity detail object: value: order-entry-txn-definition: key: '64' enableLineLevelSimpleTax: true responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition-entity-setting-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated transaction definition entity detail object: value: ia::result: key: '174' id: '174' href: '/objects/order-entry/txn-definition-entity-setting-detail/174' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition entity detail object description: Deletes a transaction definition entity detail object. tags: - Order_Entry_Transaction definition entity details operationId: delete-order-entry-txn-definition-entity-setting-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-inventory-total-detail: get: summary: List transaction definition inventory total detail objects description: >- Returns a collection with a key, ID, and link for each transaction definition inventory total detail object. tags: - Order_Entry_Transaction definition inventory total details operationId: list-order-entry-txn-definition-inventory-total-detail responses: '200': description: OK content: application/json: schema: type: object title: >- List of order-entry-txn-definition-inventory-total-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction definition inventory total detail objects: value: ia::result: - key: '9' id: '9' href: '/objects/order-entry/txn-definition-inventory-total-detail/9' - key: '12' id: '12' href: '/objects/order-entry/txn-definition-inventory-total-detail/12' - key: '14' id: '14' href: '/objects/order-entry/txn-definition-inventory-total-detail/14' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a transaction definition inventory total detail object description: Creates a new transaction definition inventory total detail object. tags: - Order_Entry_Transaction definition inventory total details operationId: create-order-entry-txn-definition-inventory-total-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-inventory-total-detail' - $ref: '#/components/schemas/order-entry-txn-definition-inventory-total-detailRequiredProperties' examples: Create a transaction definition inventory total detail object: value: order-entry-txn-definition: key: '64' maintainType: quantity inventoryTotal: id: DAMAGED operation: add responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-txn-definition-inventory-total-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New transaction definition inventory total detail object: value: order-entry-txn-definition: key: '96' inventoryTotal: id: DAMAGED maintainType: quantity operation: add '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-inventory-total-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the transaction definition inventory total detail object. in: path required: true schema: type: string get: summary: Get a transaction definition inventory total detail object description: >- Returns detailed information for a specified transaction definition inventory total detail object. tags: - Order_Entry_Transaction definition inventory total details operationId: get-order-entry-txn-definition-inventory-total-detail-key responses: '200': description: OK content: application/json: schema: type: object title: >- Details of the transaction definition inventory total detail object properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-inventory-total-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition inventory total detail object: value: ia::result: key: '125' id: '125' order-entry-txn-definition: key: '64' id: Sales Order href: /objects/order-entry-txn-definition/64 maintainType: quantity inventoryTotal: id: DAMAGED operation: add href: '/objects/order-entry/txn-definition-inventory-total-detail/125' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition inventory total detail object description: >- Updates an existing transaction definition inventory total detail object by setting field values. Any fields not provided remain unchanged. tags: - Order_Entry_Transaction definition inventory total details operationId: update-order-entry-txn-definition-inventory-total-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-inventory-total-detail' - type: object properties: id: readOnly: true examples: Update a transaction definition inventory total detail object: value: order-entry-txn-definition: key: '64' operation: subtract responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition-inventory-total-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated transaction definition inventory total detail object: value: ia::result: key: '128' id: '128' href: '/objects/order-entry/txn-definition-inventory-total-detail/128' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition inventory total detail object description: Deletes a transaction definition inventory total detail object. tags: - Order_Entry_Transaction definition inventory total details operationId: delete-order-entry-txn-definition-inventory-total-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-source-document-detail: get: summary: List transaction definition document conversion detail objects description: >- Returns a collection with a key, ID, and link for each document conversion detail object. tags: - Order_Entry_Transaction definition document conversion details operationId: list-order-entry-txn-definition-source-document-detail responses: '200': description: OK content: application/json: schema: type: object title: List document conversion detail Objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document conversion detail objects: value: ia::result: - key: '23' id: '23' href: '/objects/order-entry/txn-definition-source-document-detail/23' - key: '19' id: '19' href: '/objects/order-entry/txn-definition-source-document-detail/19' - key: '61' id: '61' href: '/objects/order-entry/txn-definition-source-document-detail/61' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a transaction definition document conversion detail object description: Creates a new document conversion detail object. tags: - Order_Entry_Transaction definition document conversion details operationId: create-order-entry-txn-definition-source-document-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-source-document-detail' - $ref: '#/components/schemas/order-entry-txn-definition-source-document-detailRequiredProperties' examples: Create a document conversion detail object: value: order-entry-txn-definition: key: '64' sourceDocument: id: Sales Invoice isDefault: false responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-txn-definition-source-document-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New document conversion detail object: value: ia::result: key: '70' id: '70' href: '/objects/order-entry/txn-definition-source-document-detail/70' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-source-document-detail/{key}: parameters: - name: key description: System-assigned unique key for the document conversion detail object. in: path required: true schema: type: string get: summary: Get a transaction definition document conversion detail object description: >- Returns detailed information for a specified document conversion detail object. tags: - Order_Entry_Transaction definition document conversion details operationId: get-order-entry-txn-definition-source-document-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Get a transaction definition document conversion detail object properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-source-document-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document conversion detail object: value: ia::result: key: '70' id: '70' order-entry-txn-definition: key: '64' id: Sales Order href: /objects/order-entry-txn-definition/64 sourceDocument: key: '43' id: Sales Invoice href: /objects/order-entry-txn-definition/43 isDefault: true href: '/objects/order-entry/txn-definition-source-document-detail/70' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition document conversion detail object description: >- Updates an existing document conversion detail object by setting field values. Any fields not provided remain unchanged. tags: - Order_Entry_Transaction definition document conversion details operationId: update-order-entry-txn-definition-source-document-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-source-document-detail' - type: object properties: id: readOnly: true examples: Update a document conversion detail object: value: order-entry-txn-definition: key: '64' isDefault: true responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-txn-definition-source-document-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated document conversion detail object: value: ia::result: key: '70' id: '70' href: '/objects/order-entry/txn-definition-source-document-detail/70' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition document conversion detail object description: Deletes a document conversion detail object. tags: - Order_Entry_Transaction definition document conversion details operationId: delete-order-entry-txn-definition-source-document-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-subtotal-detail: get: summary: List transaction definition subtotal detail objects description: >- Returns a collection with a key, ID, and link for each transaction definition subtotal detail object. tags: - Order_Entry_Transaction definition subtotal details operationId: list-order-entry-txn-definition-subtotal-detail responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-txn-definition-subtotal-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List transaction definition subtotal objects: value: ia::result: - key: '15' id: '15' href: /objects/order-entry/txn-definition-subtotal-detail/15 - key: '19' id: '19' href: /objects/order-entry/txn-definition-subtotal-detail/19 - key: '3' id: '3' href: /objects/order-entry/txn-definition-subtotal-detail/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a transaction definition subtotal detail object description: Creates a new transaction definition subtotal detail object. tags: - Order_Entry_Transaction definition subtotal details operationId: create-order-entry-txn-definition-subtotal-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-subtotal-detail' - $ref: '#/components/schemas/order-entry-txn-definition-subtotal-detailRequiredProperties' examples: Creates a new subtotal detail for Order entry transaction definition: value: order-entry-txn-definition: key: '64' subtotalType: discount description: discount appliedToLineNumber: 1 isApportioned: false glAccount: id: '1000' offsetGLAccount: id: '1000.01' valueType: percent txnType: debit isTax: false responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-txn-definition-subtotal-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New transaction definition subtotal detail object: value: ia::result: key: '113' id: '113' href: /objects/order-entry/txn-definition-subtotal-detail/113 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/txn-definition-subtotal-detail/{key}: parameters: - name: key description: >- System-assigned unique key for the transaction definition subtotal detail object. in: path required: true schema: type: string get: summary: Get a transaction definition subtotal detail object description: >- Returns detailed information for a specified transaction definition subtotal detail object. tags: - Order_Entry_Transaction definition subtotal details operationId: get-order-entry-txn-definition-subtotal-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the transaction definition subtotal detail object properties: ia::result: $ref: '#/components/schemas/order-entry-txn-definition-subtotal-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a transaction definition subtotal detail object: value: ia::result: key: '98' id: '98' order-entry-txn-definition: key: '64' id: Sales Order href: /objects/order-entry-txn-definition/64 subtotalType: discount lineNumber: 0 description: Discount valueType: amount isApportioned: false txnType: debit appliedToLineNumber: 1 isTax: false glAccount: key: '3' id: '1000' href: /objects/gl-account/3 offsetGLAccount: key: '160' id: '1000.01' href: /objects/gl-account/160 enableAvalaraTax: false ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a transaction definition subtotal detail object description: >- Updates an existing transaction definition subtotal detail object by setting field values. Any fields not provided remain unchanged. tags: - Order_Entry_Transaction definition subtotal details operationId: update-order-entry-txn-definition-subtotal-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-txn-definition-subtotal-detail' - type: object properties: id: readOnly: true examples: Update a transaction definition subtotal detail object: value: order-entry-txn-definition: key: '64' subtotalType: discount txnType: credit responses: '200': description: OK content: application/json: schema: type: object title: Updated Order entry transaction definition subtotal details properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated transaction definition subtotal detail object: value: ia::result: key: '94' id: '94' href: /objects/order-entry/txn-definition-subtotal-detail/94 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a transaction definition subtotal detail object description: Deletes a transaction definition subtotal detail object. tags: - Order_Entry_Transaction definition subtotal details operationId: delete-order-entry-txn-definition-subtotal-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/billing-schedule: get: summary: List billing schedules description: >- Returns a collection with a key, ID, and link for each order entry billing schedule. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Order_Entry_Billing schedules operationId: list-order-entry-billing-schedule responses: '200': description: OK content: application/json: schema: type: object title: List of billing schedules properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List billing schedules: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/billing-schedule/{key}: parameters: - name: key description: System-assigned unique key for the billing schedule. in: path required: true schema: type: string get: summary: Get a billing schedule description: >- Returns detailed information for a specified order entry billing schedule. tags: - Order_Entry_Billing schedules operationId: get-order-entry-billing-schedule-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the billing schedule properties: ia::result: $ref: '#/components/schemas/order-entry-billing-schedule' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a billing schedule: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/price-schedule: get: summary: List price schedules description: >- Returns a collection with a key, ID, and link for each order entry price schedule. tags: - Order_Entry_Price schedules operationId: list-order-entry-price-schedule responses: '200': description: OK content: application/json: schema: type: object title: List price-schedules properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List price schedules: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a price schedule description: Creates a new order entry price schedule. tags: - Order_Entry_Price schedules operationId: create-order-entry-price-schedule requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-price-schedule' - $ref: '#/components/schemas/order-entry-price-scheduleRequiredProperties' examples: Create a price schedule: {} responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-price-schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New order entry price schedule: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/price-schedule/{key}: parameters: - name: key description: System-assigned unique key for the price schedule. in: path required: true schema: type: string get: summary: Get a price schedule description: Returns detailed information for a specified order entry price schedule. tags: - Order_Entry_Price schedules operationId: get-order-entry-price-schedule-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the price schedule properties: ia::result: $ref: '#/components/schemas/order-entry-price-schedule' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a price schedule: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a price schedule description: >- Updates an existing order entry price schedule by setting field values. Any fields not provided remain unchanged. tags: - Order_Entry_Price schedules operationId: update-order-entry-price-schedule-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-price-schedule' - type: object properties: id: readOnly: true examples: Update a price schedule: {} responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-price-schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated price schedule: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a price schedule description: Deletes an order entry price schedule. tags: - Order_Entry_Price schedules operationId: delete-order-entry-price-schedule-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/renewal-template: get: summary: List renewal templates description: >- Returns a collection with a key, ID, and link for each order entry renewal template. tags: - Order_Entry_Renewal templates operationId: list-order-entry-renewal-template responses: '200': description: OK content: application/json: schema: type: object title: List of renewal templates properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List renewal templates: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a renewal template description: Creates a new order entry renewal template. tags: - Order_Entry_Renewal templates operationId: create-order-entry-renewal-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-renewal-template' - $ref: '#/components/schemas/order-entry-renewal-templateRequiredProperties' examples: Creates a renewal template: {} responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-renewal-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New renewal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/renewal-template/{key}: parameters: - name: key description: System-assigned unique key for the renewal template. in: path required: true schema: type: string get: summary: Get a renewal template description: >- Returns detailed information for a specified order entry renewal template. tags: - Order_Entry_Renewal templates operationId: get-order-entry-renewal-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the renewal template properties: ia::result: $ref: '#/components/schemas/order-entry-renewal-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a renewal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a renewal template description: >- Updates an existing order entry renewal template by setting field values. Any fields not provided remain unchanged. tags: - Order_Entry_Renewal templates operationId: update-order-entry-renewal-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-renewal-template' - type: object properties: id: readOnly: true examples: Updates a renewal template: {} responses: '200': description: OK content: application/json: schema: type: object title: Updated renewal template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated renewal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a renewal template description: Deletes an order entry renewal template. tags: - Order_Entry_Renewal templates operationId: delete-order-entry-renewal-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/subtotal-template: get: summary: List subtotal templates description: >- Returns a collection with a key, ID, and link for each order entry subtotal template. tags: - Order_Entry_Subtotal templates operationId: list-order-entry-subtotal-template responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-subtotal-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List subtotal templates: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a subtotal template description: Creates a new order entry subtotal template. tags: - Order_Entry_Subtotal templates operationId: create-order-entry-subtotal-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-subtotal-template' - $ref: '#/components/schemas/order-entry-subtotal-templateRequiredProperties' examples: Creates a subtotal template: {} responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-subtotal-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New order entry subtotal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/order-entry/subtotal-template/{key}: parameters: - name: key description: System-assigned unique key for the subtotal template. in: path required: true schema: type: string get: summary: Get a subtotal template description: >- Returns detailed information for a specified order entry subtotal template. tags: - Order_Entry_Subtotal templates operationId: get-order-entry-subtotal-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the subtotal template properties: ia::result: $ref: '#/components/schemas/order-entry-subtotal-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a subtotal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a subtotal template description: >- Updates an existing order entry subtotal template by setting field values. Any fields not provided remain unchanged. tags: - Order_Entry_Subtotal templates operationId: update-order-entry-subtotal-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/order-entry-subtotal-template' - type: object properties: id: readOnly: true examples: Update a subtotal template: {} responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-subtotal-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated subtotal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a subtotal template description: Deletes an order entry subtotal template. tags: - Order_Entry_Subtotal templates operationId: delete-order-entry-subtotal-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/project: get: summary: List projects description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each project. 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
SubscriptionProjects
User ypeBusiness, Employee, Project Manager
PermissionsList Projects
tags: - Project_and_Resource_Management_Projects operationId: list-projects-project responses: '200': description: OK content: application/json: schema: type: object title: List of project objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of projects: value: ia::result: - key: '100' id: P-040 href: /objects/projects/project/100 - key: '101' id: P-050 href: /objects/projects/project/101 - key: '102' id: P-060 href: /objects/projects/project/102 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a project description: >+ Creates a new project. `id` is required if document sequencing is not enabled for projects in the company. If document sequencing is enabled, you can provide an `id` value to use instead of the document sequence value.
Permissions and other requirements
SubscriptionProjects
User ypeBusiness, Project Manager
PermissionsAdd Projects
tags: - Project_and_Resource_Management_Projects operationId: create-projects-project requestBody: description: Project to be created required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-project' - $ref: '#/components/schemas/projects-projectRequiredProperties' examples: Create a project: value: id: P-0045 name: Implementation Project description: Software Implementation Project projectCurrency: USD category: contract projectStatus: key: '1' startDate: '2021-01-23' EndDate: '2021-01-23' budget: id: '1' key: '1' billingAmount: '10000' budgetedDuration: '250' budgetedCost: '10000' contractAmount: '15000' progress: estimatedDuration: '200' actualDuration: '183' approvedDuration: '175' remainingDuration: '8' percentComplete: '35' observedPercentComplete: '50' billingType: timeAndMaterial salesOrderNumber: SO-5478 purchaseOrderNumber: PO-7829 purchaseOrderAmount: '4500' purchaseQuoteNumber: '1453' salesforceKey: '1' documentNumber: '1453' parent: key: '10' id: P-0040 name: NET-XML30-2 invoiceWithParent: false customer: key: '13' salesContact: key: '10' projectType: key: '3' manager: key: '10' department: key: '10' location: key: '1' paymentTerm: key: '10' customerUser: key: '1' class: key: '1' userRestrictions: systemDefault isBillableEmployeeExpense: false isBillablePurchasingAPExpense: false ratesAndPricing: laborPricing: billingRate laborMarkup: '10' pricing: billingRate expenseMarkup: '10' DefaultRate: '12' contacts: primary: key: '1' billTo: key: '1' shipTo: key: '1' invoiceMessage: Invoice for project invoiceCurrency: USD billingOverMax: preventBilling excludeExpenses: false contract: key: '1' attachment: key: '1' rootProject: key: '12' grant: aln: 10.555 fundedProjectName: Undergraduate Programs agency: US government payer: federal otherId: Other assistanceType: cash revenueRestriction: time restrictionExpiry: '1' restrictionExpirationDate: '2021-01-23' isTimeSatisfactionScheduled: false status: active responses: '201': description: Created content: application/json: schema: type: object title: New project properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New project created: value: ia::result: key: '100' id: P-0045 href: /objects/projects/project/100 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/project/{key}: parameters: - name: key description: System-assigned key for the project. in: path required: true example: '635' schema: type: string get: summary: Get a project description: >+ Returns detailed information for a specified project.
Permissions and other requirements
SubscriptionProjects
User ypeBusiness, Employee, Project Manager
PermissionsView Projects
tags: - Project_and_Resource_Management_Projects operationId: get-projects-project-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the project properties: ia::result: $ref: '#/components/schemas/projects-project' ia::meta: $ref: '#/components/schemas/metadata' examples: Project details: value: ia::result: key: '83' id: P-0045 name: Implementation Project description: Software Implementation Project projectCurrency: USD category: contract projectStatus: key: '1' id: In Progress disableGenerateInvoice: false disablePurchasingAPEntry: false disableExpenseEntry: false disableTimesheetEntry: false startDate: '2021-01-23' endDate: '2021-01-23' budget: id: '1' key: '1' billingAmount: '10000' budgetedDuration: '250' budgetedCost: '10000' contractAmount: '15000' progress: estimatedDuration: '200' actualDuration: '183' approvedDuration: '175' remainingDuration: '8' percentComplete: '35' observedPercentComplete: '50' billingType: timeAndMaterial salesOrderNumber: SO-5478 purchaseOrderNumber: PO-7829 purchaseOrderAmount: '4500' purchaseQuoteNumber: '1453' salesforceKey: '1' documentNumber: '1453' parent: key: '10' id: P-0040 name: NET-XML30-2 invoiceWithParent: false customer: key: '13' id: '113' name: Software company salesContact: key: '10' id: '100' projectType: key: '3' id: Internal manager: key: '10' id: E10 department: key: '10' id: '20' name: Sales location: key: '1' id: '1' name: US paymentTerm: key: '10' id: '10' customerUser: key: '1' id: Admin class: key: '1' id: '10' name: Construction userRestrictions: systemDefault isBillableEmployeeExpense: false isBillablePurchasingAPExpense: false ratesAndPricing: laborPricing: billingRate laborMarkup: '10' pricing: billingRate expenseMarkup: '10' defaultRate: '12' contacts: primary: key: '1' id: '1' name: Dave billTo: key: '1' id: '1' name: Larry shipTo: key: '1' id: '1' name: Larry invoiceMessage: Invoice for project invoiceCurrency: USD billingOverMax: preventBilling excludeExpenses: false contract: key: '1' id: CON-002 attachment: key: '1' id: '1' href: /objects/company-config/attachment/100 rootProject: key: '12' id: '12' name: PRJ-RT-0001 grant: aln: 10.555 fundedProjectName: Undergraduate Programs agency: US government payer: federal otherId: Other assistanceType: cash revenueRestriction: time restrictionExpiry: '1' restrictionExpirationDate: '2021-01-23' isTimeSatisfactionScheduled: false status: active audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a project description: >+ Updates an existing project by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionProjects
User ypeBusiness, Project Manager
PermissionsEdit Projects
tags: - Project_and_Resource_Management_Projects operationId: update-projects-project-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-project' - type: object properties: id: readOnly: true examples: Updates a project: value: name: Implementation Project description: Software Implementation Project projectCurrency: USD category: contract responses: '200': description: OK content: application/json: schema: type: object title: Updated project properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated project: value: ia::result: key: '124' id: P-0345 href: /objects/projects/project/124 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a project description: >+ Deletes a project. You can only delete projects without posted transactions. If posted transactions exist for the project, you can make the project inactive but cannot delete it.
Permissions and other requirements
SubscriptionProjects
User ypeBusiness, Project Manager
PermissionsDelete Projects
tags: - Project_and_Resource_Management_Projects operationId: delete-projects-project-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/project-resource: get: summary: List project resources description: Returns a collection with a key, ID, and link for each project resource. tags: - Project_and_Resource_Management_Project resources operationId: list-projects-project-resource responses: '200': description: OK content: application/json: schema: type: object title: List of project-resource objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of project resource: value: ia::result: - key: '12345' id: '12345' href: /objects/projects/project-resource/12345 - key: '85' id: EXP-00002 href: /objects/projects/employee-expense/85 - key: '60' id: EXP-00003 href: /objects/projects/employee-expense/60 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a project resource description: Creates a new project resource. tags: - Project_and_Resource_Management_Project resources operationId: create-projects-project-resource requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-project-resource' - $ref: '#/components/schemas/projects-project-resourceRequiredProperties' examples: Creates a project resource: value: description: Hourly resource startDate: '2023-04-01' employee: key: '244' item: key: '23' pricing: laborRate: 100 expenseRate: 110 apPurchasingRate: 120 project: key: '23' responses: '201': description: Created content: application/json: schema: type: object title: New project-resource properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New project resource: value: ia::result: key: '12345' id: '12345' href: /objects/projects/project-resource/12345 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/project-resource/{key}: parameters: - name: key description: system-assigned unique key for the project resource. in: path required: true schema: type: string get: summary: Get a project resource description: Returns detailed information for a particular project resource. tags: - Project_and_Resource_Management_Project resources operationId: get-projects-project-resource-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the project-resource properties: ia::result: $ref: '#/components/schemas/projects-project-resource' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the project resource: value: ia::result: key: '23' id: '23' href: /objects/projects/project-resource/23 description: Hourly resource startDate: '2023-04-01' employee: href: /objects/company-config/employee/23 key: '244' id: jsmith startDate: '2022-01-01' endDate: '2023-01-01' employeeContact: key: '977' id: John Smith firstName: John lastName: Smith href: /objects/company-config/contact/977 item: href: /objects/inventory-control/item/23 key: '23' id: B002 name: Monitor-Acer pricing: laborPricingMethod: billingRate laborRate: 100 expensePricingMethod: billingRate expenseRate: 100 apPurchasingPricingMethod: costPlusFee apPurchasingRate: 120 project: href: /objects/projects/project/23 key: '23' id: P-0045 name: Implementation Project audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a project resource description: >- Updates an existing project resource by setting field values. Any fields not provided remain unchanged. tags: - Project_and_Resource_Management_Project resources operationId: update-projects-project-resource-key requestBody: content: application/json: schema: $ref: '#/components/schemas/projects-project-resource' examples: Updates a project resource: value: description: Project resource responses: '200': description: OK content: application/json: schema: type: object title: Updated project-resource properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated project resource: value: ia::result: key: '12345' id: ID123 href: /objects/projects/project-resource/12345 ia::meta: totalCount: 3 totalSuccess: 2 totalError: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a project resource description: Deletes a project resource. tags: - Project_and_Resource_Management_Project resources operationId: delete-projects-project-resource-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/project-status: get: summary: List project statuses description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each project status. 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
SubscriptionProjects Basic Project Tracking and General Ledger (enable the Projects dimension)
User ypeBusiness, Employee, Project Manager
PermissionsList Project Status
tags: - Project_and_Resource_Management_Project statuses operationId: list-projects-project-status responses: '200': description: OK content: application/json: schema: type: object title: List of project statuses properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of project statuses: value: ia::result: - key: '100' id: In Progress href: /objects/projects/project-status/100 - key: '101' id: Completed href: /objects/projects/project-status/101 - key: '102' id: Started href: /objects/projects/project-status/102 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a project status description: >+ Creates a new project status.
Permissions and other requirements
SubscriptionProjects Basic Project Tracking and General Ledger (enable the Projects dimension)
User ypeBusiness, Project Manager
PermissionsAdd Project Status
tags: - Project_and_Resource_Management_Project statuses operationId: create-projects-project-status requestBody: description: Project status to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-project-status' - $ref: '#/components/schemas/projects-project-statusRequiredProperties' examples: Creates a project status: value: id: In Progress description: Current status disableTimeSheetEntry: false disableExpenseEntry: false disablePurchasingAPEntry: false disableGenerateInvoice: false status: active responses: '201': description: Created content: application/json: schema: type: object title: New project status properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New project status: value: ia::result: key: '1' id: In Progress href: /objects/projects/project-status/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/project-status/{key}: parameters: - name: key description: System-assigned key for the project status. in: path required: true example: '1038' schema: type: string get: summary: Get a project status description: >+ Returns detailed information for a specified project status.
Permissions and other requirements
SubscriptionProjects Basic Project Tracking and General Ledger (enable the Projects dimension)
User ypeBusiness, Employee, Project Manager
PermissionsView Project Status
tags: - Project_and_Resource_Management_Project statuses operationId: get-projects-project-status-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the project status properties: ia::result: $ref: '#/components/schemas/projects-project-status' ia::meta: $ref: '#/components/schemas/metadata' examples: Project status details: value: ia::result: key: '1' id: In Progress description: In progress disableTimeSheetEntry: false disableExpenseEntry: false disablePurchasingAPEntry: false disableGenerateInvoice: false status: active audit: createdDateTime: '2022-04-01T16:20:00Z' modifiedDateTime: '2022-04-01T16:20:00Z' createdBy: '1' modifiedBy: '95' href: /objects/projects/project-status/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a project status description: >+ Updates an existing project status by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionProjects Basic Project Tracking and General Ledger (enable the Projects dimension)
User ypeBusiness, Project Manager
PermissionsEdit Project Status
tags: - Project_and_Resource_Management_Project statuses operationId: update-projects-project-status-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-project-status' - type: object properties: id: readOnly: true examples: Disable timesheet entry: value: disableTimesheetEntry: true responses: '200': description: OK content: application/json: schema: type: object title: Project status updated properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated project status: value: ia::result: key: '1' id: In Progress href: /objects/projects/project-status/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a project status description: >+ Deletes a project status.
Permissions and other requirements
SubscriptionProjects Basic Project Tracking and General Ledger (enable the Projects dimension)
User ypeBusiness, Project Manager
PermissionsDelete Project Status
tags: - Project_and_Resource_Management_Project statuses operationId: delete-projects-project-status-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/project-type: get: summary: List project types description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each project type. 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
SubscriptionProjects Basic Project Tracking and General Ledger (enable the Projects dimension)
User ypeBusiness, Employee, Project Manager
PermissionsList Project Types
tags: - Project_and_Resource_Management_Project types operationId: list-projects-project-type responses: '200': description: OK content: application/json: schema: type: object title: List of project types properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List project types: value: ia::result: - key: '100' id: Internal href: /objects/projects/project-type/100 - key: '101' id: External href: /objects/projects/project-type/101 - key: '102' id: Contract href: /objects/projects/project-type/102 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a project type description: >+ Creates a new project type.
Permissions and other requirements
SubscriptionProjects Basic Project Tracking and General Ledger (enable the Projects dimension)
User ypeBusiness, Project Manager
PermissionsAdd Project Type
tags: - Project_and_Resource_Management_Project types operationId: create-projects-project-type requestBody: description: project type to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-project-type' - $ref: '#/components/schemas/projects-project-typeRequiredProperties' examples: Creates a project type: value: id: Internal parent: key: '12' status: active responses: '201': description: Created content: application/json: schema: type: object title: New project type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New project type: value: ia::result: key: '1' id: Internal href: /objects/projects/project-type/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/project-type/{key}: parameters: - name: key description: System-assigned key for the project type. in: path required: true example: '956' schema: type: string get: summary: Get a project type description: >+ Returns detailed information for a specified project type.
Permissions and other requirements
SubscriptionProjects Basic Project Tracking and General Ledger (enable the Projects dimension)
User ypeBusiness, Employee, Project Manager
PermissionsView Project Type
tags: - Project_and_Resource_Management_Project types operationId: get-projects-project-type-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the project type properties: ia::result: $ref: '#/components/schemas/projects-project-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Project type details: value: ia::result: key: '1' id: Internal parent: key: '100' id: Billable href: /objects/projects/project-type/100 status: active audit: createdDateTime: '2022-04-01T16:20:00Z' modifiedDateTime: '2022-04-01T16:20:00Z' createdBy: '1' modifiedBy: '95' href: /objects/projects/project-type/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a project type description: >+ Updates an existing project type by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionProjects Basic Project Tracking and General Ledger (enable the Projects dimension)
User ypeBusiness, Project Manager
PermissionsEdit Project Type
tags: - Project_and_Resource_Management_Project types operationId: update-projects-project-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-project-type' - type: object properties: id: readOnly: true examples: Set status to inactive: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Project type updated properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated project type: value: ia::result: key: '1' id: Internal href: /objects/projects/project-type/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a project type description: >+ Deletes a project type.
Permissions and other requirements
SubscriptionProjects Basic Project Tracking and General Ledger (enable the Projects dimension)
User ypeBusiness, Project Manager
PermissionsEdit Project Type
tags: - Project_and_Resource_Management_Project types operationId: delete-projects-project-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/task: get: summary: List tasks description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each task. This operation is mostly for use in testing; use query to find tasks that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionProjects
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsList Tasks
tags: - Project_and_Resource_Management_Tasks operationId: list-projects-task responses: '200': description: OK content: application/json: schema: type: object title: List of task objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of tasks: value: ia::result: - key: '1' id: T-1 href: /objects/projects/task/1 - key: '2' id: T-2 href: /objects/projects/task/2 - key: '3' id: T-3 href: /objects/projects/task/3 ia::meta: totalCount: 3 start: 1 pageSize: 3 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a task description: |+ Creates a new project task.
Permissions and other requirements
SubscriptionProjects
User ypeBusiness, Project Manager
PermissionsAdd Tasks
tags: - Project_and_Resource_Management_Tasks operationId: create-projects-task requestBody: description: New task definition required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-task' - $ref: '#/components/schemas/projects-taskRequiredProperties' examples: Creates a task: value: id: Task-1 name: General Overhead project: id: NET-XML30-1 status: planned responses: '201': description: Created content: application/json: schema: type: object title: New task properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New task: value: ia::result: key: '6' id: '6' href: /objects/projects/task/6 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/task/{key}: parameters: - name: key description: System-assigned key for the task. in: path required: true schema: type: string get: summary: Get a task description: >+ Returns detailed information for a specified task.
Permissions and other requirements
SubscriptionProjects
User ypeBusiness, Employee, Project Manager, Warehouse
PermissionsView Tasks
tags: - Project_and_Resource_Management_Tasks operationId: get-projects-task-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the task properties: ia::result: $ref: '#/components/schemas/projects-task' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the task: value: ia::result: key: '1' id: T-1 parent: key: '11' id: T-11 name: Cabinet design href: /objects/projects/task/11 name: Project Task project: key: '1' id: NET-XML30-1 name: Created by XML 3.0 startDate: '2023-02-25' endDate: '2023-04-25' href: /objects/projects/project/56 customer: key: '1' id: '101' name: Corley Energy href: /objects/accounts-receivable/customer/41 productionUnits: estimate: 1200 description: linear feet siding item: key: '311' id: Project Item 1 name: Extension pack href: /objects/inventory-control/item/311 planned: startDate: '2023-02-25' endDate: '2023-06-25' actual: startDate: '2023-02-25' endDate: '2023-11-25' duration: planned: 100 estimated: 100 actual: 0 remaining: 0 approved: 0 plannedBillable: 0 estimatedBillable: 0 actualBillable: 0 approvedBillable: 0 percentComplete: 0.25 observerPercentComplete: 0.3 description: Task Description isMilestone: false isUtilized: false isBillable: false wbsCode: '1' priority: 1 status: inProgress timeType: key: '2' id: overtime href: /objects/time/time-type/2 class: key: '19' id: DES name: Design href: /objects/company-config/class/19 audit: createdDateTime: '2021-08-12T17:25:29Z' modifiedDateTime: '2021-08-12T17:25:29Z' createdBy: '1' modifiedBy: '1' dependentOn: key: '1' id: T-1 name: Design review href: /objects/projects/task/1 root: key: '1' id: ID1 name: Task 1 href: /objects/projects/task/1 standardTask: key: '1' id: '1' name: '1' href: /objects/construction/standard-task/1 attachment: id: '1' href: /objects/projects/task/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a task description: >+ Updates an existing task by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionProjects
User ypeBusiness, Project Manager
PermissionsEdit Tasks
tags: - Project_and_Resource_Management_Tasks operationId: update-projects-task-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-task' - type: object properties: id: readOnly: true project: readOnly: true examples: Updates a task: value: status: completed duration: estimated: 27 responses: '200': description: OK content: application/json: schema: type: object title: Updated task properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated task: value: ia::result: key: '6' id: T-6 href: /objects/projects/task/6 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a task description: |+ Deletes a task.
Permissions and other requirements
SubscriptionProjects
User ypeBusiness, Project Manager
PermissionsDelete Tasks
tags: - Project_and_Resource_Management_Tasks operationId: delete-projects-task-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/task-resource: get: summary: List task resources description: >- Returns up to 100 object references from the collection with a key, ID, and link for each task resource. This operation is mostly for use in testing; use query to find task resources that meet certain criteria and to specify properties that are returned. tags: - Project_and_Resource_Management_Task resources operationId: list-projects-task-resource responses: '200': description: OK content: application/json: schema: type: object title: List of task-resource objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of task resources: value: ia::result: - key: '110' id: '110' href: /objects/projects/task-resource/110 - key: '2374' id: '2374' href: /objects/projects/task-resource/2374 - key: '33' id: '33' href: /objects/projects/task-resource/33 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a task resource description: Creates a new task resource. tags: - Project_and_Resource_Management_Task resources operationId: create-projects-task-resource requestBody: description: Task resource to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-task-resource' - $ref: '#/components/schemas/projects-task-resourceRequiredProperties' examples: Creates a task resource: value: planned: startDate: '2023-01-01' endDate: '2023-06-30' actual: startDate: '2023-01-08' endDate: '2023-04-01' duration: budget: 22 estimated: 20 actual: 17 approved: 18 remaining: 8 percentComplete: 50 description: Resource of task RR-27-Q5 isFullTime: true isSoftBook: true employee: key: '23' project: id: Q-Field task: id: RR-27-Q5 responses: '201': description: Created content: application/json: schema: type: object title: New task-resource properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New task resource: value: ia::result: key: '40' id: '40' href: /objects/projects/task-resource/40 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/task-resource/{key}: parameters: - name: key description: System-assigned unique key for the task resource. in: path required: true example: '215' schema: type: string get: summary: Get a task resource description: Returns detailed information for a specified task resource. tags: - Project_and_Resource_Management_Task resources operationId: get-projects-task-resource-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the task-resource properties: ia::result: $ref: '#/components/schemas/projects-task-resource' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the task resource: value: ia::result: key: '23' id: '23' href: /objects/projects/task-resource/23 planned: startDate: '2023-01-01' endDate: '2023-06-30' actual: startDate: '2023-01-08' endDate: '2023-04-01' duration: budget: 22 estimated: 20 actual: 17 approved: 18 remaining: 8 percentComplete: 50 description: Resource of task RR-27-Q5 isFullTime: true isSoftBook: true employee: href: /objects/company-config/employee/23 key: '23' id: jsmith startDate: '2023-04-01' endDate: '2024-04-01' employeeContact: key: '977' id: John Smith firstName: John lastName: Smith href: /objects/company-config/contact/977 project: href: /objects/projects/project/23 key: '23' id: Q-Field name: Quantum Field Repair task: href: /objects/projects/task/23 key: '23' id: RR-27-Q5 name: Adjust flux capacitor isBillable: true audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 3 totalSuccess: 2 totalError: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a task resource description: >- Updates an existing task resource by setting field values. Any fields not provided remain unchanged. tags: - Project_and_Resource_Management_Task resources operationId: update-projects-task-resource-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-task-resource' - type: object properties: project: readOnly: true task: readOnly: true examples: Updates a task resource: value: description: Resource of task RR-27-Q5 responses: '200': description: OK content: application/json: schema: type: object title: Updated task-resource properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Task resource updated: value: ia::result: key: '40' id: '40' href: /objects/projects/task-resource/40 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a task resource description: Deletes a task resource. tags: - Project_and_Resource_Management_Task resources operationId: delete-projects-task-resource-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee-rate: get: summary: List employee rates description: Returns a collection with a key, ID, and link for each employee rate. tags: - Project_and_Resource_Management_Employee rates operationId: list-projects-employee-rate responses: '200': description: OK content: application/json: schema: type: object title: List of employee-rate objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of employee rates: value: ia::result: - key: '1' id: '1' href: /objects/company-config/employee-rate/1 - key: '3' id: '3' href: /objects/company-config/employee-rate/3 - key: '5' id: '5' href: /objects/company-config/employee-rate/5 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee-rate/{key}: parameters: - name: key description: system-assigned unique key for the employee rate. in: path required: true schema: type: string get: summary: Get a/an employee rate description: Returns detailed information for a particular employee rate. tags: - Project_and_Resource_Management_Employee rates operationId: get-projects-employee-rate-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee-rate properties: ia::result: $ref: '#/components/schemas/company-config-employee-rate' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the employee rate: value: ia::result: id: '111' key: '111' employee: key: '1' id: '1' name: 1099 Int href: /objects/company-config/employee/1 hourlyRate: '50001' annualSalary: null startDate: '2023-01-01' endDate: '2023-12-31' href: /objects/company-config/employee-rate/111 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee rate record description: Deletes an employee rate record tags: - Project_and_Resource_Management_Employee rates operationId: delete-company-config-employee-rate-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/position-skill: get: summary: List position skills description: Returns a collection with a key, ID, and link for each position skill. tags: - Project_and_Resource_Management_Position skills operationId: list-projects-position-skill responses: '200': description: OK content: application/json: schema: type: object title: List of position-skill objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of position skills: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a position skill description: Creates a new position skill. tags: - Project_and_Resource_Management_Position skills operationId: create-projects-position-skill requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-position-skill' - $ref: '#/components/schemas/projects-position-skillRequiredProperties' examples: Creates a position skill: {} responses: '201': description: Created content: application/json: schema: type: object title: New position-skill properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New position skill: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/position-skill/{key}: parameters: - name: key description: system-assigned unique key for the position skill. in: path required: true schema: type: string get: summary: Get a/an position skill description: Returns detailed information for a particular position skill. tags: - Project_and_Resource_Management_Position skills operationId: get-projects-position-skill-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the position-skill properties: ia::result: $ref: '#/components/schemas/projects-position-skill' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the position skill: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a/an position skill description: >- Updates an existing position skill by setting field values. Any fields not provided remain unchanged. tags: - Project_and_Resource_Management_Position skills operationId: update-projects-position-skill-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-position-skill' - type: object properties: id: readOnly: true examples: Updates a/an position skill: {} responses: '200': description: OK content: application/json: schema: type: object title: Updated position-skill properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated position skill: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a position skill description: Deletes a position skill. tags: - Project_and_Resource_Management_Position skills operationId: delete-projects-position-skill-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/project-billing-template: get: summary: List billing templates description: Returns a collection with a key, ID, and link for each billing template. tags: - Project_and_Resource_Management_Project billing templates operationId: list-projects-project-billing-template responses: '200': description: OK content: application/json: schema: type: object title: List of project billing template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of billing templates: value: ia::result: - key: '12' id: '12' href: /objects/projects/project-billing-template/12 - key: '13' id: '13' href: /objects/projects/project-billing-template/13 - key: '14' id: '14' href: /objects/projects/project-billing-template/14 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a project billing template description: Creates a new project billing template. tags: - Project_and_Resource_Management_Project billing templates operationId: create-projects-project-billing-template requestBody: description: Create a project billing template required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-project-billing-template' - $ref: '#/components/schemas/projects-project-billing-templateRequiredProperties' examples: Creates a project billing template: value: name: Project Estimated Hours description: Template for billing by estimated project hours billingMethod: percentCompleted calculateOn: project basedOn: plannedHours status: active milestones: - percentCompleted: '0.1' description: Project Estimated Hours responses: '201': description: Created content: application/json: schema: type: object title: New project billing template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New billing template: value: ia::result: key: '15' id: '15' href: /objects/projects/project-billing-template/15 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/projects/project-billing-template/{key}: parameters: - name: key description: system-assigned unique key for the billing template. in: path required: true schema: type: string get: summary: Get a billing template description: Returns detailed information for a particular billing template. tags: - Project_and_Resource_Management_Project billing templates operationId: get-projects-project-billing-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the project billing template properties: ia::result: $ref: '#/components/schemas/projects-project-billing-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the billing template: value: ia::result: key: '15' id: '15' href: /objects/projects/project-billing-template/15 name: Project Estimated Hours description: Template for billing by estimated project hours billingMethod: percentCompleted calculateOn: project basedOn: plannedHours status: active milestones: - key: '23' id: '23' percentCompleted: '0.5' percentToInvoice: '0.5' description: Bill at 50% completion href: '/objects/projects/project-billing-template-milestone/23' projectBillingTemplate: key: '15' id: '15' href: /objects/projects/project-billing-template/15 - key: '24' id: '24' percentCompleted: '1' percentInvoiced: '0.5' description: Bill at 100% completion href: '/objects/projects/project-billing-template-milestone/23' projectBillingTemplate: key: '15' id: '15' href: /objects/projects/project-billing-template/15 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a billing template description: >- Updates an existing billing template by setting field values. Any fields not provided remain unchanged. tags: - Project_and_Resource_Management_Project billing templates operationId: update-projects-project-billing-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/projects-project-billing-template' - type: object properties: name: readOnly: true examples: Updates a billing template: value: description: Bill by actual project hours responses: '200': description: OK content: application/json: schema: type: object title: Updated project billing template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated billing template: value: ia::result: key: '12' id: '12' href: /objects/projects/project-billing-template/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a billing template description: Deletes a billing template. tags: - Project_and_Resource_Management_Project billing templates operationId: delete-projects-project-billing-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/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 purchasing price list. This operation is mostly for use in testing; use query to find objects that meet certain criteria and specify the properties that are returned.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsList, View Price Lists
tags: - Purchasing_Price lists operationId: list-purchasing-price-list responses: '200': description: OK content: application/json: schema: type: object title: List of 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: '2' id: Purchase Price List href: /objects/purchasing/price-list/2 - key: '6' id: Base Price List Purchase href: /objects/purchasing/price-list/6 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a price list description: >+ Creates a new purchasing price list.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness, Warehouse
PermissionsList, View, Add Price Lists
tags: - Purchasing_Price lists operationId: create-purchasing-price-list requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/purchasing-price-list' - $ref: '#/components/schemas/purchasing-price-listRequiredProperties' examples: Create a price list: value: id: Base Price List Purchase startDate: '2000-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: '6' id: Base Price List Purchase href: /objects/purchasing/price-list/6 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/price-list/{key}: parameters: - name: key description: System-assigned key for the purchasing price list. in: path required: true schema: type: string get: summary: Get a price list description: >+ Returns detailed information for a specified purchasing price list.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsList, View Price Lists
tags: - Purchasing_Price lists operationId: get-purchasing-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/purchasing-price-list' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a price list: value: ia::result: key: '6' id: Base Price List Purchase startDate: '2000-01-01' endDate: '2030-12-31' status: active href: /objects/purchasing/price-list/6 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a price list description: >+ Updates an existing purchasing price list by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness, Warehouse
PermissionsList, View, Edit Price Lists
tags: - Purchasing_Price lists operationId: update-purchasing-price-list-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/purchasing-price-list' - type: object properties: id: readOnly: true example: Base Price List Purchase examples: Update a price list: value: startDate: '2021-01-01' endDate: '2100-01-01' responses: '200': description: OK content: application/json: schema: type: object title: Update a purchasing-price-list properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated price list: value: ia::result: key: '6' id: Base Price List Purchase href: /objects/purchasing/price-list/6 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a price list description: >+ Deletes a purchasing 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
SubscriptionPurchasing
User ypeBusiness, Warehouse
PermissionsList, View, Delete Price Lists
tags: - Purchasing_Price lists operationId: delete-purchasing-price-list-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/price-schedule: get: summary: List price schedules description: >+ Returns a collection with a key, ID, and link for each purchasing price schedule. This operation is mostly for use in testing; use query to find objects that meet certain criteria and specify the properties that are returned.
Permissions and other requirements
SubscriptionPurchasing
Configurationnull
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsList, View Price Schedules
tags: - Purchasing_Price schedules operationId: list-purchasing-price-schedule responses: '200': description: OK content: application/json: schema: type: object title: List purchasing price schedule objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List price schedules: value: ia::result: - key: '3' id: Robotic Price Schedule href: /objects/purchasing/price-schedule/3 - key: '5' id: Acme Price Schedule href: /objects/purchasing/price-schedule/5 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a price schedule description: >+ Creates a new purchasing price schedule.
Permissions and other requirements
SubscriptionPurchasing
Configurationnull
User ypeBusiness
PermissionsList, View, Add Price Schedules
tags: - Purchasing_Price schedules operationId: create-purchasing-price-schedule requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/purchasing-price-schedule' - $ref: '#/components/schemas/purchasing-price-scheduleRequiredProperties' examples: Create a price schedule: value: id: Acme Price Schedule description: Acme Discount Schedule discountPercent: '10' status: active responses: '201': description: Created content: application/json: schema: type: object title: New purchasing-price-schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New price schedule: value: ia::result: key: '3' id: Acme Price Schedule href: /objects/purchasing/price-schedule/3 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/price-schedule/{key}: parameters: - name: key description: System-assigned key for the price schedule. in: path required: true schema: type: string get: summary: Get a price schedule description: >+ Returns detailed information for a specified purchasing price schedule.
Permissions and other requirements
SubscriptionPurchasing
Configurationnull
User ypeBusiness, Project Manager, Employee, Warehouse
PermissionsList, View Price Schedules
tags: - Purchasing_Price schedules operationId: get-purchasing-price-schedule-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the purchasing-price-schedule properties: ia::result: $ref: '#/components/schemas/purchasing-price-schedule' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a price schedule: value: ia::result: key: '3' id: Acme Price Schedule description: Acme Discount Schedule discountPercent: '10' status: active href: /objects/purchasing/price-schedule/3 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a price schedule description: >+ Updates an existing purchasing price schedule by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionPurchasing
Configurationnull
User ypeBusiness
PermissionsList, View, Edit Price Schedules
tags: - Purchasing_Price schedules operationId: update-purchasing-price-schedule-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/purchasing-price-schedule' - type: object properties: id: readOnly: true examples: Update a single value: value: discountPercent: '15' responses: '200': description: OK content: application/json: schema: type: object title: Updated purchasing-price-schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated price schedule: value: ia::result: key: '3' id: Acme Price Schedule href: /objects/purchasing/price-schedule/3 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a price schedule description: >+ Deletes a purchasing price schedule. A price schedule can be deleted if it is no longer in use and it needs to be removed from the system.
Permissions and other requirements
SubscriptionPurchasing
Configurationnull
User ypeBusiness
PermissionsList, View, Delete Price Schedules
tags: - Purchasing_Price schedules operationId: delete-purchasing-price-schedule-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/txn-definition: get: summary: List purchasing transaction definitions description: >- This API operation retrieves a list of all Purchasing Transaction Definitions in the system. It returns a collection with a key, ID, and link for each purchasing transaction definition. This operation is primarily used for testing purposes; for more specific results, use query parameters to find objects that meet certain criteria and to specify properties that are returned. tags: - Purchasing_Purchasing transaction definitions operationId: list-purchasing-txn-definition responses: '200': description: OK content: application/json: schema: type: object title: List of Purchasing Transaction definition objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List purchasing transaction definitions: value: ia::result: - key: '23' id: PO Receiver Invoice href: /objects/purchasing/txn-definition/23 - key: '1' id: Purchase Requisition href: /objects/purchasing/txn-definition/1 - key: '2' id: Vendor Invoice href: /objects/purchasing/txn-definition/2 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a purchasing transaction definition description: Creates a new purchasing transaction definition. tags: - Purchasing_Purchasing transaction definitions operationId: post-purchasing-txn-definition requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/purchasing-txn-definition' - $ref: '#/components/schemas/purchasing-txn-definitionRequiredProperties' examples: Create a purchasing transaction definition: value: id: Purchase Order docClass: order workflowCategory: order description: Purchasing Txn definition for P&G entitySettingDetail: - enableNumberingSequence: false entity: key: '4' id: Central Region documentSequence: key: '39' id: 6777_ACH_BatchNo preserveNumberingSequence: false canInheritSourceDocumentNumber: false enableCreateTransactionRule: true showExpandedTaxDetail: false enableOverrideTax: false enableLineLevelSimpleTax: false responses: '201': description: Created content: application/json: examples: Create a purchasing transaction definition: value: ia::result: key: '100' href: /objects/purchasing-txn-definition/100 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 schema: type: object title: New customer properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/txn-definition/{key}: parameters: - name: key description: System-assigned unique key for the purchasing transaction definition. in: path required: true schema: type: string get: summary: Get a purchasing transaction definition description: >- Returns detailed information for a particular purchasing transaction definition. It requires a system-assigned key as a parameter to identify the purchasing transaction definition. The returned data includes all properties and settings related to the specified purchasing transaction definition. This operation is typically used when there's a need to view or edit the details of a specific purchasing transaction definition. tags: - Purchasing_Purchasing transaction definitions operationId: get-purchasing-txn-definition-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the purchasing transaction definition properties: ia::result: $ref: '#/components/schemas/purchasing-txn-definition' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the purchasing transaction definition: value: ia::result: key: '96' id: Purchase Order docClass: order workflowCategory: order description: PO TD enableUserOrGroupPermmission: false editPolicy: noEdit deletePolicy: noDelete enableNumberingSequence: false preserveNumberingSequence: false inheritDocumentNumber: false inventoryUpdateType: 'no' increaseOrDecreaseInventory: increase txnPostingMethod: noPosting disableTax: false partialConvertMethod: closeTransaction affectsCost: false overrideExchangeRateType: true showBaseCurrency: false overridePrice: true enableSubtotals: true showExpandedTaxDetails: false enableOverrideTax: false allowLocationOverride: true allowDepartmentOverride: true contactOneTitle: Pay to printPayToContact: false allowEditingPayToContact: false contactThreeTitle: Return to contactTwoTitle: Return to printReturnToContact: false allowEditingReturnToContact: false printDeliverToContact: false allowEditingDeliverToContact: false enableWarnOnLowQuantity: true enableCreditLimitCheck: false warehouseSelectionMethod: sortByID status: active postToGL: false enableAllocations: false audit: createdDateTime: '2024-03-05T06:09:23Z' modifiedDateTime: '2024-03-14T05:53:16Z' createdBy: '1' modifiedBy: '1' documentConversionPolicy: newDocumentOrConvert multiEntityRuleForTransaction: topLevelOrEntity lineLevelSimpleTax: false customerVendorEditRule: never enableAdditionalInformationScope: false enableAdditionalInformationSchedule: false enableInternalReference: false enableExternalReference: false enableBond: false inventoryTotalDetail: - id: '207' key: '207' purchasingTxnDefinition: key: '96' id: Purchase Order href: /objects/purchasing/txn-definition/96 maintainType: quantity inventoryTotal: id: DAMAGED key: '55' href: /objects/inventory-control/total/55 operation: subtract href: '/objects/purchasing/txn-definition-inventory-total-detail/207' subtotalDetail: - id: '202' key: '202' purchasingTxnDefinition: key: '96' id: Purchase Order href: /objects/purchasing/txn-definition/96 subtotalType: charge lineNumber: 0 description: PO valueType: amount isApportioned: true appliedToLineNumber: 0 isTax: false enableAvalaraTax: false href: '/objects/purchasing/txn-definition-subtotal-detail/202' - id: '203' key: '203' purchasingTxnDefinition: key: '96' id: Purchase Order href: /objects/purchasing/txn-definition/96 subtotalType: discount lineNumber: 1 description: discount valueType: percent isApportioned: true appliedToLineNumber: 0 isTax: false enableAvalaraTax: false href: '/objects/purchasing/txn-definition-subtotal-detail/203' sourceDocumentDetail: - id: '79' key: '79' purchasingTxnDefinition: key: '96' id: Purchase Order href: /objects/purchasing/txn-definition/96 sourceDocument: key: '6' id: PO Receiver href: /objects/purchasing/txn-definition/6 href: '/objects/purchasing/txn-definition-source-document-detail/79' entitySettingDetail: - id: '301' key: '301' purchasingTxnDefinition: key: '96' id: Purchase Order href: /objects/purchasing/txn-definition/96 entity: key: '2' id: Western Region href: /objects/company-config/entity/2 enableNumberingSequence: false documentSequence: key: '39' id: 6777_ACH_BatchNo href: /objects/company-config/document-sequence/39 preserveNumberingSequence: false canInheritSourceDocumentNumber: false enableCreateTransactionRule: true showExpandedTaxDetail: false enableOverrideTax: false enableLineLevelSimpleTax: false href: '/objects/purchasing/txn-definition-entity-setting-detail/301' - id: '302' key: '302' purchasingTxnDefinition: key: '96' id: Purchase Order href: /objects/purchasing/txn-definition/96 entity: key: '4' id: Central Region href: /objects/company-config/entity/4 enableNumberingSequence: false documentSequence: key: '39' id: 6777_ACH_BatchNo href: /objects/company-config/document-sequence/39 preserveNumberingSequence: false canInheritSourceDocumentNumber: false enableCreateTransactionRule: true showExpandedTaxDetail: false enableOverrideTax: false enableLineLevelSimpleTax: true href: '/objects/purchasing/txn-definition-entity-setting-detail/302' href: /objects/purchasing/txn-definition/96 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a purchasing transaction definition description: >- This API operation allows for partial updates to an existing purchasing transaction definition. It accepts a JSON object that contains the fields to be updated and their new values. Fields not included in the request will remain unchanged. This operation is typically used for modifying specific attributes of a purchasing transaction definition without altering the rest of the object. tags: - Purchasing_Purchasing transaction definitions operationId: update-purchasing-txn-definition-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/purchasing-txn-definition' - type: object properties: id: readOnly: true examples: Updates a purchasing transaction definition: value: description: Purchase requisition for P&G entitySettingDetail: - key: '239' ia::operation: delete - key: '240' preserveNumberingSequence: true responses: '200': description: OK content: application/json: schema: type: object title: Updated purchasing transaction definition properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updatd purchasing transaction definition: value: ia::result: key: '97' href: /objects/purchasing/txn-definition/97 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a purchasing transaction definition description: >- This API operation permanently removes a specified Purchasing Transaction Definition from the system. It requires a system-assigned key as a parameter to identify the purchasing transaction definition to be deleted. This operation is typically used when a purchasing transaction definition is no longer needed or relevant. Please note that this operation is irreversible and should be used with caution. tags: - Purchasing_Purchasing transaction definitions operationId: delete-purchasing-txn-definition-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/subtotal-template: get: summary: List subtotal templates description: >- Returns a collection with a key, ID, and link for each purchasing subtotal template. tags: - Purchasing_Subtotal templates operationId: list-purchasing-subtotal-template responses: '200': description: OK content: application/json: schema: type: object title: List of subtotal template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List subtotal templates: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a subtotal template description: Creates a new purchasing subtotal template. tags: - Purchasing_Subtotal templates operationId: create-purchasing-subtotal-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/purchasing-subtotal-template' - $ref: '#/components/schemas/purchasing-subtotal-templateRequiredProperties' examples: Creates a subtotal template: {} responses: '201': description: Created content: application/json: schema: type: object title: New subtotal template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New subtotal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/subtotal-template/{key}: parameters: - name: key description: System-assigned unique key for the subtotal template. in: path required: true schema: type: string get: summary: Get a subtotal template description: >- Returns detailed information for a specified purchasing subtotal template. tags: - Purchasing_Subtotal templates operationId: get-purchasing-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/purchasing-subtotal-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a subtotal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a subtotal template description: >- Updates an existing purchasing subtotal template by setting field values. Any fields not provided remain unchanged. tags: - Purchasing_Subtotal templates operationId: update-purchasing-subtotal-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/purchasing-subtotal-template' - type: object properties: id: readOnly: true examples: Updates a subtotal template: {} responses: '200': description: OK content: application/json: schema: type: object title: Updated subtotal template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated subtotal template: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a subtotal template description: Deletes a subtotal template. tags: - Purchasing_Subtotal templates operationId: delete-purchasing-subtotal-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/document: get: summary: List documents description: >- Returns a collection with a key, ID, and link for each purchasing document. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Purchasing_Documents operationId: list-purchasing-document responses: '200': description: OK content: application/json: schema: type: object title: List document objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/document/{key}: parameters: - schema: type: string name: key in: path required: true get: summary: Get a document description: Returns detailed information for a specified purchasing document. tags: - Purchasing_Documents operationId: get-purchasing-document-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the document properties: ia::result: $ref: '#/components/schemas/purchasing-document' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/document::{documentName}: get: summary: List named documents description: >- Returns a collection with a key, ID, and link for each purchasing document with the specified name. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Purchasing_Documents operationId: list-purchasing-named-document responses: '200': description: OK content: application/json: schema: type: object title: List of document objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a document description: Creates a new purchasing document. tags: - Purchasing_Documents operationId: create-purchasing-named-document requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/purchasing-document' - $ref: '#/components/schemas/purchasing-documentRequiredProperties' responses: '201': description: Created content: application/json: schema: type: object title: New document properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] parameters: - $ref: '#/components/parameters/documentName' /objects/purchasing/document::{documentName}/{key}: parameters: - name: key description: System-assigned unique key for the document. in: path required: true schema: type: string - $ref: '#/components/parameters/documentName' get: summary: Get a named document description: Returns detailed information for a specified purchasing document. tags: - Purchasing_Documents operationId: get-purchasing-named-document-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the document properties: ia::result: $ref: '#/components/schemas/purchasing-document' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a document description: >- Updates an existing purchasing document by setting field values. Any fields not provided remain unchanged. tags: - Purchasing_Documents operationId: update-purchasing-named-document-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/purchasing-document' - type: object properties: id: readOnly: true responses: '200': description: OK content: application/json: schema: type: object title: Updated purchasing-document properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a document description: Deletes a purchasing document. tags: - Purchasing_Documents operationId: delete-purchasing-named-document-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/document-line: get: summary: List document lines description: >- Returns a collection with a key, ID, and link for each document line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Purchasing_Document lines operationId: list-purchasing-document-line responses: '200': description: OK content: application/json: schema: type: object title: List of document line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/document-line/{key}: parameters: - schema: type: string name: key in: path required: true get: summary: Get a document line description: Returns detailed information for a specified purchasing document line. tags: - Purchasing_Document lines operationId: get-purchasing-document-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the document line properties: ia::result: $ref: '#/components/schemas/purchasing-document-line' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/document-line::{documentName}: get: summary: List named document lines description: >- Returns a collection with a key, ID, and link for each named purchasing document line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Purchasing_Document lines operationId: list-purchasing-named-document-line responses: '200': description: OK content: application/json: schema: type: object title: List of document line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a document line description: Creates a new purchasing document line. tags: - Purchasing_Document lines operationId: create-purchasing-named-document-line requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/purchasing-document-line' - $ref: '#/components/schemas/purchasing-document-lineRequiredProperties' responses: '201': description: Created content: application/json: schema: type: object title: New document line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] parameters: - $ref: '#/components/parameters/documentName' /objects/purchasing/document-line::{documentName}/{key}: parameters: - name: key description: System-assigned unique key for the document line. in: path required: true schema: type: string - $ref: '#/components/parameters/documentName' get: summary: Get a named document line description: Returns detailed information for a specified purchasing document line. tags: - Purchasing_Document lines operationId: get-purchasing-named-document-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the document line properties: ia::result: $ref: '#/components/schemas/purchasing-document-line' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a document line description: >- Updates an existing purchasing document line by setting field values. Any fields not provided remain unchanged. tags: - Purchasing_Document lines operationId: update-purchasing-named-document-line-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/purchasing-document-line' - type: object properties: id: readOnly: true responses: '200': description: OK content: application/json: schema: type: object title: Updated document line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a document line description: Deletes a purchasing document line. tags: - Purchasing_Document lines operationId: delete-purchasing-named-document-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/document-subtotal: get: summary: List document subtotals description: >- Returns a collection with a key, ID, and link for each purchasing document subtotal. tags: - Purchasing_Document subtotals operationId: list-purchasing-document-subtotal responses: '200': description: OK content: application/json: schema: type: object title: List of 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: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/purchasing/document-subtotal/{key}: parameters: - name: key description: System-assigned unique key for the document subtotal. in: path required: true schema: type: string get: summary: Get a document subtotal description: >- Returns detailed information for a specified purchasing document subtotal. tags: - Purchasing_Document subtotals operationId: get-purchasing-document-subtotal-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the purchasing-document-subtotal properties: ia::result: $ref: '#/components/schemas/purchasing-document-subtotal' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document subtotal: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/order-entry-tax-detail: get: summary: List Order Entry tax details description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each Order Entry tax detail. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness
PermissionsList, View Tax Detail
tags: - Tax_Order Entry tax details operationId: list-tax-order-entry-tax-detail responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-tax-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List Order Entry tax details: value: ia::result: - key: '82' id: UK Sale Goods Exempt Rate href: /objects/tax/order-entry-tax-detail/82 - key: '83' id: UK Sale Goods Reduced Rate href: /objects/tax/order-entry-tax-detail/83 - key: '84' id: UK Sale Goods Standard Rate href: /objects/tax/order-entry-tax-detail/84 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an Order Entry tax detail description: >+ Creates a new Order Entry tax detail.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness
PermissionsList, View, Add Tax Detail
tags: - Tax_Order Entry tax details operationId: create-tax-order-entry-tax-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-order-entry-tax-detail' - $ref: '#/components/schemas/tax-order-entry-tax-detailRequiredProperties' examples: Create an Order Entry tax detail: value: id: UK General Export Reduced Rate taxUniqueId: GB.ECOutput_GB.ExemptGB.VAT description: Reduced Rate for UK General Export taxPercent: 10.02 taxLimit: minTax: 10 maxTax: 150 minTaxable: 10 maxTaxable: 2000 amountToTax: fullAmount salesGLAccount: id: '1200.01' taxAuthority: id: California taxSolution: id: United Kingdom - VAT status: active taxRate: standard useExpenseAccount: false responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-tax-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New Order Entry tax detail: value: ia::result: key: '308' id: UK General Export Reduced Rate href: /objects/tax/order-entry-tax-detail/308 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/order-entry-tax-detail/{key}: parameters: - name: key description: System-assigned unique key for the Order Entry tax detail. in: path required: true schema: type: integer example: 308 get: summary: Get an Order Entry tax detail description: |+ Returns detailed information for a specified Order Entry tax detail.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness
PermissionsList, View Tax Detail
tags: - Tax_Order Entry tax details operationId: get-tax-order-entry-tax-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order-entry-tax-detail properties: ia::result: $ref: '#/components/schemas/tax-order-entry-tax-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an Order Entry tax detail: value: ia::result: key: '308' id: UK General Export Reduced Rate taxUniqueId: GB.ECOutput_GB.ExemptGB.VAT description: Reduced Rate for UK General Export taxPercent: 10.02 taxLimit: minTax: 10 maxTax: 150 minTaxable: 10 maxTaxable: 2000 amountToTax: fullAmount salesGLAccount: id: 1200.01--Accounts Receivable - a/c label offset accountLabel: id: Accounting Fees key: '14' taxAuthority: id: California key: '24' href: /objects/tax/tax-authority/24 status: active isSystemGenerated: false reverseCharge: false taxRate: standard taxSolution: id: United Kingdom - VAT key: '1' href: /objects/tax/tax-solution/1 useExpenseAccount: false href: /objects/tax/order-entry-tax-detail/308 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an Order Entry tax detail description: >+ Updates an existing Order Entry tax detail by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness
PermissionsList, View, Edit Tax Detail
tags: - Tax_Order Entry tax details operationId: update-tax-order-entry-tax-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-order-entry-tax-detail' - type: object properties: id: readOnly: true examples: Update a single value: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-tax-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated order entry tax detail: value: ia::result: key: '308' id: UK General Export Reduced Rate href: /objects/tax/order-entry-tax-detail/308 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an Order Entry tax detail description: >+ Deletes an Order Entry tax detail. Delete user-created tax details that are no longer needed. Deleted tax details are removed from the system and can't be recovered.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness
PermissionsList, View, Delete Tax Detail
tags: - Tax_Order Entry tax details operationId: delete-tax-order-entry-tax-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/order-entry-tax-schedule: get: summary: List Order Entry tax schedules description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each Order Entry tax schedule. This operation is mostly for use in testing; use query to find objects that meet certain criteria and specify the properties that are returned.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness
PermissionsList, View Tax Schedules
tags: - Tax_Order Entry tax schedules operationId: list-tax-order-entry-tax-schedule responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-tax-schedule objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List Order Entry tax schedules: value: ia::result: - key: '8' id: '8' href: /objects/tax/order-entry-tax-schedule/8 - key: '9' id: '9' href: /objects/tax/order-entry-tax-schedule/9 - key: '10' id: '10' href: /objects/tax/order-entry-tax-schedule/10 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an Order Entry tax schedule description: >+ Creates a new Order Entry tax schedule.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness
PermissionsList, View, Add Tax Schedules
tags: - Tax_Order Entry tax schedules operationId: create-tax-order-entry-tax-schedule requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-order-entry-tax-schedule' - $ref: '#/components/schemas/tax-order-entry-tax-scheduleRequiredProperties' examples: Create an Order Entry tax schedule: value: name: TaxSched-00004 description: Sales Tax for New York taxSolution: key: 10 status: active lines: - taxDetail: id: New York Sales Tax effectiveDate: '2022-02-26' responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-tax-schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New Order Entry tax schedule: value: ia::result: key: '308' id: '308' href: /objects/tax/order-entry-tax-schedule/308 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/order-entry-tax-schedule/{key}: parameters: - name: key description: System-assigned unique key for the Order Entry tax schedule. in: path required: true schema: type: string example: '162' get: summary: Get an Order Entry tax schedule description: |+ Returns detailed information for a specified Order Entry tax schedule.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness
PermissionsList, View Tax Schedules
tags: - Tax_Order Entry tax schedules operationId: get-tax-order-entry-tax-schedule-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order-entry-tax-schedule properties: ia::result: $ref: '#/components/schemas/tax-order-entry-tax-schedule' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an Order Entry tax schedule: value: ia::result: id: '162' name: Sales Tax New York key: '162' description: Sales Tax for New York status: active isSystemGenerated: false taxSolution: id: Avalara Tax key: '1' href: /objects/tax/tax-solution/1 lines: - taxSchedule: key: '162' id: '162' name: Sales Tax New York href: /objects/tax/order-entry-tax-schedule/162 key: '44' id: '44' taxDetail: id: New York State Sales Tax key: '22' href: /objects/tax/order-entry-tax-detail/22 effectiveDate: '2022-02-03' href: /objects/tax/order-entry-tax-schedule-detail/44 href: /objects/tax/order-entry-tax-schedule/162 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an Order Entry tax schedule description: >+ Updates an existing Order Entry tax schedule by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness
PermissionsList, View, Edit Tax Schedules
tags: - Tax_Order Entry tax schedules operationId: update-tax-order-entry-tax-schedule-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-order-entry-tax-schedule' - type: object properties: id: readOnly: true example: '162' examples: Update a single value: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-tax-schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated order entry tax schedule: value: ia::result: key: '162' href: /objects/tax/order-entry-tax-schedule/162 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an Order Entry tax schedule description: >+ Deletes an Order Entry tax schedule. Delete a tax schedule if it is no longer needed. Deleting a tax schedule removes it from the system so that it can't be recovered.
Permissions and other requirements
SubscriptionOrder Entry
User ypeBusiness
PermissionsList, View, Delete Tax Schedules
tags: - Tax_Order Entry tax schedules operationId: delete-tax-order-entry-tax-schedule-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/purchasing-tax-detail: get: summary: List Purchasing tax details description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each purchasing tax detail. 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
SubscriptionPurchasing
User ypeBusiness
PermissionsList, View Tax Detail
tags: - Tax_Purchasing tax details operationId: list-tax-purchasing-tax-detail responses: '200': description: OK content: application/json: schema: type: object title: List of purchasing-tax-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List Purchasing tax details: value: ia::result: - key: '4' id: State Tax Arkansas href: /objects/tax/purchasing-tax-detail/4 - key: '2' id: State Tax Alaska href: /objects/tax/purchasing-tax-detail/2 - key: '3' id: State Tax Arizona href: /objects/tax/purchasing-tax-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 Purchasing tax detail description: >+ Creates a new Purchasing tax detail.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness
PermissionsList, View, Add Tax Detail
tags: - Tax_Purchasing tax details operationId: create-tax-purchasing-tax-detail requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-purchasing-tax-detail' - $ref: '#/components/schemas/tax-purchasing-tax-detailRequiredProperties' examples: Create a new Purchasing tax detail: value: id: UK Import Services Standard Rate taxUniqueId: GB.ECOutput_GB.ExemptGB.VAT description: Standard Rate for UK Import Services taxPercent: 10.02 taxLimit: minTax: 10 maxTax: 150 minTaxable: 10 maxTaxable: 2000 amountToTax: fullAmount purchaseGLAccount: id: '1200.01' taxAuthority: id: California taxSolution: id: United Kingdom - VAT status: active taxRate: standard useExpenseAccount: false responses: '201': description: Created content: application/json: schema: type: object title: New purchasing-tax-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New Purchasing tax detail: value: ia::result: key: '304' id: Purchasing Tax Detail New href: /objects/tax/purchasing-tax-detail/304 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/purchasing-tax-detail/{key}: parameters: - name: key description: System-assigned unique key for the Purchasing tax detail. in: path required: true schema: type: integer example: 304 get: summary: Get a Purchasing tax detail description: |+ Returns detailed information for a specified Purchasing tax detail.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness
PermissionsList, View Tax Detail
tags: - Tax_Purchasing tax details operationId: get-tax-purchasing-tax-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the purchasing-tax-detail properties: ia::result: $ref: '#/components/schemas/tax-purchasing-tax-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a Purchasing tax detail: value: ia::result: key: '304' id: UK Import Services Standard Rate taxUniqueId: GB.ECOutput_GB.ExemptGB.VAT description: Standard Rate for UK Import Services taxPercent: 10.02 taxLimit: minTax: 10 maxTax: 150 minTaxable: 10 maxTaxable: 2000 amountToTax: fullAmount purchaseGLAccount: id: 1200.01--Accounts Receivable - a/c label offset key: '57' href: /objects/account/57 taxAuthority: id: California key: '24' href: /objects/tax/tax-authority/24 status: active isSystemGenerated: false reverseCharge: false taxRate: standard taxSolution: id: United Kingdom - VAT key: '1' href: /objects/tax/tax-solution/1 useExpenseAccount: false href: /objects/tax/purchasing-tax-detail/304 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a Purchasing tax detail description: >+ Updates an existing Purchasing tax detail by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness
PermissionsList, View, Edit Tax Detail
tags: - Tax_Purchasing tax details operationId: update-tax-purchasing-tax-detail-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-purchasing-tax-detail' - type: object properties: id: readOnly: true examples: Update a single value: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Updated purchasing-tax-detail properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated Purchasing tax detail: value: ia::result: key: '304' id: UK Import Services Standard Rate href: /objects/tax/purchasing-tax-detail/304 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a Purchasing tax detail description: >+ Deletes a Purchasing tax detail. Delete user-created tax details that are no longer needed. Deleted tax details are removed from the system and can't be recovered.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness
PermissionsList, View, Delete Tax Detail
tags: - Tax_Purchasing tax details operationId: delete-tax-purchasing-tax-detail-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/purchasing-tax-schedule: get: summary: List Purchasing tax schedules description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each Accounts Receivable tax schedule. This operation is mostly for use in testing; use query to find objects that meet certain criteria and specify the properties that are returned.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness
PermissionsList, View Tax Schedules
tags: - Tax_Purchasing tax schedules operationId: list-tax-purchasing-tax-schedule responses: '200': description: OK content: application/json: schema: type: object title: List of purchasing-tax-schedule objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List Purchasing tax schedules: value: ia::result: - key: '1' id: '1' href: /objects/tax/purchasing-tax-schedule/1 - key: '2' id: '2' href: /objects/tax/purchasing-tax-schedule/2 - key: '3' id: '3' href: /objects/tax/purchasing-tax-schedule/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a Purchasing tax schedule description: >+ Creates a new Purchasing tax schedule.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness
PermissionsList, View, Add Tax Schedules
tags: - Tax_Purchasing tax schedules operationId: create-tax-purchasing-tax-schedule requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-purchasing-tax-schedule' - $ref: '#/components/schemas/tax-purchasing-tax-scheduleRequiredProperties' examples: Create a Purchasing tax schedule: value: name: TaxSched-00005 description: Purchase Tax for New York City taxSolution: key: 10 status: active lines: - taxDetail: id: New York City Sales Tax effectiveDate: '2022-02-26' responses: '201': description: Created content: application/json: schema: type: object title: New purchasing-tax-schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New Purchasing tax schedule: value: ia::result: key: '308' id: '308' href: /objects/tax/purchasing-tax-schedule/308 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/purchasing-tax-schedule/{key}: parameters: - name: key description: System-assigned unique key for the Purchasing tax schedule. in: path required: true schema: type: string example: '162' get: summary: Get a Purchasing tax schedule description: |+ Returns detailed information for a specified Purchasing tax schedule.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness
PermissionsList, View Tax Schedules
tags: - Tax_Purchasing tax schedules operationId: get-tax-purchasing-tax-schedule-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the purchasing-tax-schedule properties: ia::result: $ref: '#/components/schemas/tax-purchasing-tax-schedule' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a Purchasing tax schedule: value: ia::result: name: Tax Florida id: '165' key: '165' description: Purchase tax for Florida status: active isSystemGenerated: false taxSolution: id: Avalara Tax key: '1' href: /objects/tax/tax-solution/1 lines: - taxSchedule: key: '165' id: '165' name: Tax Florida href: /objects/tax/purchasing-tax-schedule/165 key: '44' id: '44' taxDetail: id: Sales Tax Florida key: '22' href: /objects/tax/purchasing-tax-detail/22 effectiveDate: '2022-02-03' href: /objects/tax/purchasing-tax-schedule-detail/44 href: /objects/tax/purchasing-tax-schedule/167 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a Purchasing tax schedule description: >+ Updates an existing Purchasing tax schedule by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness
PermissionsList, View, Edit Tax Schedules
tags: - Tax_Purchasing tax schedules operationId: update-tax-purchasing-tax-schedule-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-purchasing-tax-schedule' - type: object properties: id: readOnly: true example: '162' examples: Update a single value: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Updated purchasing-tax-schedule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated Purchasing tax schedule: value: ia::result: key: '162' href: /objects/tax/purchasing-tax-schedule/162 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a Purchasing tax schedule description: >+ Deletes a Purchasing tax schedule. Delete a tax schedule if it is no longer needed. Deleting a tax schedule removes it from the system so that it can't be recovered.
Permissions and other requirements
SubscriptionPurchasing
User ypeBusiness
PermissionsList, View, Delete Tax Schedules
tags: - Tax_Purchasing tax schedules operationId: delete-tax-purchasing-tax-schedule-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/tax-authority: get: summary: List Tax Authorities description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each tax authority. 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
SubscriptionAccounts Receivable, Order Entry, Purchasing
User ypeBusiness
PermissionsList, View Tax Authority
tags: - Tax_Tax authorities operationId: list-tax-tax-authority responses: '200': description: OK content: application/json: schema: type: object title: List of tax-authority objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of tax authorities: value: ia::result: - key: '2' id: Alaska href: /objects/tax/tax-authority/2 - key: '5' id: California href: /objects/tax/tax-authority/5 - key: '3' id: Arizona href: /objects/tax/tax-authority/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a tax authority description: >+ Creates a new tax authority.
Permissions and other requirements
SubscriptionAccounts Receivable, Order Entry, Purchasing
User ypeBusiness
PermissionsList, View, Add Tax Authority
tags: - Tax_Tax authorities operationId: create-tax-tax-authority requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-tax-authority' - $ref: '#/components/schemas/tax-tax-authorityRequiredProperties' examples: Create a tax authority: value: id: Texas description: Texas tax authority vendorId: Vendor_Visa_C parent: id: '5' responses: '201': description: Created content: application/json: schema: type: object title: Create a tax-authority properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a tax authority: value: ia::result: key: '105' id: Texas href: /objects/tax/tax-authority/105 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/tax-authority/{key}: parameters: - name: key description: System-assigned key for the tax authority. in: path required: true schema: type: integer example: 105 get: summary: Get a tax authority description: >+ Returns detailed information for a specified tax authority.
Permissions and other requirements
SubscriptionAccounts Receivable, Order Entry, Purchasing
User ypeBusiness
PermissionsList, View Tax Authority
tags: - Tax_Tax authorities operationId: get-tax-tax-authority-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the tax-authority properties: ia::result: $ref: '#/components/schemas/tax-tax-authority' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a tax authority: value: ia::result: key: '105' id: Texas description: Texas tax authority vendorId: Vendor_Visa_C parent: name: California href: /objects/tax/tax-authority/24 href: /objects/tax/tax-authority/105 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a tax authority description: >+ Updates an existing tax authority by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAccounts Receivable, Order Entry, Purchasing
User ypeBusiness
PermissionsList, View, Edit Tax Authority
tags: - Tax_Tax authorities operationId: update-tax-tax-authority-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-tax-authority' - type: object properties: id: readOnly: true examples: Update a single value: value: description: Updated description responses: '200': description: OK content: application/json: schema: type: object title: Updated tax-authority properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: key: '105' id: Texas href: /objects/tax/tax-authority/105 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a tax authority description: >+ Delete a tax authority that is no longer in use. After a tax authority is deleted, it can't be recovered.
Permissions and other requirements
SubscriptionAccounts Receivable, Order Entry, Purchasing
User ypeBusiness
PermissionsList, View, Delete Tax Authority
tags: - Tax_Tax authorities operationId: delete-tax-tax-authority-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/contact-tax-group: get: summary: List contact tax groups description: >- Returns a collection with a key, ID, and link for each contact tax group. 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: - Tax_Contact tax groups operationId: list-tax-contact-tax-group responses: '200': description: OK content: application/json: schema: type: object title: List of contact-tax-group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List contact tax groups: value: ia::result: - key: '1' id: Auto Contact Tax href: /objects/tax/contact-tax-group/1 - key: '2' id: Electronic Contact Tax href: /objects/tax/contact-tax-group/2 - key: '3' id: Gardening Contact Tax href: /objects/tax/contact-tax-group/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a contact tax group description: Creates a new contact tax group. tags: - Tax_Contact tax groups operationId: create-tax-contact-tax-group requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-contact-tax-group' - $ref: '#/components/schemas/tax-contact-tax-groupRequiredProperties' examples: Create a contact tax group: value: id: Auto Contact Tax taxSolution: id: '1' responses: '201': description: Created content: application/json: schema: type: object title: New contact-tax-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a contact tax group: value: ia::result: key: '1' id: Auto Contact Tax href: /objects/tax/contact-tax-group/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/contact-tax-group/{key}: parameters: - name: key description: system-assigned unique key for the contact tax group. in: path required: true schema: type: string get: summary: Get a contact tax group description: Returns detailed information for a particular contact tax group. tags: - Tax_Contact tax groups operationId: get-tax-contact-tax-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the contact-tax-group properties: ia::result: $ref: '#/components/schemas/tax-contact-tax-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the contact tax group: value: ia::result: key: '126' id: Australian Export Customers href: /objects/tax/contact-tax-group/126 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an contact tax group description: >- Updates an existing contact tax group by setting field values. Any fields not provided remain unchanged. tags: - Tax_Contact tax groups operationId: update-tax-contact-tax-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-contact-tax-group' - type: object properties: id: readOnly: true examples: Update a contact tax group: value: taxSolution: id: '1' responses: '200': description: OK content: application/json: schema: type: object title: Updated contact-tax-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a contact tax group: value: ia::result: key: '1' id: Auto Contact Tax href: /objects/tax/contact-tax-group/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a contact tax group description: Deletes a contact tax group. tags: - Tax_Contact tax groups operationId: delete-tax-contact-tax-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/item-tax-group: get: summary: List item tax groups description: Returns a collection with a key, ID, and link for each item tax group. tags: - Tax_Item tax groups operationId: list-tax-item-tax-group responses: '200': description: OK content: application/json: schema: type: object title: List of item-tax-group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List item tax group: value: ia::result: - key: '1' id: Auto Item Tax href: /objects/tax/item-tax-group/1 - key: '2' id: Electronic Item Tax href: /objects/tax/item-tax-group/2 - key: '3' id: Gardening Item Tax href: /objects/tax/item-tax-group/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an item tax group description: Creates a new item tax group. tags: - Tax_Item tax groups operationId: create-tax-item-tax-group requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-item-tax-group' - $ref: '#/components/schemas/tax-item-tax-groupRequiredProperties' examples: Create an item tax group: value: id: Auto Item Tax taxSolution: id: '1' responses: '201': description: Created content: application/json: schema: type: object title: New item-tax-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create an item tax group: value: ia::result: key: '1' id: Auto Item Tax href: /objects/tax/item-tax-group/1 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/item-tax-group/{key}: parameters: - name: key description: system-assigned unique key for the item tax group. in: path required: true schema: type: string get: summary: Get an item tax group description: Returns detailed information for a particular item tax group. tags: - Tax_Item tax groups operationId: get-tax-item-tax-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the item-tax-group properties: ia::result: $ref: '#/components/schemas/tax-item-tax-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the item tax groups: value: ia::result: key: '1' id: Auto Item Tax href: /objects/tax/item-tax-group/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an item tax group description: >- Updates an existing item tax group by setting field values. Any fields not provided remain unchanged. tags: - Tax_Item tax groups operationId: update-tax-item-tax-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-item-tax-group' - type: object properties: id: readOnly: true examples: Update an item tax group: value: taxSolution: id: '1' responses: '200': description: OK content: application/json: schema: type: object title: Updated item-tax-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update an item tax group: value: ia::result: key: '1' id: Auto Item Tax href: /objects/tax/item-tax-group/1 ia-meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an item tax group description: Deletes an item tax group. tags: - Tax_Item tax groups operationId: delete-tax-item-tax-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/order-entry-tax-schedule-map: get: summary: List Order Entry tax schedule maps description: >- Returns a collection with a key, ID, and link for each Order Entry tax schedule map. tags: - Tax_Order Entry tax schedule maps operationId: list-tax-order-entry-tax-schedule-map responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-tax-schedule-map objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of Order Entry tax schedule maps: value: ia::result: - key: '2' id: '2' href: /objects/tax/order-entry-tax-schedule-map/2 - key: '15' id: '15' href: /objects/tax/order-entry-tax-schedule-map/15 - key: '12' id: '12' href: /objects/tax/order-entry-tax-schedule-map/12 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an Order Entry tax schedule map description: Creates a new Order Entry tax schedule map. tags: - Tax_Order Entry tax schedule maps operationId: create-tax-order-entry-tax-schedule-map requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-order-entry-tax-schedule-map' - $ref: '#/components/schemas/tax-order-entry-tax-schedule-mapRequiredProperties' examples: Create an Order Entry tax schedule map: value: taxSchedule: name: Alabama Tax itemTaxGroup: id: Auto Tax Group contactTaxGroup: id: Contact Auto Tax txnDefinition: id: Sales Invoice taxSolution: id: United Kingdom - VAT responses: '201': description: Created content: application/json: schema: type: object title: New order-entry-tax-schedule-map properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New Order Entry tax schedule map: value: ia::result: key: '2' id: '2' href: /objects/tax/order-entry-tax-schedule-map/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/order-entry-tax-schedule-map/{key}: parameters: - name: key description: System-assigned unique key for the Order Entry tax schedule map. in: path required: true schema: type: string example: '2' get: summary: Get an Order Entry tax schedule map description: >- Returns detailed information for a specified Order Entry tax schedule map. tags: - Tax_Order Entry tax schedule maps operationId: get-tax-order-entry-tax-schedule-map-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order-entry-tax-schedule-map properties: ia::result: $ref: '#/components/schemas/tax-order-entry-tax-schedule-map' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an Order Entry tax schedule map: value: ia::result: key: '2' id: '2' txnDefinition: id: Sales Invoice key: '130' href: /objects/order-entry/txn-definition/130 itemTaxGroup: id: HW Tax Group key: '1' href: /objects/tax/item-tax-group/1 contactTaxGroup: id: Auto Contact Tax key: '7' href: /objects/tax/contact-tax-group/7 taxSchedule: name: Sales Tax Arkansas key: '13' id: '13' href: /objects/tax/order-entry-tax-schedule/13 isSystemGenerated: false taxSolution: id: United Kingdom - VAT key: '2' href: /objects/tax/tax-solution/1 href: /objects/tax/order-entry-tax-schedule-map/30 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an Order Entry tax schedule map description: >- Updates an existing Order Entry tax schedule map by setting field values. Any fields not provided remain unchanged. tags: - Tax_Order Entry tax schedule maps operationId: update-tax-order-entry-tax-schedule-map-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-order-entry-tax-schedule-map' - type: object properties: id: example: '2' readOnly: true examples: Update an Order Entry tax schedule map: value: contactTaxGroup: id: Contact Tax Group responses: '200': description: OK content: application/json: schema: type: object title: Updated order-entry-tax-schedule-map properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated Order Entry tax schedule map: value: ia::result: key: '2' href: /objects/tax/order-entry-tax-schedule-map/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an Order Entry tax schedule map description: Deletes an Order Entry tax schedule map. tags: - Tax_Order Entry tax schedule maps operationId: delete-tax-order-entry-tax-schedule-map-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/purchasing-tax-schedule-map: get: summary: List Purchasing tax schedule maps description: >- Returns a collection with a key, ID, and link for each Purchasing tax schedule map. tags: - Tax_Purchasing tax schedule maps operationId: list-tax-purchasing-tax-schedule-map responses: '200': description: OK content: application/json: schema: type: object title: List of purchasing-tax-schedule-map objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List Purchasing tax schedule maps: value: ia::result: - key: '2' id: '2' href: /objects/tax/purchasing-tax-schedule-map/2 - key: '15' id: '15' href: /objects/tax/purchasing-tax-schedule-map/15 - key: '12' id: '12' href: /objects/tax/purchasing-tax-schedule-map/12 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a Purchasing tax schedule map description: Creates a new Purchasing tax schedule map. tags: - Tax_Purchasing tax schedule maps operationId: create-tax-purchasing-tax-schedule-map requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-purchasing-tax-schedule-map' - $ref: '#/components/schemas/tax-purchasing-tax-schedule-mapRequiredProperties' examples: Create a Purchasing tax schedule map: value: taxSchedule: name: Alabama Tax itemTaxGroup: id: Auto Tax Group contactTaxGroup: id: Contact Auto Tax txnDefinition: id: Purchase Order taxSolution: id: United Kingdom - VAT responses: '201': description: Created content: application/json: schema: type: object title: New purchasing-tax-schedule-map properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New Purchasing tax schedule map: value: ia::result: key: '2' id: '2' href: /objects/tax/purchasing-tax-schedule-map/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/purchasing-tax-schedule-map/{key}: parameters: - name: key description: System-assigned key for the Purchasing tax schedule map. in: path required: true schema: type: string example: '2' get: summary: Get a Purchasing tax schedule map description: >- Returns detailed information for a specified Purchasing tax schedule map. tags: - Tax_Purchasing tax schedule maps operationId: get-tax-purchasing-tax-schedule-map-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the purchasing-tax-schedule-map properties: ia::result: $ref: '#/components/schemas/tax-purchasing-tax-schedule-map' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a Purchasing tax schedule map: value: ia::result: key: '2' id: '2' txnDefinition: id: Purchase Order key: '114' href: /objects/purchasing/txn-definition/114 itemTaxGroup: id: Auto Tax Group key: '1' href: /objects/tax/item-tax-group/1 contactTaxGroup: id: Auto Contact Tax key: '7' href: /objects/tax/contact-tax-group/7 taxSchedule: name: Tax Arkansas key: '4' id: '4' href: /objects/tax/purchasing-tax-schedule/4 isSystemGenerated: false taxSolution: id: United Kingdom - VAT key: '1' href: /objects/tax/tax-solution/1 href: /objects/tax/purchasing-tax-schedule-map/7 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a Purchasing tax schedule map description: >- Updates an existing Purchasing tax schedule map by setting field values. Any fields not provided remain unchanged. tags: - Tax_Purchasing tax schedule maps operationId: update-tax-purchasing-tax-schedule-map-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-purchasing-tax-schedule-map' - type: object properties: id: example: '2' readOnly: true examples: Update a Purchasing tax schedule map: value: contactTaxGroup: id: Contact Tax Group responses: '200': description: OK content: application/json: schema: type: object title: Updated purchasing-tax-schedule-map properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated Purchasing tax schedule map: value: ia::result: key: '2' href: /objects/tax/purchasing-tax-schedule-map/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a Purchasing tax schedule map description: Deletes a Purchasing tax schedule map. tags: - Tax_Purchasing tax schedule maps operationId: delete-tax-purchasing-tax-schedule-map-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/tax-return: get: summary: List tax returns description: >+ Returns a collection with a key, ID, and link for each tax return. 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
SubscriptionTaxes
User ypeBusiness
PermissionsList Tax Returns
tags: - Tax_Tax returns operationId: list-tax-tax-return responses: '200': description: OK content: application/json: schema: type: object title: List tax returns properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List tax returns: value: ia::result: - key: '9' id: '9' href: /objects/tax/tax-return/9 - key: '54' id: '54' href: /objects/tax/tax-return/54 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a tax return description: |+ Creates a new tax return.
Permissions and other requirements
SubscriptionTaxes
User ypeBusiness
PermissionsAdd Tax Returns
tags: - Tax_Tax returns operationId: create-tax-tax-return requestBody: description: Tax return to be created required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-tax-return' - $ref: '#/components/schemas/tax-tax-returnRequiredProperties' examples: Create a tax return: value: name: VAT_Sub taxSolution: key: '1' taxId: '445025391' recipientEmail: apiuser@sage.com responses: '201': description: Created content: application/json: schema: type: object title: New tax-return properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new tax return: value: ia::result: id: '626' key: '626' href: /objects/tax/tax-return/626 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/tax-return/{key}: parameters: - name: key description: System-assigned unique key for the tax return. in: path required: true schema: type: string get: summary: Get a tax return description: |+ Returns detailed information for a specified tax return.
Permissions and other requirements
SubscriptionTaxes
User ypeBusiness
PermissionsView Tax Returns
tags: - Tax_Tax returns operationId: get-tax-tax-return-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the tax-return properties: ia::result: $ref: '#/components/schemas/tax-tax-return' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a tax return: value: ia::result: id: '9' key: '9' name: Tax return ABCompany Q3 taxId: 30 616 935 623 recipientEmail: first.last@abcompany.com submissionPeriodStartDate: '2019-06-01' submissionPeriodEndDate: '2020-02-29' submissionDate: '2020-03-03' submittersEmail: joe.smith@abcompany.com legalCountryCode: au setEmailAddressAsDefault: true currentStepStage: submit_to_government currentStepStatus: completed_successfully adjustmentNotes: Tested using tax solution bundleNumber: null receiptId: null reportingEntity: key: null id: null taxSolution: id: Australia - GST key: '2' href: /objects/tax/tax-solution/2 submissionType: '' taxProcessingSteps: - stage: prepare_tax_data status: completed_successfully description: 11 records eligible for submission. recentActivityDate: 03/03/2020 - stage: transmit_tax_data status: completed_successfully description: >- Source data successfully transmitted to Sage Regulatory Reporting. Ready to prepare tax return in Regulatory Reporting. recentActivityDate: 03/04/2020 - stage: prepare_tax_return status: completed_successfully description: >- The BAS report was generated. A PDF copy is available in the Related files section of this page. recentActivityDate: 03/04/2020 - stage: submit_to_government status: completed_successfully description: null recentActivityDate: 03/03/2020 - stage: manual_adjustment status: not_applicable description: null recentActivityDate: null relatedFiles: - stage: Prepare source tax data fileName: transactions.json creationDate: 03/03/2020 - stage: Prepare source tax data fileName: business_info.json creationDate: 03/03/2020 - stage: Prepare tax return in Sage Regulatory Reporting fileName: detailed_report.csv creationDate: 03/03/2020 - stage: Prepare tax return in Sage Regulatory Reporting fileName: late_tax-csv creationDate: 03/03/2020 - stage: Submit to government fileName: gst_BAS.pdf creationDate: 03/03/2020 - stage: Submit to government fileName: gst_calculation.pdf creationDate: 03/03/2020 - stage: Submit to government fileName: manual_adjustments.csv creationDate: 03/03/2020 - stage: Submit to government fileName: submitted_source_entries creationDate: 03/03/2020 href: /objects/tax/tax-return/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '201': description: Created '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a tax return description: >+ Updates an existing tax return by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionTaxes
User ypeBusiness
PermissionsEdit Tax Returns
tags: - Tax_Tax returns operationId: update-tax-tax-return-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-tax-return' - type: object properties: id: readOnly: true examples: Update a tax return: value: adjustmentNotes: Tax Submission notes responses: '200': description: OK content: application/json: schema: type: object title: Updated tax-return properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated tax return: value: ia::result: key: '105' id: '105' href: /objects/tax/tax-return/105 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a tax return description: |+ Deletes a tax return.
Permissions and other requirements
SubscriptionTaxes
User ypeBusiness
PermissionsDelete Tax Returns
tags: - Tax_Tax returns operationId: delete-tax-tax-return-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/tax-solution: get: summary: List tax solutions description: >- Returns up to 100 tax solutions from the collection with a key, ID, and link for each solution. This operation is mostly for use in testing; use the query service to find tax solutions that meet certain criteria and specify the properties that are returned. tags: - Tax_Tax solutions operationId: list-tax-tax-solution responses: '200': description: OK content: application/json: schema: type: object title: List of tax-solution objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List tax solutions: value: ia::result: - key: '265' id: Oregon href: /objects/tax/tax-solution/265 - key: '263' id: Alaska href: /objects/tax/tax-solution/263 - key: '264' id: Montana href: /objects/tax/tax-solution/264 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a tax solution description: Creates a new tax solution. tags: - Tax_Tax solutions operationId: create-tax-tax-solution requestBody: description: Tax solution to be created required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-tax-solution' - $ref: '#/components/schemas/tax-tax-solutionRequiredProperties' examples: create: value: id: tax-solution1685477150 description: Tax solution for Australia - GST taxCalculationMethod: VAT status: active taxSolutionType: standard taxSubmissionStartDate: '2019-05-01' enableMultilineTax: false purchaseGLAccount: id: 6450.04--Automobile Repairs salesGLAccount: id: 5015.03--Time Type - Coding alternativeSetup: false responses: '201': description: Created content: application/json: schema: type: object title: Details of the tax solution properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New tax solution created: value: ia::result: key: '13' id: tax-solution1685477150 href: /objects/tax/tax-solution/13 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/tax-solution/{key}: parameters: - name: key description: System-assigned key for the tax solution. in: path required: true example: '43' schema: type: string get: summary: Get a tax solution description: Returns detailed information for a specified tax solution. tags: - Tax_Tax solutions operationId: get-tax-tax-solution-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the tax solution properties: ia::result: $ref: '#/components/schemas/tax-tax-solution' ia::meta: $ref: '#/components/schemas/metadata' examples: GET: value: key: '1' id: Australia - GST description: Tax solution for Australia - GST taxCalculationMethod: VAT status: active taxSolutionType: standard taxSubmissionStartDate: '2019-05-01' enableMultilineTax: false purchaseGLAccount: id: Time Type - Coding salesGLAccount: id: Time Type - Coding alternativeSetup: false lastUpdatedTaxDate: null href: /objects/tax/tax-solution/1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a tax solution description: >- Updates an existing tax solution by setting field values. Any fields not provided remain unchanged. tags: - Tax_Tax solutions operationId: update-tax-tax-solution-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/tax-tax-solution' - type: object properties: id: readOnly: true examples: Updates a tax solution: value: enableMultilineTax: true responses: '200': description: OK content: application/json: schema: type: object title: Updated tax-solution properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Tax solution updated: value: ia::result: key: '312' id: Delaware href: /objects/tax/tax-solution/312 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a tax solution description: Deletes a tax-solution. tags: - Tax_Tax solutions operationId: delete-tax-tax-solution-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/order-entry-tax-schedule-detail: get: summary: List Order Entry tax schedule details description: >- Returns a collection with a key, ID, and link for each Order Entry tax schedule detail. tags: - Tax_Order Entry tax schedule details operationId: list-tax-order-entry-tax-schedule-detail responses: '200': description: OK content: application/json: schema: type: object title: List of order-entry-tax-schedule-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List Order Entry tax schedule details: value: ia::result: - key: '8' id: '8' href: /objects/tax/order-entry-tax-schedule-detail/8 - key: '9' id: '9' href: /objects/tax/order-entry-tax-schedule-detail/9 - key: '10' id: '10' href: /objects/tax/order-entry-tax-schedule-detail/10 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/order-entry-tax-schedule-detail/{key}: parameters: - name: key description: System-assigned key for the Order Entry tax schedule detail. in: path required: true schema: type: string default: '162' example: '162' get: summary: Get an Order Entry tax schedule detail description: >- Returns detailed information for a particular Order Entry tax schedule detail. tags: - Tax_Order Entry tax schedule details operationId: get-tax-order-entry-tax-schedule-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the order-entry-tax-schedule-detail properties: ia::result: $ref: '#/components/schemas/tax-order-entry-tax-schedule-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the Order Entry tax schedule detail: value: ia::result: taxSchedule: key: '162' id: '162' name: Tax Florida href: /objects/tax/order-entry-tax-schedule/162 key: '44' id: '44' taxDetail: id: Sales Tax California key: '22' href: /objects/tax/order-entry-tax-detail/22 effectiveDate: '2022-02-03' href: /objects/tax/order-entry-tax-schedule-detail/44 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/purchasing-tax-schedule-detail: get: summary: List Purchasing tax schedule details description: >- Returns a collection with a key, ID, and link for each Purchasing tax schedule detail. tags: - Tax_Purchasing tax schedule details operationId: list-tax-purchasing-tax-schedule-detail responses: '200': description: OK content: application/json: schema: type: object title: List of purchasing-tax-schedule-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List Purchasing tax schedule details: value: ia::result: - key: '8' id: '8' href: /objects/tax/purchasing-tax-schedule-detail/8 - key: '9' id: '9' href: /objects/tax/purchasing-tax-schedule-detail/9 - key: '10' id: '10' href: /objects/tax/purchasing-tax-schedule-detail/10 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/tax/purchasing-tax-schedule-detail/{key}: parameters: - name: key description: System-assigned unique key for the Purchasing tax schedule detail. in: path required: true schema: type: string example: '162' default: '162' get: summary: Get a Purchasing tax schedule detail description: >- Returns detailed information for a specified Purchasing tax schedule detail. tags: - Tax_Purchasing tax schedule details operationId: get-tax-purchasing-tax-schedule-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the purchasing-tax-schedule-detail properties: ia::result: $ref: '#/components/schemas/tax-purchasing-tax-schedule-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a Purchasing tax schedule detail: value: ia::result: taxSchedule: key: '162' id: '162' name: Tax Florida href: /objects/tax/purchasing-tax-schedule/162 key: '44' id: '44' taxDetail: id: Sales Tax California key: '22' href: /objects/tax/purchasing-tax-detail/22 effectiveDate: '2022-02-03' href: /objects/tax/purchasing-tax-schedule-detail/44 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/time/timesheet: get: summary: List timesheets description: >- Returns up to 100 object references from the collection with a key, ID, and link for each timesheet. This operation is mostly for use in testing; use query to find timesheets that meet certain criteria and to specify properties that are returned. tags: - Time_and_Expenses_Timesheets operationId: list-time-timesheet responses: '200': description: OK content: application/json: schema: type: object title: List of timesheets properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of timesheets: value: ia::result: - key: '101' id: '101' href: /objects/time/timesheet/101 - key: '102' id: '102' href: /objects/time/timesheet/102 - key: '103' id: '103' href: /objects/time/timesheet/103 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a timesheet description: Creates a new timesheet. tags: - Time_and_Expenses_Timesheets operationId: create-time-timesheet requestBody: description: timesheet required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/time-timesheet' - $ref: '#/components/schemas/time-timesheetRequiredProperties' examples: Create a timesheet: value: beginDate: '2023-01-01' state: submitted description: Week of 01/01/23 employee: key: '973' attachment: key: '8420' lines: - dimensions: department: key: '11' location: key: '22' project: key: '1' costType: key: '2' task: key: '1' customer: key: '13' item: key: '13' entryDate: '2023-04-01' quantity: 6 description: Week of 04/01/23 notes: Talked to client regarding project timeType: key: '1' isBillable: true responses: '201': description: Created content: application/json: schema: type: object title: New timesheet properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New timesheet created: value: ia::result: key: '40' id: '40' href: /objects/time/timesheet/40 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/time/timesheet/{key}: parameters: - name: key description: System-assigned unique key for the timesheet. in: path required: true schema: type: string get: summary: Get a timesheet description: Returns detailed information for a specified timesheet. tags: - Time_and_Expenses_Timesheets operationId: get-time-timesheet-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the timesheet properties: ia::result: $ref: '#/components/schemas/time-timesheet' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the timesheet: value: ia::result: key: '23' id: '23' href: /objects/time/timesheet/23 beginDate: '2023-01-01' endDate: '2023-12-31' postingDate: '2023-01-01' state: submitted unitOfMeasure: Hours hoursInDay: 8 description: Week of 01/01/23 calculationMethod: hourly postActualLaborCost: false employee: key: '973' id: E-001 href: /objects/company-config/employee/973 employeeContact: key: '977' id: John Smith firstName: John lastName: Smith href: /objects/company-config/contact/977 attachment: key: '8420' id: Attach-01 href: /objects/company-config/attachment/973 employeeClassId: EMP_CLS_001 employeeDepartmentId: DEP-11 employeeLocation: key: '22' id: LOC-22 href: /objects/company-config/location/22 employeePositionId: MGR lines: - key: '1411' id: '1411' href: /objects/time/timesheet-line/1411 timesheet: key: '11' id: '11' href: /objects/time/timesheet/11 dimensions: department: key: '11' id: DEP-11 name: Sales and Marketing href: /objects/company-config/department/11 location: key: '22' id: LOC-22 name: California href: /objects/company-config/location/22 employee: key: '10' id: EMP-10 name: Thomas, Glenn href: /objects/company-config/employee/10 project: key: '1' id: Proj-001 name: Implementation href: /objects/projects/project/1 costType: id: '2' key: '2' name: Project Expense href: /objects/construction/cost-type/2 task: id: '1' key: '1' name: Project Task href: /objects/projects/task/1 customer: key: '13' id: CUST-13 name: Jack In the Box href: /objects/accounts-receivable/customer/13 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 entryDate: '2023-04-01' quantity: 6 lineNumber: 1 description: Week of 04/01/23 notes: Talked to client regarding project state: approved timeType: key: '1' id: Salaries At Root name: Salaries At Root href: /objects/time/time-type/1 isBillable: true isBilled: 'false' statisticalJournal: key: '7483' id: '7483' href: /objects/company-config/employee/10 billableUtilizedAccount: key: '8293' id: '8293' href: /objects/general-ledger/statistical-account/8293 nonBbillableUtilizedAccount: key: '8294' id: '8294' href: /objects/general-ledger/statistical-account/8294 billableNonUtilizedAccount: key: '8295' id: '8295' href: /objects/general-ledger/statistical-account/8295 nonBillableNonUtilizedAccount: key: '8296' id: '8296' href: /objects/general-ledger/statistical-account/8296 hours: billable: 8 nonBillable: 2 approved: 10 approvedBillable: 8 approvedNonBillable: 2 utilized: 10 nonUtilized: 4 approvedUtilized: 3 approvedNonUtilized: 2 externalPayroll: costRate: 1 billingRate: 1 amount: '90' employerTaxes: 15 fringes: 10 cashFringes: 2 laborClass: key: '15' id: '15' name: Labor Class href: /objects/construction/labor-class/15 audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 3 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a timesheet description: >- Updates an existing timesheet by setting field values. Any fields not provided remain unchanged. tags: - Time_and_Expenses_Timesheets operationId: update-time-timesheet-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/time-timesheet' - type: object properties: id: readOnly: true examples: Updates a timesheet: value: state: submitted description: Week of 01/01/23 responses: '200': description: OK content: application/json: schema: type: object title: Updated timesheet properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Timesheet updated: value: ia::result: key: '40' id: '40' href: /objects/time/timesheet/40 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a timesheet description: Deletes a timesheet. tags: - Time_and_Expenses_Timesheets operationId: delete-time-timesheet-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /services/time/timesheet/recall: post: summary: Recall a timesheet description: > Recalls a timesheet after it has been submitted and not yet approved. The transaction state is changed from submitted to draft. This allows changes to be made without going through the approval process or having the transaction edited by someone with permission to edit. tags: - Time_and_Expenses_Timesheets operationId: recall-timesheet requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/time-timesheet.recall-request' examples: Timesheet to recall: value: key: '155096' responses: '200': description: Executed content: application/json: schema: type: object properties: ia::result: type: array items: $ref: '#/components/schemas/time-timesheet.recall-response' ia::meta: $ref: '#/components/schemas/metadata' examples: Response: value: ia::result: - key: '155096' status: completed ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/time/timesheet-line: get: summary: List timesheet lines description: >- Returns up to 100 object references from the collection with a key, ID, and link for each timesheet line. This operation is mostly for use in testing; use query to find timesheet lines that meet certain criteria and to specify properties that are returned. tags: - Time_and_Expenses_Timesheet lines operationId: list-time-timesheet-line responses: '200': description: OK content: application/json: schema: type: object title: List of timesheet lines properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of timesheet lines: value: ia::result: - key: '4101' id: '4101' href: /objects/time/timesheet-line/4101 - key: '4102' id: '4102' href: /objects/time/timesheet-line/4102 - key: '4103' id: '4103' href: /objects/time/timesheet-line/4103 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a timesheet line description: Creates a new timesheet line. tags: - Time_and_Expenses_Timesheet lines operationId: create-time-timesheet-line requestBody: description: timesheet-line required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/time-timesheet-line' - $ref: '#/components/schemas/time-timesheet-lineRequiredProperties' examples: Creates a timesheet line: value: timesheet: key: '11' dimensions: department: key: '11' location: key: '22' project: key: '1' costType: key: '2' task: key: '1' customer: key: '13' item: key: '13' entryDate: '2023-04-01' quantity: 6 description: Week of 04/01/23 notes: Talked to client regarding project timeType: key: '1' isBillable: true responses: '201': description: Created content: application/json: schema: type: object title: New timesheet-line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New timesheet line created: value: ia::result: key: '4108' id: '4108' href: /objects/time/timesheet-line/4108 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/time/timesheet-line/{key}: parameters: - name: key description: System-assigned unique key for the timesheet line. in: path required: true schema: type: string get: summary: Get a timesheet line description: Returns detailed information for a specified timesheet line. tags: - Time_and_Expenses_Timesheet lines operationId: get-time-timesheet-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the timesheet-line properties: ia::result: $ref: '#/components/schemas/time-timesheet-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the timesheet line: value: ia::result: key: '1411' id: '1411' href: /objects/time/timesheet-line/1411 timesheet: key: '11' id: '11' href: /objects/time/timesheet/11 dimensions: employee: key: '10' id: EMP-10 name: Thomas, Glenn href: /objects/company-config/employee/10 department: key: '11' id: DEP-11 name: Sales and Marketing href: /objects/company-config/department/11 location: key: '22' id: LOC-22 name: California href: /objects/company-config/location/22 project: key: '1' id: Proj-001 name: Implementation href: /objects/projects/project/1 costType: key: '2' id: '2' name: Project Expense href: /objects/construction/cost-type/2 task: id: '1' key: '1' name: Project Task href: /objects/projects/task/1 customer: key: '13' id: CUST-13 name: Jack In the Box href: /objects/accounts-receivable/customer/13 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 entryDate: '2023-04-01' quantity: 6 lineNumber: 1 description: Week of 04/01/23 notes: Talked to client regarding project state: approved timeType: key: '1' id: Salaries At Root href: /objects/time/time-type/1 isBillable: true isBilled: 'false' statisticalJournal: key: '7483' id: TSSJ href: /objects/general-ledger/statistical-account/10 billableUtilizedAccount: key: '8293' id: '9293' href: /objects/general-ledger/statistical-account/8293 nonBbillableUtilizedAccount: key: '8294' id: '9294' href: /objects/general-ledger/statistical-account/8294 billableNonUtilizedAccount: key: '8295' id: '9295' href: /objects/general-ledger/statistical-account/8295 nonBillableNonUtilizedAccount: key: '8296' id: '9296' href: /objects/general-ledger/statistical-account/8296 hours: billable: 8 nonBillable: 2 approved: 10 approvedBillable: 8 approvedNonBillable: 2 utilized: 10 nonUtilized: 4 approvedUtilized: 3 approvedNonUtilized: 2 externalPayroll: costRate: 1 billingRate: 1 amount: '90' employerTaxes: 15 fringes: 10 cashFringes: 2 laborClass: key: '15' id: LC001 name: Labor Class href: /objects/construction/labor-class/15 laborShift: key: '18' id: LS001 name: Labor Shift href: /objects/construction/labor-class/18 laborUnion: key: '20' id: LU001 name: Labor Union href: /objects/construction/labor-class/20 audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 3 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a timesheet line description: >- Updates an existing timesheet line by setting field values. Any fields not provided remain unchanged. tags: - Time_and_Expenses_Timesheet lines operationId: update-time-timesheet-line-key requestBody: content: application/json: schema: $ref: '#/components/schemas/time-timesheet-line' examples: Updates a timesheet line: value: key: '40' description: Week of 04/01/23 notes: Talked to client regarding project responses: '200': description: OK content: application/json: schema: type: object title: Updated timesheet-line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Timesheet-line updated: value: ia::result: key: '40' id: '40' href: /objects/time/timesheet-line/40 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a timesheet line description: Deletes a timesheet line. tags: - Time_and_Expenses_Timesheet lines operationId: delete-time-timesheet-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/time/timesheet-approval-record: get: summary: List timesheet approval records description: >- Returns a collection with a key, ID, and link for each timesheet approval record. tags: - Time_and_Expenses_Timesheet approval records operationId: list-time-timesheet-approval-record responses: '200': description: OK content: application/json: schema: type: object title: List of timesheet-approval-record objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of time sheet approval record objects: value: ia::result: - key: '46' id: '46' href: /objects/time/timesheet-approval-record/46 - key: '44' id: '44' href: /objects/time/timesheet-approval-record/44 - key: '40' id: '40' href: /objects/time/timesheet-approval-record/40 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/time/timesheet-approval-record/{key}: parameters: - name: key description: system-assigned unique key for the timesheet approval record. in: path required: true schema: type: string get: summary: Get a timesheet approval record description: Returns detailed information for a particular timesheet approval record. tags: - Time_and_Expenses_Timesheet approval records operationId: get-time-timesheet-approval-record-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the timesheet-approval-record properties: ia::result: $ref: '#/components/schemas/time-timesheet-approval-record' ia::meta: $ref: '#/components/schemas/metadata' examples: Example 1: value: ia::result: key: '23' id: '23' href: /objects/time/timesheet-approval-record/23 approvalStage: 1 approvalType: Department Approval approvalLevel: '2' comments: Approved by Admin recordDate: '2021-01-23' state: submitted timesheet: key: '1' id: '1' href: /objects/time/timesheet/1 timesheetLine: key: '1' id: '1' lineNumber: 1 href: /objects/time/timesheet-line/1 approvedBy: key: '2' id: '2' href: /objects/company-config/user/2 approver: key: '3' id: '3' href: /objects/company-config/user/3 completedBy: key: '4' id: '4' href: /objects/company-config/user/3 createdBy: key: '5' id: '5' href: /objects/company-config/user/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/time/time-type: get: summary: List time types description: Returns a collection with a key, ID, and link for each time type. tags: - Time_and_Expenses_Time types operationId: list-time-type responses: '200': description: OK content: application/json: schema: type: object title: List of time-type objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of time types: value: ia::result: - key: '46' id: Overtime href: /objects/time/time-type/46 - key: '44' id: Part time href: /objects/time/time-type/44 - key: '40' id: Full time href: /objects/time/time-type/40 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a time type description: Creates a new time type. tags: - Time_and_Expenses_Time types operationId: create-time-type requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/time-time-type' - $ref: '#/components/schemas/time-typeRequiredProperties' examples: Create a time type: value: earningType: key: '22' glAccount: key: '12' offsetGLAccount: key: '15' status: active responses: '201': description: Created content: application/json: schema: type: object title: New time-type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New time type: value: ia::result: key: '10' id: '10' href: /objects/time/time-type/10 ia::meta: totalCount: 3 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/time/time-type/{key}: parameters: - name: key description: system-assigned unique key for the time type. in: path required: true schema: type: string get: summary: Get a time type description: Returns detailed information for a particular time type. tags: - Time_and_Expenses_Time types operationId: get-time-type-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the time-type properties: ia::result: $ref: '#/components/schemas/time-time-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the time type: value: ia::result: key: '23' id: Overtime href: /objects/time/time-type/23 earningType: href: /objects/company-config/earning-type/23 key: '22' id: Salary glAccount: href: /objects/general-ledger/account/12 key: '12' id: '5001' name: Labor offsetGLAccount: href: /objects/general-ledger/account/23 key: '15' id: '5002' name: Labor Offset status: active ia::meta: totalCount: 3 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a time type description: >- Updates an existing time type by setting field values. Any fields not provided remain unchanged. tags: - Time_and_Expenses_Time types operationId: update-time-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/time-time-type' - type: object properties: id: readOnly: true examples: Updates a time type: value: status: active responses: '200': description: OK content: application/json: schema: type: object title: Updated time-type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated time type: value: ia::result: key: '10' id: Overtime href: /objects/time/time-type/10 ia::meta: totalCount: 3 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a time type description: Deletes a time type. tags: - Time_and_Expenses_Time types operationId: delete-time-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/earning-type/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the earning type. get: summary: Get an earning type description: Returns detailed information for a specified earning type. tags: - Time_and_Expenses_Earning types responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/company-config-earning-type' ia::meta: $ref: '#/components/schemas/metadata' '400': description: Bad Request operationId: get-company-config-earning-type-key security: - OAuth2: [] /objects/expenses/employee-expense: get: summary: List employee expenses description: > Returns up to 100 employee expense objects from the collection with a key, ID, and link for each expense. This operation is mostly for use in testing; use the query service to find expense objects that meet certain criteria and to specify the properties that are returned. tags: - Time_and_Expenses_Employee expenses operationId: list-expenses-employee-expense responses: '200': description: OK content: application/json: schema: type: object title: List of employee expense objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get list of employee expenses: value: ia::result: - key: '84' id: EXP-00001 href: /objects/expenses/employee-expense/84 - key: '85' id: EXP-00002 href: /objects/expenses/employee-expense/85 - key: '60' id: EXP-00003 href: /objects/expenses/employee-expense/60 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee expense description: >- Creates a new employee expense. You must specify a unique employee expense ID when creating an employee expense unless document sequencing is configured, in which case the ID is auto-generated. tags: - Time_and_Expenses_Employee expenses operationId: create-expenses-employee-expense requestBody: description: Creates an employee expense required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense' - $ref: '#/components/schemas/expenses-employee-expenseRequiredProperties' examples: Creates an employee expense: value: state: submitted expenseReportNumber: EXP-00001 employee: id: '10' createdDate: '2021-03-11' expenseSummary: postingDate: '2021-01-31' title: Expenses - Q1 batch basePaymentInformation: baseCurrency: USD reimbursementInformation: reimbursementCurrency: EUR description: Travel expense memo: Paid to employee lines: - account: null id: '6775.30' paidTo: paid To paidFor: paid For isBillable: false form1099: isForm1099: 'true' type: MISC box: '3' paymentType: key: '1' name: Non-reimburse isNonreimbursable: false quantity: '10' unitrate: '20' txnCurrency: INR txnAmount: '100' transactionToReimburseConversion: exchangeRateDate: '2021-03-11' exchangeRateTypeId: Intacct Daily Rate dimensions: location: id: '1' department: id: '1' class: id: REST_CLS_001 item: id: Case 13 employee: id: '10' vendor: id: '1605212096809' customer: id: '113' project: id: NET-XML30-2 warehouse: id: WH01 task: id: tet responses: '201': description: Created content: application/json: schema: type: object title: New employee expense properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New employee expense: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense/{key}: parameters: - name: key description: System-assigned key for the employee-expense. in: path required: true schema: type: string get: summary: Get an employee expense description: Returns detailed information for a specified employee expense. tags: - Time_and_Expenses_Employee expenses operationId: get-expenses-employee-expense-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee expense properties: ia::result: $ref: '#/components/schemas/expenses-employee-expense' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the employee expense: value: ia::result: expenseReportNumber: ER-0152 employee: id: '10' key: '10' href: /objects/company-config/employee/10 employeeContact: key: '977' id: Thomas Glenn firstName: Thomas lastName: Glenn href: /objects/company-config/contact/977 key: '124' id: '124' createdDate: '2021-03-11' expenseSummary: postingDate: '2021-01-31' title: Expenses - Q1 batch key: '3' id: '3' href: /objects/expenses/employee-expense-summary/3 basePaymentInformation: totalEntered: '1.38' totalPaid: '0' totalSelected: '0' totalDue: '1.38' baseCurrency: USD state: approved reimbursementInformation: totalEntered: '1.16' totalSelected: '0' totalPaid: '0' totalDue: '1.16' reimbursementCurrency: EUR description: Supplies for customer training nonReimbursable: baseTotalEntered: '0' reimbursementTotalEntered: '0' lines: - key: '288' id: '288' employee-expense: id: '124' key: '124' href: /objects/expenses/employee-expense/124 quantity: '0' glAccount: key: '158' id: '6775.30' name: Travel href: /objects/account/158 entryDate: '2021-03-11' paidTo: paid To paidFor: paid For baseAmount: '1.38' reimburseToBase: exchangeRateDate: '2021-03-11' exchangeRateTypeId: '-1' exchangeRate: '1.1899' expenseType: key: Meals id: '6000' reimbursementInformation: reimbursementAmount: '1.16' totalSelected: '0' totalPaid: '0' isBillable: false isBilled: false state: approved form1099: isForm1099: 'true' type: MISC box: '3' paymentType: isNonreimbursable: false unitrate: '10' lineNumber: 1 currency: txnCurrency: INR txnAmount: '100' exchangeRateDate: '2021-03-11' exchangeRateTypeId: Intacct Daily Rate exchangeRate: '1' attachment: key: '1' id: '1' dimensions: location: key: '1' id: '1' name: USA href: /objects/company-config/location/1 department: key: '1' id: '1' name: IT href: /objects/company-config/department/1 class: key: '731' id: REST_CLS_001 name: Education href: /objects/company-config/class/731 item: key: '13' id: '13' name: Support href: /objects/inventory-control/item/13 employee: key: '10' id: '10' href: /objects/company-config/employee/10 vendor: key: '357' id: '1605212096809' name: Boston Properties href: /objects/accounts-payable/vendor/357 customer: key: '13' id: '113' name: Jack In the Box href: /objects/accounts-receivable/customer/13 project: key: '2' id: NET-XML30-2 name: Binford Implementation href: /objects/projects/project/2 task: key: '2' id: tet name: Implementation services href: /objects/projects/task/2 warehouse: key: '6' id: WH01 name: WH01 Name href: /objects/inventory-control/warehouse/6 href: /objects/expenses/employee-expense-line/288 memo: Covered by customer href: /objects/expenses/employee-expense/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee expense description: >- Updates an existing employee expense by setting field values. Any fields not provided remain unchanged. tags: - Time_and_Expenses_Employee expenses operationId: update-expenses-employee-expense-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense' - type: object properties: reimbursement: properties: reimbursementCurrency: readOnly: true examples: Updates an employee expense: value: memo: Covered by customer responses: '200': description: OK content: application/json: schema: type: object title: Updated employee expense properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated employee expense: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee expense description: Deletes an employee expense. tags: - Time_and_Expenses_Employee expenses operationId: delete-expenses-employee-expense-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-line: get: summary: List employee expense lines description: >- Returns a collection with a key, ID, and link for each employee expense line. tags: - Time_and_Expenses_Employee expense lines operationId: list-expenses-employee-expense-line responses: '200': description: OK content: application/json: schema: type: object description: List of employee expense line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of employee expense line objects: value: ia::result: - key: '100' id: '100' href: /objects/expenses/employee-expense-line/100 - key: '101' id: '101' href: /objects/expenses/employee-expense-line/101 - key: '102' id: '102' href: /objects/expenses/employee-expense-line/102 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee expense line description: Creates a new employee expense line. tags: - Time_and_Expenses_Employee expense lines operationId: create-expenses-employee-expense-line requestBody: description: Creates an employee expense line required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-line' - $ref: '#/components/schemas/expenses-employee-expense-lineRequiredProperties' examples: Creates an employee expense line: value: account: id: '6775.3' paidTo: Stella Johnson paidFor: Hotel stay isBillable: false form1099: isForm1099: 'true' type: MISC box: '3' paymentType: key: '1' id: Non-reimburse isNonreimbursable: false quantity: '10' unitrate: '20' txnCurrency: INR txnAmount: '100' transactionToReimburseConversion: exchangeRateDate: '2021-03-11' exchangeRateTypeId: Intacct Daily Rate dimensions: location: id: '1' department: id: '1' class: id: REST_CLS_001 item: id: Case 13 employee: id: '10' vendor: id: '1605212096809' customer: id: '113' project: id: NET-XML30-2 warehouse: id: WH01 task: id: tet responses: '201': description: Created content: application/json: schema: type: object title: New employee expense line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New employee expense line: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense-line/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-line/{key}: parameters: - name: key description: System-assigned key for the employee expense line. in: path required: true schema: type: string get: summary: Get an employee expense line description: Returns detailed information for a specified employee expense line. tags: - Time_and_Expenses_Employee expense lines operationId: get-expenses-employee-expense-line-key responses: '200': description: OK content: application/json: schema: type: object description: Details of the employee expense line properties: ia::result: $ref: '#/components/schemas/expenses-employee-expense-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the employee expense line: value: ia::result: key: '312' id: '312' employee-expense: id: '136' key: '136' href: /objects/expenses/employee-expense/136 glAccount: key: '158' id: '6775.30' name: Travel href: /objects/account/158 entryDate: '2021-03-11' paidTo: Stella Johnson paidFor: Hotel stay reimburseToBase: baseAmount: '1.38' exchangeRateDate: '2021-03-11' exchangeRateTypeId: '-1' exchangeRate: '1.1899' dimensions: location: key: '1' id: '1' name: USA href: /objects/company-config/location/1 department: key: '1' id: '1' name: IT href: /objects/company-config/department/1 class: key: '731' id: REST_CLS_001 name: Enterprises href: /objects/company-config/class/731 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 employee: key: '10' id: '10' name: Thomas, Glenn href: /objects/company-config/employee/10 vendor: key: '357' id: '1605212096809' name: GenLab href: /objects/accounts-payable/vendor/357 customer: key: '13' id: '113' name: Jack In the Box href: /objects/accounts-receivable/customer/13 project: key: '2' id: NET-XML30-2 name: Talcomp training href: /objects/projects/project/2 task: key: '2' id: tet name: Design href: /objects/projects/task/2 warehouse: key: '6' id: WH01 name: WH01 href: /objects/inventory-control/warehouse/6 lineNumber: 1 expenseType: key: Meals id: '6000' reimbursement: reimbursementAmount: '1.16' totalSelected: '0' totalPaid: '0' isBillable: false isBilled: false state: approved form1099: isForm1099: 'true' type: MISC box: '3' paymentType: key: '1' id: Non-reimburse isNonreimbursable: false quantity: '5' unitRate: '20' currency: txnCurrency: INR txnAmount: '4444' exchangeRateDate: '2021-03-11' exchangeRateTypeId: '-1' exchangeRate: '65' userExchangeRate: '5' href: /objects/expenses/employee-expense-line/312 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee expense line description: >- Updates an existing employee expense line by setting field values. Any fields not provided remain unchanged. tags: - Time_and_Expenses_Employee expense lines operationId: update-expenses-employee-expense-line-key requestBody: content: application/json: schema: $ref: '#/components/schemas/expenses-employee-expense-line' examples: Updates an employee expense line: value: paidTo: Travel expense responses: '200': description: OK content: application/json: schema: type: object description: Updated employee expense line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated employee expense line: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense-line/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee expense line description: Deletes an employee expense line. tags: - Time_and_Expenses_Employee expense lines operationId: delete-expenses-employee-expense-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-summary: get: summary: List employee expense summaries description: > Returns up to 100 expense summaries from the collection with a key, ID, and link for each summary. This operation is mostly for use in testing; use the query service to find expense summaries that meet certain criteria and to specify the properties that are returned. tags: - Time_and_Expenses_Employee expense summaries operationId: list-expenses-employee-expense-summary responses: '200': description: OK content: application/json: schema: type: object description: List of employee expense summary objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of employee expense summary objects: value: ia::result: - key: '13' id: '13' href: /objects/expenses/employee-expense-summary/13 - key: '15' id: '15' href: /objects/expenses/employee-expense-summary/15 - key: '16' id: '16' href: /objects/expenses/employee-expense-summary/16 ia::meta: totalCount: 3 start: 1 pageSize: 3 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee expense summary description: Creates a new employee expense summary. tags: - Time_and_Expenses_Employee expense summaries operationId: create-expenses-employee-expense-summary requestBody: description: Employee expense summary to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-summary' - $ref: '#/components/schemas/expenses-employeeExpenseSummaryRequiredProperties' examples: Creates an employee expense summary: value: title: Expenses (USD) Q1 Batch postingDate: '2021-01-23' totalAmount: '100' status: active responses: '201': description: Created content: application/json: schema: type: object description: New employee expense summary properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New employee-expense-summary: value: ia::result: key: '10' id: '10' href: /objects/expenses/employee-expense-summary/10 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-summary/{key}: parameters: - name: key description: System-assigned key for the employee expense summary. in: path required: true schema: type: string get: summary: Get an employee expense summary description: Returns detailed information for a specified employee expense summary. tags: - Time_and_Expenses_Employee expense summaries operationId: get-expenses-employee-expense-summary-key responses: '200': description: OK content: application/json: schema: type: object description: Details of the employee expense summary properties: ia::result: $ref: '#/components/schemas/expenses-employee-expense-summary' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the employee expense summary: value: ia::result: key: '18' id: '18' title: Expense reports for week 03 postingDate: '2023-01-20' totalAmount: '100' state: open recordType: expense summaryCreationType: manual bankAccount: key: 1 id: BOA href: /objects/cash-management/bank-account/1 preventGLPosting: false href: /objects/expenses/employee-expense-summary/18 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee expense summary description: >- Updates an existing employee expense summary by setting field values. Any fields not provided remain unchanged. tags: - Time_and_Expenses_Employee expense summaries operationId: update-expenses-employee-expense-summary-key requestBody: content: application/json: schema: $ref: '#/components/schemas/expenses-employee-expense-summary' examples: Updates an employee expense summary: value: name: Expense report for January responses: '200': description: OK content: application/json: schema: type: object description: Updated employee expense summary properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated employee expense summary: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense-summary/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee expense summary description: Deletes an employee expense summary. tags: - Time_and_Expenses_Employee expense summaries operationId: delete-expenses-employee-expense-summary-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-type: get: summary: List employee expense types description: > Returns up to 100 expense types from the collection with a key, ID, and link for each type. This operation is mostly for use in testing; use the query service to find expense types that meet certain criteria and to specify the properties that are returned. tags: - Time_and_Expenses_Employee expense types operationId: list-expenses-employee-expense-type responses: '200': description: OK content: application/json: schema: type: object description: List of employee expense type objects. properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of employee expense types: value: ia::result: - key: '46' id: Travel href: /objects/expenses/employee-expense-type/46 - key: '44' id: Transportation href: /objects/expenses/employee-expense-type/44 - key: '40' id: Compensation href: /objects/expenses/employee-expense-type/40 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee expense type description: Creates a new employee expense type. tags: - Time_and_Expenses_Employee expense types operationId: create-expenses-employee-expense-type requestBody: description: Creates an employee expense type. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-type' - $ref: '#/components/schemas/expenses-employee-expense-typeRequiredProperties' examples: Creates an employee expense type: value: id: Travel status: active description: Travel fare unitCurrency: USD glAccount: id: '6000' unitRates: - rate: '200' startDate: '2021-01-23' - rate: '100' startDate: '2021-03-23' responses: '201': description: Created content: application/json: schema: type: object description: New employee expense type. properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New employee expense type: value: ia::result: key: '10' id: Travel href: /objects/expenses/employee-expense-type/10 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-type/{key}: parameters: - name: key description: System-assigned key for the employee expense type. in: path required: true schema: type: string get: summary: Get an employee expense type description: Returns detailed information for a specified employee expense type. tags: - Time_and_Expenses_Employee expense types operationId: get-expenses-employee-expense-type-key responses: '200': description: OK content: application/json: schema: type: object description: Details of the employee expense type. properties: ia::result: $ref: '#/components/schemas/expenses-employee-expense-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the employee expense type: value: ia::result: key: '63' audit: createdDateTime: '2023-12-21T08:40:05Z' modifiedDateTime: '2023-12-21T08:47:08Z' createdBy: '1' modifiedBy: '1' id: Travel description: Travel fare glAccount: key: '6000' id: G&A Salaries name: G&A Salaries href: /objects/general-ledger/account/6000 status: active offsetGLAccount: key: '6253' id: Meals name: Meals href: /objects/general-ledger/account/6253 item: key: '1' id: '10' name: PC Computer href: /objects/inventory-control/item/6253 form1099: type: W-2G box: '1' unitCurrency: USD unitRates: - id: '28' key: '28' employeeExpenseType: id: '63' key: '63' href: /objects/expenses/employee-expense-type/63 rate: '200' startDate: '2021-01-23' audit: createdDateTime: '2023-12-21T08:47:08Z' modifiedDateTime: '2023-12-21T08:47:08Z' createdBy: '1' modifiedBy: '1' href: /objects/expenses/unit-rate/28 - id: '29' key: '29' employeeExpenseType: id: '63' key: '63' href: /objects/expenses/employee-expense-type/63 rate: '100' startDate: '2021-01-23' audit: createdDateTime: '2023-12-21T08:47:08Z' modifiedDateTime: '2023-12-21T08:47:08Z' createdBy: '1' modifiedBy: '1' href: /objects/expenses/unit-rate/29 href: /objects/expenses/employee-expense-type/63 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee expense type description: >- Updates an existing employee expense type by setting field values. Any fields not provided remain unchanged. tags: - Time_and_Expenses_Employee expense types operationId: update-expenses-employee-expense-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-type' - type: object properties: id: readOnly: true examples: Updates an employee expense type: value: description: Personal travel responses: '200': description: OK content: application/json: schema: type: object description: Updated employee expense type. properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated employee expense type: value: ia::result: key: '47' id: Travel href: /objects/expenses/employee-expense-type/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee expense type description: Deletes an employee expense type. tags: - Time_and_Expenses_Employee expense types operationId: delete-expenses-employee-expense-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-payment-type: get: summary: List employee expense payment types description: >- Returns a collection with a key, ID, and link for each employee expense payment type. tags: - Time_and_Expenses_Employee expense payment types operationId: list-expenses-employee-expense-payment-type responses: '200': description: OK content: application/json: schema: type: object title: List of employee expense payment type objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of employee expense payment type: value: ia::result: - key: '100' id: Non-reimburse href: /objects/expenses/employee-expense-payment-type/100 - key: '101' id: Reimburse href: /objects/expenses/employee-expense-payment-type/101 - key: '102' id: Billable href: /objects/expenses/employee-expense-payment-type/102 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee expense payment type description: Creates a new employee expense payment type. tags: - Time_and_Expenses_Employee expense payment types operationId: create-expenses-employee-expense-payment-type requestBody: description: Creates an employee expense payment type. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-payment-type' - $ref: '#/components/schemas/employeeExpensePaymentTypeRequiredProperties' examples: Creates an employee expense payment type: value: id: Non Reimburse status: active description: Non reimbursable payment type offsetAccount: id: '2420' responses: '201': description: Created content: application/json: schema: type: object title: New employee expense payment type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New employee expense payment type: value: ia::result: key: '18' id: Non Reimburse href: /objects/expenses/employee-expense-payment-type/12345 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-payment-type/{key}: parameters: - name: key description: System-assigned key for the employee expense payment type. in: path required: true schema: type: string get: summary: Get an employee expense payment type description: >- Returns detailed information for a specified employee expense payment type. tags: - Time_and_Expenses_Employee expense payment types operationId: get-expenses-employee-expense-payment-type-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee expense payment type properties: ia::result: $ref: '#/components/schemas/expenses-employee-expense-payment-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the employee expense payment type: value: ia::result: key: '10' id: Non Reimburse description: description isNonReimbursable: true offsetGLAccount: key: '70' id: '2420' name: EE-Office Supplies href: /objects/account/70 status: active audit: createdDateTime: '2021-09-02T08:38:53Z' modifiedDateTime: '2021-09-02T08:38:53Z' createdBy: '1' modifiedBy: '1' href: /objects/expenses/employee-expense-payment-type/10 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee expense payment type description: >- Updates an existing employee expense payment type by setting field values. Any fields not provided remain unchanged. tags: - Time_and_Expenses_Employee expense payment types operationId: update-expenses-employee-expense-payment-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-payment-type' - type: object properties: id: readOnly: true examples: Updates an employee expense payment type: value: status: active description: Non reimbursable payment type responses: '200': description: OK content: application/json: schema: type: object title: Updated employee expense payment type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated employee expense payment type: value: ia::result: key: '10' id: Non Reimburse href: /objects/expenses/employee-expense-payment-type/10 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee expense payment type description: Deletes an employee expense payment type. tags: - Time_and_Expenses_Employee expense payment types operationId: delete-expenses-employee-expense-payment-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/unit-rate: get: summary: List description: Returns a collection with a key, ID, and link for each unit-rate. tags: - Time_and_Expenses_Unit rates operationId: list-expenses-unit-rate responses: '200': description: OK content: application/json: schema: type: object title: List of unit-rate objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of unit rates: value: ia::result: - key: '12345' id: Travel-rate href: /objects/expenses/unit-rate/12345 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/unit-rate/{key}: parameters: - name: key description: system-assigned unique key for the unit-rate. in: path required: true schema: type: string get: summary: Get a unit-rate description: Returns detailed information for a specified unit-rate. tags: - Time_and_Expenses_Unit rates operationId: get-expenses-unit-rate-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the unit-rate properties: ia::result: $ref: '#/components/schemas/expenses-unit-rate' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of unit rate: value: ia::result: key: '23' id: '23' href: /objects/expenses/unit-rate/23 rate: '10' startDate: '2021-01-23' audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' employeeExpenseType: name: Travel key: '47' id: '47' href: /objects/expenses/employee-expense-type/47 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee: get: summary: List employees description: >- Returns up to 100 object references from the collection with a key, ID, and link for each employee. This operation is mostly for use in testing; use query to find employees that meet certain criteria and to specify properties that are returned. tags: - Time_and_Expenses_Employees responses: '200': description: OK content: application/json: schema: type: object title: List of employee objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: example-1: value: ia::result: - key: '32' id: '100' href: /objects/company-config/employee/32 - key: '52' id: Emp2 href: /objects/company-config/employee/52 - key: '17' id: '16' href: /objects/company-config/employee/17 ia::meta: totalCount: 20 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' operationId: list-company-config-employee security: - OAuth2: [] post: summary: Create an employee description: >- Creates a new employee. If the employee is also a user in Sage Intacct (which is required if they will be entering Time & Expenses), the employee and user must be associated with the same Sage Intacct contact. tags: - Time_and_Expenses_Employees operationId: create-company-config-employee requestBody: description: Employee to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-employee' - $ref: '#/components/schemas/company-config-employeeRequiredProperties' examples: Create a new employee: value: id: jSmith SSN: '650125930' jobTitle: Accountants status: active startDate: '2021-04-30' birthDate: '1984-04-13' endDate: '2026-04-30' gender: female name: John Smith terminationType: voluntary defaultCurrency: USD manager: id: '11' location: id: '1' department: id: '3' class: id: '1' earningType: id: Salaries isPostActualCostWithVariance: false employeeType: id: 2nd Level Employee primaryContact: id: Imam attachmentFolder: id: Attachment_hh key: '1' payMethod: Cash filePaymentService: ACH ach: achenabled: 'true' achBankRoutingNumber: '121000358' achAccountNumber: '54545454545454' achAccountType: Checking Account achRemittanceType: personal(PPD) responses: '201': description: Created content: application/json: schema: type: object title: New employee properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New employee created: value: ia::result: key: '52' id: Emp3 href: /objects/company-config/employee/52 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee/{key}: parameters: - name: key description: System-assigned key for the employee. in: path required: true schema: type: string get: summary: Get an employee description: Returns detailed information for a specified employee. tags: - Time_and_Expenses_Employees responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee properties: ia::result: $ref: '#/components/schemas/company-config-employee' ia::meta: $ref: '#/components/schemas/metadata' examples: example-1: value: ia::result: key: '63' id: jSmith SSN: '650125930' jobTitle: Accountant location: id: '1' key: '1' name: United States of America href: /objects/company-config/location/1 department: id: '3' key: '3' name: Engineering href: /objects/company-config/department/3 manager: key: '24' id: '11' href: /objects/company-config/employee/24 birthDate: '1984-04-13' startDate: '2021-04-30' endDate: '2026-04-30' status: active employeeType: id: 2nd Level Employee name: 2nd Level Employee key: '6' href: /objects/company-config/employee-type/6 gender: female terminationType: voluntary name: Smith primaryContact: firstName: Anderson id: Anderson name: Anderson lastName: Lee key: '68' href: /objects/company-config/contact/68 attachmentFolder: id: Admin Default Folder key: '6' href: /objects/company-config/folder/6 defaultCurrency: USD form1099: isForm1099: 'true' type: A box: D earningType: key: '1' id: Salaries name: Salaries href: /objects/company-config/earning-type/1 isPostActualCostWithVariance: false class: id: '1' name: class key: '1' payMethod: Cash filePaymentService: ACH ach: achenabled: 'true' achBankRoutingNumber: '121000358' achAccountNumber: '54545454545454' achAccountType: Checking Account achRemittanceType: personal(PPD) canSendPaymentNotification: true placeholderResource: false mergePaymentRequests: true employeePosition: key: '1' id: position href: /objects/company-config/employee/63 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' operationId: get-company-config-employee-key security: - OAuth2: [] patch: summary: Update an employee description: >- Updates an existing employee by setting field values. Any fields not provided remain unchanged. tags: - Time_and_Expenses_Employees operationId: update-company-config-employee-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-employee' - type: object properties: id: readOnly: true examples: Update when an employee resigns: value: status: inactive endDate: '2023-04-01' terminationType: voluntary responses: '200': description: OK content: application/json: schema: type: object title: Updated employee properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Employee updated: value: ia::result: key: '52' id: Emp2 href: /objects/company-config/employee/52 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee description: Deletes an employee. tags: - Time_and_Expenses_Employees operationId: delete-company-config-employee-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee-type: get: summary: List employee types description: Returns a collection with a key, ID, and link for each employee type. tags: - Time_and_Expenses_Employee types operationId: list-company-config-employee-type responses: '200': description: OK content: application/json: schema: type: object title: List of employee-type objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List employee types: value: ia::result: - key: '100' id: Part-time href: /objects/company-config/employee-type/100 - key: '101' id: Full-time href: /objects/company-config/employee-type/101 - key: '102' id: Contractor href: /objects/company-config/employee-type/102 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee type description: >+ Creates a new employee type.
Permissions and other requirements
SubscriptionEmployees Basic Employee Tracking and General Ledger (enable the Employees dimension)
User ypeBusiness, Project Manager
PermissionsAdd Employee Type
tags: - Time_and_Expenses_Employee types operationId: create-company-config-employee-type requestBody: description: employee type to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-employee-type' - $ref: '#/components/schemas/company-config-employee-typeRequiredProperties' examples: Creates an employee type: value: id: Internal parent: key: '12' status: active responses: '201': description: Created content: application/json: schema: type: object title: New employee type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New employee type: value: ia::result: key: '1' id: Internal href: /objects/company-config/employee-type/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee-type/{key}: parameters: - name: key description: system-assigned unique key for the employee type. in: path required: true schema: type: string get: summary: Get an employee type description: Returns detailed information for a specified employee type. tags: - Time_and_Expenses_Employee types operationId: get-company-config-employee-type-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee-type properties: ia::result: $ref: '#/components/schemas/company-config-employee-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the employee type: value: ia::result: key: '23' id: Contractor href: /objects/company-config/employee-type/23 parent: href: /objects/company-config/employee-type/7 id: Contractor key: '7' form1099: type: MISC box: '3' status: active audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee type description: >+ Updates an existing employee type by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionEmployees Basic Employee Tracking and General Ledger (enable the Employees dimension)
User ypeBusiness, Project Manager
PermissionsEdit Employee Type
tags: - Time_and_Expenses_Employee types operationId: update-company-config-employee-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-employee-type' - type: object properties: id: readOnly: true examples: Set status to inactive: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Employee type updated properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated employee type: value: ia::result: key: '1' id: Internal href: /objects/company-config/employee-type/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee type description: >+ Deletes an employee type.
Permissions and other requirements
SubscriptionEmployees Basic Employee Tracking and General Ledger (enable the Employees dimension)
User ypeBusiness, Project Manager
PermissionsEdit Employee Type
tags: - Time_and_Expenses_Employee types operationId: delete-company-config-employee-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] components: schemas: paymentProviderRequiredProperties: type: object required: - id - name object-reference: type: object description: Reference to created or updated object properties: key: type: string example: '12345' id: type: string example: ID123 href: type: string readOnly: true example: /objects///12345 metadata-pages: description: Metadata for collection response type: object properties: totalCount: type: integer description: Total count readOnly: true example: 3 start: type: integer description: Start element number readOnly: true example: 1 pageSize: type: integer description: Page size readOnly: true example: 100 next: type: integer description: Next element number readOnly: true nullable: true example: 101 previous: type: integer description: Previous element number readOnly: true nullable: true example: null error-response: type: object description: Error response properties: ia::error: type: object properties: code: type: string example: invalidRequest message: type: string example: Malformed URL supportId: type: string example: sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ details: type: array items: type: object properties: code: type: string example: invalidRequest message: type: string example: The content type is not valid correction: type: string example: TODO audit: type: object properties: createdDateTime: description: Time of the submission type: string format: date-time example: '2022-04-20T16:20:00Z' readOnly: true modifiedDateTime: description: Time of the modification type: string format: date-time example: '2022-04-20T16:20:00Z' readOnly: true createdBy: description: User who created this type: string example: '1' readOnly: true nullable: true modifiedBy: description: User who modified this type: string example: '95' readOnly: true nullable: true readOnly: true cash-management-provider-payment-method: type: object description: Provider payment methods properties: key: type: string description: System-assigned key for the provider payment method. readOnly: true example: '454' id: type: string description: Unique identifier for the provider payment method. readOnly: true example: '454' href: type: string readOnly: true example: /objects/cash-management/provider-payment-method/454 paymentType: type: string description: Payment type for the provider payment method. example: CHECK paymentProvider: type: object properties: key: type: string description: System-assigned key for the payment provider. example: '3' id: type: string description: Unique identifier for the payment provider. example: CSI name: type: string description: Name of the payment provider. example: CSI href: type: string readOnly: true example: /objects/cash-management/payment-provider/3 example: id: CSI name: CSI key: '3' href: /objects/cash-management/payment-provider/3 audit: $ref: '#/components/schemas/audit' cash-management-payment-provider: type: object description: Payment provider object properties: key: type: string description: System-assigned key for the payment provider. readOnly: true example: '3' id: type: string description: Unique identifier for the payment provider. example: CSI readOnly: true href: type: string readOnly: true example: /objects/cash-management/payment-provider/3 state: type: string enum: - requestInitiated - inProgress - requestReceived - requestFailed - awaitingAuthorization - subscribed - canceled - suspended - pending description: Subscription state of the payment provider. default: inProgress example: requestInitiated name: type: string description: Name of the payment provider. example: CSI paymentWithdrawalType: type: string description: Mode of withdrawal of payment funds. enum: - lumpSum - perTransaction example: lumpSum readOnly: true paymentMethods: type: array items: $ref: '#/components/schemas/cash-management-provider-payment-method' audit: $ref: '#/components/schemas/audit' 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 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 cash-management-payment-provider-bank-account: type: object description: >- Links a bank account with the specified payment provider as part of electronic payments setup. properties: key: type: string description: System-assigned key for the provider bank account. readOnly: true example: '19' id: type: string description: Unique identifier for the provider bank account. readOnly: true example: '19' state: type: string description: Subscription status provided by the payment provider. readOnly: true example: requestInitiated enum: - requestInitiated - inProgress - requestReceived - requestFailed - awaitingAuthorization - subscribed - canceled - suspended providerReferenceNumber: type: string description: >- Reference number specific to the payment provider, which is a combination of cny#, bank account key, and timestamp. readOnly: true example: 44397977-49-1635423682 authenticationURL: type: string description: >- Authentication URL specific to the payment provider. This is sent by the payment provider after successful subscription. readOnly: true example: https://myauthurl.example.com/subscription/authenticate checkStartNumber: type: string description: Starting check number specific to the payment provider. example: '111999' isRebateAccount: type: boolean description: >- Indicates whether this is the account in which virtual card payment rebates are deposited. default: false example: true remittanceEmail: type: string description: Email address to receive the bank remittance. example: jsmith@example.com bankAccount: type: object properties: key: type: string description: System-assigned key for the bank account. example: '72' id: type: string description: Unique identifier for the bank account. example: BOA currency: type: string description: Type of currency for the bank account. example: USD readOnly: true href: type: string readOnly: true example: /objects/cash-management/checking-account/72 paymentProvider: type: object properties: key: type: string description: System-assigned key for the payment provider. example: '1' id: type: string description: Unique identifier for the payment provider. example: CSI href: type: string readOnly: true example: /objects/cash-management/payment-provider/1 href: type: string readOnly: true example: /objects/cash-management/payment-provider-bank-account/19 audit: $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' providerPaymentMethodRequiredProperties: type: object required: - id - name accounts-payable-termRequiredProperties: type: object required: - id - description accounts-payable-term: type: object description: >- An Accounts Payable (AP) term is a rule that a vendor establishes for extending credit to your company. properties: key: type: string description: System-assigned key for the AP term. readOnly: true example: '1' id: type: string description: Unique identifier for the AP term. example: Net 60 status: $ref: '#/components/schemas/status' description: type: string description: A note about the purpose and use of the AP term. example: 60 Days term audit: $ref: '#/components/schemas/audit' due: type: object description: >- Define the calculation for the due date by specifying the number of days and either the date or month to reference. properties: days: type: integer description: The number of days used to calculate the due date. example: 60 from: type: string enum: - null - fromBillDate - ofTheMonthOfBillDate - ofNextMonthFromBillDate - of2ndMonthFromBillDate - of3rdMonthFromBillDate - of4thMonthFromBillDate - of5thMonthFromBillDate - of6thMonthFromBillDate - afterEndOfMonthOfBillDate - fromBillDateExtendingToEOM description: The date or month to reference to calculate the due date. nullable: true example: fromBillDate default: null discount: type: object description: Terms of the discount extended by the vendor. properties: days: type: integer description: >- Number of days from the specified date that the discount is valid. example: 30 amount: type: string format: decimal-precision-2 description: Amount of the discount. example: '4' from: type: string enum: - null - fromBillDate - ofTheMonthOfBillDate - ofNextMonthFromBillDate - of2ndMonthFromBillDate - of3rdMonthFromBillDate - of4thMonthFromBillDate - of5thMonthFromBillDate - of6thMonthFromBillDate - afterEndOfMonthOfBillDate - fromBillDateExtendingToEOM description: Date used to determine if the discount is valid. example: fromBillDate nullable: true default: null unit: type: string enum: - null - amount - percentage description: Type of discount. example: amount nullable: true default: null graceDays: type: integer description: Number of days before the vendor withdraws the discount. example: 6 calculateOn: type: string enum: - null - lineItemsTotal - billTotal description: The total to use when calculating the discount. example: billTotal nullable: true default: null penalty: type: object description: Penalty for paying after the due date. properties: cycle: type: string enum: - null - noPenalty - daily - weekly - biweekly - monthly - bimonthly - quarterly - halfYearly - annually description: The time span in which the penalty accrues. example: daily nullable: true default: null amount: type: string format: decimal-precision-2 description: The penalty amount. example: '10' unit: type: string enum: - null - amount - percentage description: Type of penalty. example: amount nullable: true default: null graceDays: type: integer description: >- The number of days after the due date that the vendor applies the penalty. example: 1 accounts-payable-vendorRequiredProperties: type: object required: - id - name dimension-status: description: > Status of the dimension object: * `active` - Transactions can be posted to this dimension member and it can be used in reports. * `activeNonPosting` - Transactions cannot be posted to the dimension member but it can be used in reports. * `inactive` - The dimension member cannot be used for transactions or reports. type: string enum: - active - activeNonPosting - inactive example: active country-code: type: string enum: - null - us - af - ax - al - dz - as - ad - ao - ai - aq - ag - ar - am - aw - au - at - az - bs - bh - bd - bb - by - be - bz - bj - bm - bt - bo - bq - ba - bw - bv - br - io - bn - bg - bf - bi - kh - cm - ca - cv - ky - cf - td - cl - cn - cx - cc - co - km - cg - cd - ck - cr - ci - hr - cu - cw - cy - cz - dk - dj - dm - do - ec - eg - sv - gq - er - ee - sz - et - fk - fo - fj - fi - fr - gf - pf - tf - ga - gm - ge - de - gh - gi - gr - gl - gd - gp - gu - gt - gg - gn - gw - gy - ht - hm - hn - hk - hu - is - in - id - ir - iq - ie - im - il - it - jm - jp - je - jo - kz - ke - ki - kr - kp - xk - kw - kg - la - lv - lb - ls - lr - ly - li - lt - lu - mo - mk - mg - mw - my - mv - ml - mt - mh - mq - mr - mu - yt - mx - fm - md - mc - mn - me - ms - ma - mz - mm - na - nr - np - nl - an - nc - nz - ni - ne - ng - nu - nf - mp - 'no' - om - pk - pw - ps - pa - pg - py - pe - ph - pn - pl - pt - pr - qa - re - ro - ru - rw - bl - sh - kn - lc - mf - pm - vc - ws - sm - st - sa - sn - rs - sc - sl - sg - sx - sk - si - sb - so - za - gs - es - lk - sd - ss - sr - sj - se - ch - sy - tw - tj - tz - th - tl - tg - tk - to - tt - tn - tr - tm - tc - tv - ug - ua - ae - gb - um - uy - uz - vu - va - ve - vn - vg - vi - wf - eh - ye - zm - zw example: us nullable: true contact-ref: type: object properties: key: type: string description: System-assigned unique key for the contact readOnly: true example: '21' id: type: string description: Contact ID example: jsmith href: type: string description: URL endpoint for the contact readOnly: true example: /objects/company-config/contact/21 lastName: type: string description: Last name example: Smith firstName: type: string description: First name example: John middleName: type: string description: Middle name example: Archibald prefix: type: string description: Prefix example: Mr printAs: type: string description: Print as example: John Smith email1: type: string description: Primary email example: jsmith@company.com email2: type: string description: Secondary email example: john@aol.com phone1: type: string description: Primary phone example: '14085551212' phone2: type: string description: Secondary phone example: '14085559876' mobile: type: string description: Mobile phone example: '14085554420' pager: type: string description: Pager example: '14085559987' fax: type: string description: Fax example: '14085555309' URL1: type: string description: Primary URL example: https://mycompany.com URL2: type: string description: Secondary URL example: https://anothercompany.com companyName: type: string description: Company name example: AlcoSoft Inc mailingAddress: type: object description: Mailing Address properties: addressLine1: type: string description: Address 1 example: 300 Park Avenue addressLine2: type: string description: Address 2 example: Suite 1400 addressLine3: type: string description: Address 3 example: Western industrial area city: type: string description: City example: San Jose state: type: string description: State example: California postCode: type: string description: Zip or Postal Code example: '95110' country: type: string description: Country example: USA accounts-payable-vendor-contact: type: object description: Contact information for a vendor. properties: key: type: string description: System-assigned unique key for the vendor contact. readOnly: true example: '1' id: type: string description: >- Unique identifier for the vendor contact. This value is the same as the `key` value for this object. readOnly: true example: '1' categoryName: type: string description: >- Category name for the vendor contact information, such as office, home, and so forth. example: Main Office contact: type: object description: Contact to associate with the vendor. properties: key: type: string description: System-assigned key for the contact. example: '197' id: type: string description: Identifier for the contact. example: Jeffrey Palms href: type: string readOnly: true description: URL endpoint for the contact. example: /objects/company-config/contact/197 audit: $ref: '#/components/schemas/audit' vendor: type: object description: Vendor this contact is associated with. properties: key: type: string description: System-assigned key for the vendor. example: '15' id: type: string description: Unique identifier for the vendor. example: '15' href: type: string readOnly: true description: URL endpoint for the vendor. example: /objects/accounts-payable/vendor/15 accounts-payable-vendor-email-template: type: object description: >- Vendor email templates can be used to automate standard messages sent to multiple vendors. properties: key: type: string description: System-assigned unique key for the vendor email template. readOnly: true example: '1' id: type: string description: Name or other unique identifier for the vendor email template. readOnly: true example: '1' href: type: string description: URL endpoint for the vendor email template. readOnly: true example: /objects/accounts-payable/vendor-email-template/1 vendor: type: object description: Vendor associated with this email template. properties: key: type: string description: System-assigned key for the vendor. example: '127' id: type: string description: Unique identifier for the vendor. example: '014' href: type: string description: URL endpoint for the vendor. readOnly: true example: /objects/accounts-payable/vendor/127 txnDefinitionName: type: string description: Type of transaction that will use this email template. example: Vendor Invoice emailTemplate: type: object description: Email template associated with this vendor. properties: key: type: string description: System-assigned key for the email template. example: '1' id: type: string description: Unique identifier for the email template. example: '1' name: type: string description: Name for the email template. example: Vendor Trial href: type: string description: URL endpoint for the email template. readOnly: true example: /objects/company-config/email-template/1 accounts-payable-vendor-payment-provider: type: object description: Object that links a payment provider to a vendor. properties: key: type: string description: System-assigned key for the vendor payment provider. readOnly: true example: '1' id: type: string description: Unique identifier for the vendor payment provider. example: '1' href: type: string readOnly: true example: /objects/accounts-payable/vendor-payment-provider/1 paymentProvider: type: object properties: key: type: string description: System-assigned key for the payment provider. example: '3' id: type: string description: Unique identifier for the payment provider. example: CSI name: type: string description: Name of the payment provider. example: CSI href: type: string readOnly: true example: /objects/cash-management/payment-provider/3 vendor: type: object properties: key: type: string description: System-assigned key for the vendor. example: '351' id: type: string description: Unique identifier for the vendor. example: VEN016 name: type: string description: Name of the vendor. example: AAA Consulting href: type: string description: URL of the vendor readOnly: true example: /objects/accounts-payable/vendor/351 state: type: string readOnly: true enum: - requestInitiated - inProgress - requestReceived - requestFailed - awaitingAuthorization - subscribed - canceled - suspended description: Subscription status provided by the payment provider. example: requestInitiated preferredPaymentMethod: type: object properties: key: type: string description: System-assigned key for the preferred payment method. example: '454' id: type: string description: Unique ID for the preferred payment method. example: '454' name: type: string description: Name of the preferred payment method. example: Check href: type: string readOnly: true example: /objects/cash-management/provider-payment-method/454 status: type: string enum: - active - inactive description: Subscription status of the vendor payment provider. example: active audit: $ref: '#/components/schemas/audit' accounts-payable-vendor-bank-file-setup: type: object description: >- A bank file enables electronic payments to be made to vendors using a local bank file format. Bank files are standard files used by banks to make multiple payments. properties: key: type: string description: System-assigned key for the vendor bank file setup. readOnly: true example: '1' id: type: string description: >- Identifier for the vendor bank file setup. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '1' bankAccountNumber: type: string description: Bank account number for the bank file payment. example: IE26SCT666666 bankAccountName: type: string description: Bank account name for the bank file payment. example: Jane Blogs Corp. bsbNumber: type: string description: >- Bank branch number for the vendor bank. Supported countries - Australia (AU). example: 047-359 sortCode: type: string description: >- Sort code for the bank file payment. Supported countries - United Kingdom (GB). example: '204718' paymentReference: type: string description: >- Payment reference number to connect the bank file and the bills to be paid. Supported countries - Australia (AU) and South Africa (ZA). example: Supplier Inc branchCode: type: string description: >- Branch code for the vendor bank account to which payments are made. Supported countries - South Africa (ZA). example: '213456' bankAccountType: type: string description: >- Account type for the vendor bank account to which payments are made. Supported countries - South Africa (ZA). example: '4' bankAccountCode: type: string description: >- Account code for the vendor bank account to which payments are made. Supported countries - South Africa (ZA). example: '345624' printPaymentProof: type: boolean description: >- Specify whether to print the proof of payment when the bank file payment batch is authorized. Supported countries - South Africa (ZA). default: true example: true businessIdCode: type: string description: >- Creditor bank identifier code for the bank account. Supported countries - All European countries where Generic-SEPA file format is supported. example: AIBKIE2D491 creditorCode: type: string description: >- Creditor code for the bank account. Supported countries - Canada (CA). example: '1234567891234567' secondaryIdentifier: type: string description: >- Bank number, as assigned by the account CAD financial institution. Supported countries - Canada (CA). example: '00710423598' vendor: type: object properties: key: type: string description: System-assigned key for the vendor. example: '518' id: type: string description: Unique identifier of the vendor. example: V-00014 href: type: string description: URL of the vendor. readOnly: true example: /objects/accounts-payable/vendor/518 href: type: string readOnly: true example: /objects/accounts-payable/vendor-bank-file-setup/25 accounts-payable-vendor-account-number: type: object description: The account number a vendor assigns to you. properties: key: type: string description: System-assigned unique key for the vendor account number. readOnly: true example: '1' id: type: string description: >- Unique identifier for the vendor account number. This value is the same as the `key` value for this object. example: '1' location: type: object description: Location associated with the vendor account number. properties: key: type: string description: System-assigned unique key for the location. example: '1' id: type: string description: Unique identifier for the location. example: '1' name: type: string description: Name for the location. readOnly: true example: United States of America href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/1 vendorAccountNumber: type: string description: Account number for the vendor. example: VAN-5134986722 href: type: string description: URL endpoint for the vendor account number. readOnly: true example: /objects/accounts-payable/vendor-account-number/1 vendor: type: object description: Vendor this account number is associated with. properties: key: type: string description: System-assigned key for the vendor. example: '1' id: type: string description: Unique identifier for the vendor. example: '1' href: type: string description: URL endpoint for the vendor. readOnly: true example: /objects/accounts-payable/vendor/1 accounts-payable-vendor: type: object description: Vendors properties: key: type: string description: System-assigned key for the vendor. readOnly: true example: '518' id: type: string description: > Unique identifier of the vendor. You must specify a unique vendor ID when creating a vendor unless document sequencing is configured, in which case the ID is auto-generated. example: V-00014 name: type: string description: Name of the vendor. example: NCS, Inc. isOneTimeUse: type: boolean description: Set to `true` if this is a one-time use vendor. default: false example: true href: type: string description: URL of the vendor. readOnly: true example: /objects/accounts-payable/vendor/518 status: $ref: '#/components/schemas/dimension-status' state: type: string description: Approval State. example: s default: a enum: - s - a - r vendorType: type: object description: > Optional vendor type, which is a category of vendors used for reporting purposes. **Valid values:** Any vendor type ID defined by the company. properties: key: type: string nullable: true example: '12' id: type: string nullable: true example: Wholesaler href: type: string readOnly: true example: /objects/accounts-payable/vendor-type/12 parent: type: object description: >- If this vendor is a subsidiary of another vendor, parent vendor of the subsidiary vendor. properties: key: type: string nullable: true example: '500' id: type: string example: 202 nullable: true name: type: string readOnly: true nullable: true example: Pac Bell href: type: string readOnly: true example: /objects/accounts-payable/vendor/500 accountGroup: type: object description: General Ledger (GL) account group that this vendor is part of. properties: key: type: string nullable: true example: '8' id: type: string nullable: true example: OR151 href: type: string readOnly: true example: /objects/accounts-payable/vendor-account-group/8 accountlabel: type: object description: Account label. properties: key: type: string nullable: true example: '10' id: type: string nullable: true example: Equipment href: type: string readOnly: true example: /objects/accounts-payable/account-label/10 defaultLeadTime: type: integer description: Lead time default (days) for inventory replenishment. nullable: true example: 5 filePaymentService: type: string description: File payment service type. example: bankFile enum: - ach - bankFile - none default: none bankFiles: type: object properties: paymentCountryCode: type: string description: >- Bank file payment country code. Required when filePaymentService is bankFile. allOf: - $ref: '#/components/schemas/country-code' nullable: true example: gb paymentCurrency: type: string description: Bank file payment currency. example: EUR taxId: type: string description: Tax ID of the company. nullable: true example: '192354308' tpar: type: object properties: isTparEnabled: type: boolean description: Enable TPAR. example: false default: false name: type: string description: TPAR Name. example: TPAR 1 t5018: type: object properties: isT5018Enabled: type: boolean description: Enable T5018. example: false default: false t5018Number: type: string description: T5018 Business/SIN Number. example: '123456789' form1099: type: object properties: is1099Eligible: type: boolean description: | Set to `true` if this vendor is 1099 eligible. default: false example: true nameOn1099: type: string description: Vendor name as it should appear on 1099 forms. nullable: true example: NCS type: type: string description: | Type of 1099 form for this vendor. nullable: true example: MISC box: type: string description: | Box number for form 1099. nullable: true example: '3' attachment: type: object description: Supporting document for this vendor. properties: key: type: string nullable: true example: '21' id: type: string nullable: true example: Sales01 href: type: string readOnly: true example: /objects/company-config/attachment/21 isOnHold: type: boolean description: > Set to `true` to prevent anyone from entering transactions against this vendor. default: false example: true doNotPay: type: boolean description: | Set to `true` to prevent anyone from paying bills from this vendor. default: false example: true alwaysCreateBill: type: boolean description: > If automated transaction matching for Purchasing workflows is enabled, set this field to `true` to have Sage Intacct create all future transactions for a vendor as AP bills. default: false example: true creditLimit: type: number description: Amount of credit extended by the vendor. example: 10000 retainagePercentage: type: number description: >- The percentage of retainage to withhold for this vendor. (For Construction subscriptions only.) nullable: true example: 20 notes: type: string description: Notes or comments about this vendor. nullable: true example: Make sure to include on form 1099. priceList: type: object description: Price list for this vendor. properties: key: type: string nullable: true example: '13' id: type: string nullable: true example: Acme Price List href: type: string readOnly: true example: /objects/purchasing/price-list/13 priceSchedule: type: object description: Price schedule for this vendor. properties: key: type: string nullable: true example: '5' id: type: string nullable: true example: PREF href: type: string readOnly: true example: /objects/purchasing/price-schedule/5 overrideOffsetGLAccount: type: object description: Default AP override offset account for this vendor. properties: key: type: string nullable: true example: '12' id: type: string nullable: true example: '1' name: type: string nullable: true readOnly: true example: Rent href: type: string readOnly: true example: /objects/general-ledger/account/12 defaultExpenseGLAccount: type: object description: >- Default General Ledger (GL) expense account for bills for this vendor. properties: key: type: string nullable: true example: '6' id: type: string example: '1210' nullable: true name: type: string nullable: true readOnly: true example: Equipment href: type: string readOnly: true example: /objects/general-ledger/account/6 discountPercent: type: number description: Discount percentage for this vendor. nullable: true example: 20 contacts: type: object properties: default: type: object description: > Default contact for this vendor. Used as the default for other vendor contacts, such as `payTo`, that are not defined. allOf: - $ref: '#/components/schemas/contact-ref' - type: object properties: hideContactList: type: boolean description: Exclude from the company contact list. default: false example: false tax: type: object title: tax properties: isTaxable: type: boolean description: Defines whether the contact is taxable. default: false example: false group: type: object properties: key: type: string example: '6' id: type: string example: New York href: type: string readOnly: true example: /objects/tax/contact-tax-group/6 primary: type: object description: > Primary contact for this vendor. The primary contact information is used as the default contact information for the vendor unless otherwise specified. The primary contact is the default contact for all transactions if no other vendor contacts are defined. properties: key: type: string nullable: true example: '7' id: type: string nullable: true example: Jeff Pinkerton href: type: string readOnly: true example: /objects/company-config/contact/7 payTo: type: object description: >- Default contact when paying by check or creating bills. This contact is required for calculating tax for purchasing. properties: key: type: string nullable: true example: '2' id: type: string nullable: true example: Klay Vanderbilt href: type: string readOnly: true example: /objects/company-config/contact/2 returnTo: type: object description: >- Default contact for purchasing transactions and for the return of purchases from purchasing transactions. properties: key: type: string nullable: true example: '5' id: type: string nullable: true example: Yusuf Pringle href: type: string readOnly: true example: /objects/company-config/contact/5 recipient1099: type: object description: Default contact for all 1099 tax transactions and documents. properties: key: type: string nullable: true example: '9' id: type: string nullable: true example: Herb Culver href: type: string readOnly: true example: /objects/company-config/contact/9 contactList: type: array items: $ref: '#/components/schemas/accounts-payable-vendor-contact' vendorEmailTemplates: type: array nullable: true items: $ref: '#/components/schemas/accounts-payable-vendor-email-template' vendorPaymentProviders: type: array items: $ref: '#/components/schemas/accounts-payable-vendor-payment-provider' vendorBankFileSetup: type: array items: $ref: '#/components/schemas/accounts-payable-vendor-bank-file-setup' vendorAccountNumberList: type: array items: $ref: '#/components/schemas/accounts-payable-vendor-account-number' preferredPaymentMethod: type: string description: > Preferred payment method when you select a bill to pay for this vendor. enum: - printedCheck - chargeCard - EFT - cash - ACH - wellsFargoCheck - wellsFargoUSDWire - wellsFargoDomesticACH - null example: EFT nullable: true default: null mergePaymentRequests: type: boolean description: > If `true`, merge multiple selected bills into one payment request for the vendor. If `false`, have one payment request created for each bill. default: true example: true sendPaymentNotification: type: boolean description: > If `true`, automatically send payment notifications to the email address for the `payTo` contact. default: false example: true billingType: type: string description: > Billing type to use on vendor statements. **Valid values:** - `openItem` - Shows all bills, adjustments, and payments as line items on a statements. - `balanceForward` - Consolidates previous months bills, adjustments, and payments to a single line item. enum: - null - openItem - balanceForward example: openItem nullable: true default: null paymentPriority: type: string description: > Optional default payment priority to assign new bills from this vendor. enum: - null - urgent - high - normal - low example: low nullable: true default: null currency: type: string description: Default currency. nullable: true example: USD displayTermDiscountOnCheckStub: type: boolean description: | If `true`, include any associated term discount on check stubs. default: true example: true term: type: object description: >- AP term or rules this vendor has established for extending credit to you. properties: key: type: string nullable: true example: '7' id: type: string nullable: true example: Net 30 href: type: string readOnly: true example: /objects/accounts-payable/term/7 billPayment: type: object properties: defaultDateOptions: type: string description: > The Default bill payment date defines how the Recommended to pay on date is calculated for vendor bills. **Valid values:** - `none`- Leaves the default unset, which allows you to choose the value from a different date field. - `dueDate` - Calculates the due date based on the selected Term, then adjusts based on the number of days specified as an offset. - `billDate` - Uses the date entered for the bill, adjusted for the number of days specified as an offset. Does not require that a Term be defined. - `discountDate` - Uses the discount details in the specified Term to calculate the discount date. No offset is used. enum: - none - dueDate - billDate - discountDate - null example: none nullable: true default: null offsetTypePlusMinus: type: string description: Offset type. enum: - + - '-' - null nullable: true example: + dueNumberOfDays: type: integer description: >- The number of days to use as an offset type from the default payment due date. nullable: true example: 5 billNumberOfDays: type: integer description: >- The number of days to use as an offset type from the default payment bill date. nullable: true example: 10 vendorAccountNumber: type: string description: | The account number that this vendor has assigned to you. nullable: true example: '203' displayVendorAccountOnCheckStub: type: boolean description: > If `true`, displays the vendor-assigned account number, per entity, on check stubs. default: false example: false totalDue: type: string description: Total amount due. readOnly: true format: decimal-precision-2 example: '100.00' lastBillCreatedDate: type: string format: date description: Date the last bill was created. readOnly: true nullable: true example: '2022-07-31' lastPaymentMadeDate: type: string format: date description: Date the last payment was made. readOnly: true nullable: true example: '2002-08-31' ach: type: object properties: enablePayments: type: boolean description: | If `true`, enable ACH payments for this vendor. default: false example: false routingNumber: type: string description: | ACH routing number for this vendor. nullable: true example: '061080227' accountNumber: type: string description: | ACH account number for this vendor. nullable: true example: '7624832485' accountType: type: string description: | ACH account type for this vendor. enum: - null - checkingAccount - savingsAccount example: checkingAccount nullable: true default: null remittanceType: type: string description: > ACH account classification for this vendor. Select the classification code that your bank uses for ACH payments. **Valid values:** - `businessCTX` - Business account that is a Corporate Trade Exchange (CTX) account. - `personalPPD` - An individual contractor's personal account. - `businessCCD` - Business account that is a Cash Concentration or Disbursement (CCD) corporate account. enum: - null - businessCTX - personalPPD - businessCCD example: businessCTX nullable: true default: null restrictions: type: object properties: restrictionType: type: string description: > Restrict vendors to only the top level company or for specific locations and departments. These restriction options are valid only for multi-entity companies that are [configured for restrictions](https://www.intacct.com/ia/docs/en_US/help_action/Multi-entity/Setup/configure-multi-entity.htm). Learn more about [restricting vendors](https://www.intacct.com/ia/docs/en_US/help_action/Accounts_Payable/Setup/Vendors/restrict-vendors-in-multi-entity-companies.htm). The following values specify who can view and post transactions against this vendor. **Valid values:** - `unrestricted` - The top level and all entities within the multi-entity structure. - `rootOnly` - Only the top level of the multi-entity structure. - `restricted` - Only the chosen locations, location groups, departments, or department groups within the multi-entity structure. enum: - null - unrestricted - rootOnly - restricted example: restricted nullable: true default: null locations: type: array example: - Dallas - Santa Fe - Las Vegas items: type: string departments: type: array example: - Sales - RDA - BD items: type: string audit: $ref: '#/components/schemas/audit' request: type: object properties: key: type: string description: System-assigned key for the vendor. example: '518' notes: type: string description: Notes or comments about this vendor. example: Approved, ready for use response: type: object properties: key: type: string readOnly: true example: '518' id: type: string readOnly: true example: V-00014 href: type: string readOnly: true example: /objects/accounts-payable/vendor/518 state: type: string description: Vendor state readOnly: true enum: - approved example: approved decline-request: type: object properties: key: type: string description: System-assigned key for the vendor. example: '518' notes: type: string description: Notes or comments about this vendor. example: Declined, missing information decline-response: type: object properties: key: type: string readOnly: true example: '518' id: type: string readOnly: true example: V-00014 href: type: string readOnly: true example: /objects/accounts-payable/vendor/518 state: type: string description: Vendor state readOnly: true enum: - declined example: declined accounts-payable-vendor-typeRequiredProperties: type: object required: - id accounts-payable-vendor-type: type: object description: >- Vendor types organize vendors into categories that are used for reporting. properties: key: type: string description: System-assigned key for the vendor type. example: '14' readOnly: true id: type: string description: Name or other unique identifier for the vendor type. example: Retail href: type: string description: URL for the vendor type. example: /objects/accounts-payable/vendor-type/14 readOnly: true status: $ref: '#/components/schemas/status' description: >- To assign vendors to a vendor type, the vendor type must be `active`. form1099: type: object description: > Form 1099 information for the vendor type. If vendors require 1099 forms, save time by creating a vendor type for 1099 contractors and assigning a default 1099 form and box to that vendor type. properties: type: type: string description: Type of 1099 form. example: DIV box: type: string description: Box number for form 1099. example: 1B parent: type: object description: >- Assign a parent to make this vendor type subordinate to another vendor type. properties: key: type: string description: System-assigned key for the parent vendor type. example: '1' id: type: string description: Name or other unique identifier for the parent vendor type. example: Wholesaler href: type: string description: URL for the parent vendor type. example: /objects/accounts-payable/vendor-type/1 readOnly: true audit: $ref: '#/components/schemas/audit' accounts-payable-vendor-payment-providerRequiredProperties: type: object required: - paymentProvider - vendor - status accounts-payable-account-labelRequiredProperties: type: object required: - id - description properties: glAccount: type: object required: - id accounts-payable-account-label: type: object description: AP account labels provide more descriptive names for accounts. properties: key: type: string description: System-assigned key for the AP account label. readOnly: true example: '12' id: type: string description: Name or other unique identifier for the account label. example: 'Benefits: Health' description: type: string description: A note about the purpose and use of the account label. example: Account for health benefit costs href: type: string description: URL for the AP account label. readOnly: true example: /objects/accounts-payable/account-label/12 status: $ref: '#/components/schemas/status' glAccount: type: object description: >- The general ledger account to assign to the label. This is typically a revenue account. properties: key: type: string description: System-assigned key for the general ledger account. example: '19' id: type: string description: General ledger account number. example: 1210--Equipment href: type: string readOnly: true example: /objects/general-ledger/account/19 offsetGLAccount: type: object description: >- The general ledger account where the system posts offsets to items posted to this label. This is typically a receivables account. properties: key: type: string description: System-assigned key for the offset general ledger account. example: '2' id: type: string description: Account number for the offset general ledger account. example: 1215--EquipmentOffset href: type: string readOnly: true example: /objects/general-ledger/account/2 form1099: type: object description: Form 1099 information. properties: type: type: string description: Form 1099 type. example: DIV box: type: string description: Box number for form 1099. example: 1B audit: $ref: '#/components/schemas/audit' accounts-payable-adjustmentRequiredProperties: type: object properties: vendor: type: object required: - id currency: type: object required: - txnCurrency lines: type: array items: required: - txnAmount - glAccount currency: type: object properties: exchangeRateDate: type: string format: date example: '2014-01-08' description: Exchange rate date exchangeRateTypeId: type: string description: Exchange rate type example: Intacct Daily Rate exchangeRate: type: number description: Exchange rate example: 0.78 baseCurrency: type: string description: Base currency example: USD txnCurrency: type: string description: Transaction currency example: GBP gl-account-ref: type: object properties: key: type: string description: Account key example: '144' id: type: string description: Account ID example: '1112' name: type: string description: Account title readOnly: true example: Employee Advances href: type: string description: URL endpoint of the general ledger account. readOnly: true example: /objects/general-ledger/account/144 dimension-ref: type: object properties: location: type: object properties: key: type: string description: Location key example: '22' id: type: string description: Location example: LOC-22 name: type: string description: Location name readOnly: true example: California href: type: string readOnly: true example: /objects/company-config/location/22 department: type: object properties: key: type: string description: Department key example: '11' id: type: string description: Department example: DEP-11 name: type: string description: Department name readOnly: true example: Sales and Marketing href: type: string readOnly: true example: /objects/company-config/department/11 employee: type: object properties: key: type: string description: Employee key example: '10' id: type: string description: Employee ID example: EMP-10 name: type: string description: Employee name readOnly: true example: Thomas, Glenn href: type: string example: /objects/company-config/employee/10 readOnly: true project: type: object properties: key: type: string description: Project key example: '2' id: type: string description: Project ID example: NET-XML30-2 name: type: string description: Project name readOnly: true example: Talcomp training href: type: string readOnly: true example: /objects/projects/project/2 customer: type: object properties: key: type: string description: Customer key example: '13' id: type: string description: Customer ID example: CUST-13 name: type: string description: Customer name readOnly: true example: Jack In the Box href: type: string readOnly: true example: /objects/accounts-receivable/customer/13 vendor: type: object properties: key: type: string description: Vendor key example: '357' id: type: string description: Vendor ID example: '1605212096809' name: type: string description: Vendor name readOnly: true example: GenLab href: type: string readOnly: true example: /objects/accounts-payable/vendor/357 item: type: object properties: key: type: string description: Item key example: '13' id: type: string description: Item ID example: Case 13 name: type: string description: Item name readOnly: true example: Platform pack href: type: string readOnly: true example: /objects/inventory-control/item/13 warehouse: type: object properties: key: type: string description: Warehouse key example: '6' id: type: string description: Warehouse ID example: WH01 name: type: string description: Warehouse name readOnly: true example: WH01 href: type: string readOnly: true example: /objects/inventory-control/warehouse/6 class: type: object properties: key: type: string description: Class key example: '731' id: type: string description: Class ID example: REST_CLS_001 name: type: string description: Class name readOnly: true example: Enterprises href: type: string readOnly: true example: /objects/company-config/class/731 task: type: object properties: id: type: string description: Task ID example: '1' key: type: string description: Task key example: '1' name: type: string description: Task name readOnly: true example: Project Task href: type: string readOnly: true example: /objects/projects/task/1 costType: type: object properties: id: type: string description: Cost Type ID example: '2' key: type: string description: Cost Type key example: '2' name: type: string description: Cost Type name readOnly: true example: Project Expense href: type: string readOnly: true example: /objects/construction/cost-type/2 asset: type: object properties: id: type: string description: Asset ID example: A001 key: type: string description: Asset key example: '1' name: type: string description: Asset name readOnly: true example: Laptop 1 contract: type: object properties: id: type: string description: Contract ID example: CON-0045-1 key: type: string description: Contract key example: '12' name: type: string description: Contract name readOnly: true example: ACME Widgets - Service href: type: string readOnly: true example: /objects/contracts/contract/12 accounts-payable-adjustment-line: type: object description: >- Line items in an AP adjustment represent transactions captured in that adjustment. properties: id: type: string description: Identifier for the AP adjustment line item. readOnly: true example: '1' key: type: string description: System-assigned key for the AP adjustment line item. readOnly: true example: '1' baseAmount: type: string format: decimal-precision-2 description: >- For multi-currency companies, Sage Intacct calculates the base amount by applying the exchange rate from the header to the transaction amount. example: '100' txnAmount: type: string format: decimal-precision-2 description: Amount for the AP adjustment line item in the transaction currency. example: '100' totalTxnAmount: type: string format: decimal-precision-2 description: For tax inclusive adjustments, provide a total transaction amount. example: '100.00' memo: type: string description: Memo or notes about the AP adjustment line item. example: Service adjustments lineNumber: type: string description: Line number readOnly: true example: '1' hasForm1099: type: string description: > If the vendor is set up for 1099 tracking and enabled for 1009 flag override, you can set to `true` to enable individual line items for 1099 treatment. If `false`, this line item does not have associated 1099 form type and box values. example: 'false' form1099: type: object description: Form 1099 information for the line item. properties: type: type: string description: | Type of form 1099. example: NEC nullable: true box: type: string description: | Box value of form 1099. example: 15A nullable: true adjustmentType: type: string description: Adjustment type for the line item. readOnly: true example: pa glAccount: $ref: '#/components/schemas/gl-account-ref' overriddenOffsetGLAccount: type: object description: The general ledger account where the system posts offsets. properties: key: type: string description: System-assigned key for the account. example: '384' id: type: string description: Offset account number. example: '1234.36' name: type: string description: Offset account name. readOnly: true example: AP ACCOUNT href: type: string readOnly: true example: /objects/general-ledger/account/384 accountLabel: type: object description: Meaningful name of AP account. properties: key: type: string description: System-assigned key for the account label. example: '14' nullable: true id: type: string description: Meaningful name of the account. example: Accounting Fees nullable: true href: type: string readOnly: true example: /objects/accounts-payable/account-label/14 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: department: type: object description: Department to assign the expense to. properties: key: type: string description: System-assigned key for the department. example: '1' nullable: true id: type: string description: ID of the department. example: '1' nullable: true name: type: string description: Name of the department. example: Accounting nullable: true href: type: string description: URL of the department. readOnly: true example: /objects/company-config/department/1 location: type: object description: Location to assign the expense to. properties: key: type: string description: System-assigned key for the location. example: '1' nullable: true id: type: string description: ID of the location. example: '1' nullable: true name: type: string description: Name of the location. example: India nullable: true href: type: string description: URL of the location. readOnly: true example: /objects/company-config/location/1 currency: type: object description: Currency details for multi-currency companies. properties: baseCurrency: type: string description: Base currency for the line item. readOnly: true example: USD txnCurrency: type: string description: Currency for the transaction. readOnly: true example: USD exchangeRate: type: object description: Exchange rate details used to calculate the base amount. title: exchangeRate properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. nullable: true rate: type: string 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: Intacct Daily Rate nullable: true paymentInformation: type: object description: Payment information for the AP adjustment line item. properties: totalBaseAmountPaid: type: string format: decimal-precision-2 description: Total paid for the line item. readOnly: true example: '100' txnTotalPaid: type: string format: decimal-precision-2 description: Transaction total paid for the line item. readOnly: true example: '200' totalBaseAmountSelected: type: string format: decimal-precision-2 description: Total selected for the line item. readOnly: true example: '100' txnTotalSelected: type: string format: decimal-precision-2 description: Total transaction selected for the line item. readOnly: true example: '100' apAdjustment: description: Header level details for the AP adjustment's line items. type: object properties: id: type: string description: Identifier for the AP adjustment. readOnly: true example: '1' key: type: string description: System-assigned key for the AP adjustment. readOnly: true example: '1' href: type: string description: URL for the adjustment. readOnly: true example: /objects/accounts-payable/adjustment/24 readOnly: true audit: $ref: '#/components/schemas/audit' accounts-payable-adjustment: type: object description: >- AP adjustments can be used to increase or decrease the amount you owe a vendor. properties: key: type: string description: System-assigned key for the AP adjustment. readOnly: true example: '1' id: type: string description: Unique identifier for the AP adjustment. readOnly: true example: '1' adjustmentNumber: type: string description: Adjustment number to track the AP adjustment. example: '1' recordType: type: string description: >- Record type to identify the type of transaction. AP Adjustment record type refers to `pa`. readOnly: true example: pa action: type: string description: >- The action state of the AP adjustment. The default action state is `submit`. enum: - draft - submit example: draft default: submit state: type: string description: Processing state of the AP adjustment. readOnly: true enum: - reversed - reversal - draft - noValue - posted - paid - partiallyPaid - selected example: paid vendor: type: object description: Vendor associated with the AP adjustment. properties: id: type: string description: Unique identifier for the vendor. example: Vendor_01 key: type: string description: System-assigned key for the vendor. example: '15' name: type: string description: name of the vendor. example: Logic Solutions vendorDue: type: string format: decimal-precision-2 description: Transaction vendor total due. readOnly: true example: '100' href: type: string description: URL for the vendor. readOnly: true example: /objects/accounts-payable/vendor/1 description: type: string description: Description of the AP adjustment. example: >- Computer Hardware & Software Expenses 03/01/20 - 08/31/21 Subscription charges. createdDate: type: string format: date example: '2021-01-23' description: Created date of the AP adjustment. isTaxInclusive: type: boolean description: Set to `true` if adjustment amounts already include taxes. example: false default: false totalEntered: type: string format: decimal-precision-2 description: Total amount of the AP adjustment. readOnly: true example: '100.20' totalBaseAmountDue: type: string format: decimal-precision-2 description: Total amount due. readOnly: true example: '251464.01' txnTotalEntered: type: string format: decimal-precision-2 description: Total transaction amount. readOnly: true example: '1000.20' txnTotalDue: type: string format: decimal-precision-2 description: Total transaction amount due. readOnly: true example: '100.50' taxSolution: type: object description: Tax solution details for this adjustment. properties: key: type: string description: System-assigned key to uniquely identify the tax solution. example: '4' nullable: true id: type: string description: Name or other unique identifier for the tax solution. example: Australia GST nullable: true showMultiLineTax: type: string description: Set to `true` to enable multiple taxes per line. example: 'true' nullable: true method: type: string description: Tax method used in this adjustment. example: VAT nullable: true href: type: string readOnly: true example: /objects/tax/tax-solution/4 adjustmentSummary: type: object description: >- Summary details for this adjustment. Summaries are collections of the same types of transactions grouped together for processing. properties: key: type: string description: System-assigned key to uniquely identify the summary. example: '280' id: type: string description: System-assigned ID for the summary. example: '280' name: type: string description: Name of the summary. readOnly: true example: 'Adjustments: 2022/01/01 Batch' glPostingDate: type: string format: date example: '2021-01-23' description: Posted date of the AP adjustment. isSummaryOpen: type: string description: >- A summary can be open or closed. Items, such as invoices, can be added to open summaries. enum: - open - closed example: open readOnly: true isSummaryPosted: type: string description: If `true`, the summary has been posted to the General Ledger. readOnly: true example: 'false' href: type: string readOnly: true example: /objects/accounts-payable/adjustment-summary/280 moduleKey: type: string description: Module key, source module from which transaction got created. readOnly: true example: 3.AP currency: $ref: '#/components/schemas/currency' contacts: type: object description: Contacts for this AP adjustment. properties: payTo: type: object description: The vendor contact to be paid. title: payTo properties: key: type: string description: System-assigned key for the contact. example: '916' id: type: string description: Unique identifier for the contact. example: Power Aerospace Materials(C1) tax: type: object title: tax description: Tax related information for the pay to contact. properties: taxId: type: string description: Tax Identification Number example: 252-85-7897 nullable: true group: type: object description: Contact tax group associated with the pay to contact. properties: key: type: string example: '288' nullable: true id: type: string example: Goods Zero Rate - CA nullable: true href: type: string readOnly: true example: /objects/tax/contact-tax-group/288 href: type: string description: URL for the contact. readOnly: true example: /objects/company-config/contact/1 returnTo: type: object description: The vendor contact for return of the purchase. title: returnTo properties: key: type: string description: System-assigned key for the contact. example: '916' id: type: string description: Unique identifier for the contact. example: Power Aerospace Materials(C1) href: type: string description: URL for the contact. readOnly: true example: /objects/company-config/contact/1 referenceNumber: type: string description: >- This is a number such as a purchase order or account number that might be useful in searches or reports. This number shows on the GL Details report and prints on the check and vendor Stubs. example: INV-902852 paymentInformation: type: object description: Payment information for the AP adjustment. properties: paidDate: type: string format: date example: '2021-01-23' description: Date the AP adjustment was paid. readOnly: true nullable: true totalBaseAmountPaid: type: string format: decimal-precision-2 description: Total paid for the AP adjustment. readOnly: true example: '100' totalBaseAmountSelected: type: string format: decimal-precision-2 description: Total selected for the AP adjustment. readOnly: true example: '100.10' txnTotalSelected: type: string format: decimal-precision-2 description: Total transaction selected. readOnly: true example: '1000.05' txnTotalPaid: type: string format: decimal-precision-2 description: Transaction total paid. readOnly: true example: '2000.50' audit: $ref: '#/components/schemas/audit' lines: type: array items: $ref: '#/components/schemas/accounts-payable-adjustment-line' ap-record-type: type: string description: Record type enum: - apAdjustments - apBill - apDiscount - apAppliedAdvance - apPayment - apAdvance - arAdjustments - arDiscount - interEntityReceivable - arInvoice - arRealizedMultiCurrencyGainLoss - arAppliedAdvanceOverpayment - arReceipts - arAdvance - employeeExpenses - employeeReimbursements - expenseAdjustment - manualCheck example: apBill accounts-payable-adjustment-summary: type: object description: >- Accounts Payable (AP) Adjutsment summaries are collections of the same type of transactions, grouped together for processing. properties: key: type: string description: System-assigned key for the AP adjustment summary. readOnly: true example: '1' id: type: string description: Unique identifier for the AP adjustment summary. readOnly: true example: '1' href: type: string description: Endpoint for the AP adjustment summary readOnly: true example: /objects/accounts-payable/adjustment-summary/1 name: type: string description: >- Name of the AP adjustment summary. This name is used to identify the summary throughout the Accounts Payable application. example: Adjustment Batch Jan 2021 summaryCreationType: type: string enum: - system - manual description: >- If set to manual, then the summary was created by a user and if set to system, then the summary was created by Intacct based on the summary frequency. default: manual example: manual readOnly: true status: $ref: '#/components/schemas/status' recordType: $ref: '#/components/schemas/ap-record-type' description: The adjustment summary type. readOnly: true example: apAdjustments totalAmount: type: string format: decimal-precision-2 description: The adjustment summary total amount. readOnly: true example: '656.82' parent: type: object description: Parent adjustment summary. properties: key: type: string description: System-assigned key for the parent adjustment summary. example: '22' id: type: string description: Identifier for the parent. example: '22' href: type: string description: URL for the Adjustment Summary. readOnly: true example: /objects/accounts-payable/summary/22 preventGLPosting: type: boolean description: Specifies whether to allow posting to the general ledger (GL). default: false readOnly: true example: false bankAccountId: type: object description: Bank account ID. properties: key: type: string description: System-assigned key for the bank account. example: '1' id: type: string description: Identifier for the GL account. example: '1' href: type: string description: URL for the bankaccount. readOnly: true example: /objects/cash-management/bank-account/23 glPostingDate: type: string format: date description: >- The date that the items in the adjustment summary should post to the general ledger. example: '2022-08-02' state: type: string enum: - open - closed description: >- State of the Adjustment summary, which can be `open` or `closed`. An open Adjustment summary can have items added to it. example: open isQuickPaymentSummary: type: boolean description: >- This field is set to true only for manual and quick payment summaries. It is set to false for transactions of type bill/adjustment. default: false example: false accounts-payable-billRequiredProperties: type: object required: - dueDate properties: vendor: type: object required: - id currency: type: object required: - txnCurrency lines: type: array items: required: - txnAmount - glAccount location-ref: type: object properties: key: type: string description: Location Key example: '1' id: type: string description: Location example: US name: type: string description: Location Name readOnly: true example: United States of America href: type: string example: /objects/company-config/location/1 readOnly: true accounts-payable-bill-line: type: object description: Line items for an Accounts Payable (AP) bill. properties: id: type: string description: System-assigned ID for the line item. readOnly: true example: '62' key: type: string description: System-assigned key for the line item. readOnly: true example: '62' lineNumber: type: string description: Line number readOnly: true example: '1' hasForm1099: type: string description: > If the vendor is set up for 1099 tracking and enabled for 1009 flag override, you can set to `true` to enable individual line items for 1099 treatment. If `false`, this line item does not have associated 1099 form type and box values. example: 'false' form1099: type: object description: Form 1099 information for the line item. properties: type: type: string description: | Type of form 1099. example: NEC nullable: true box: type: string description: | Box value of form 1099. example: 15A nullable: true state: type: string description: System-assigned state of the line item. readOnly: true example: A createdDate: type: string format: date example: '2021-01-23' description: Created Date readOnly: true glAccount: type: object description: General Ledger (GL) account associated with the line item. properties: key: type: string description: System-assigned key for the GL account. example: '256' id: type: string description: User-assigned number for the GL account. example: '6252' name: type: string description: Name of the GL account. readOnly: true example: Entertainment href: type: string readOnly: true example: /objects/general-ledger/account/256 overrideOffsetGLAccount: type: object description: >- An alternative AP account to override the default GL AP account for the bill. properties: key: type: string description: System-assigned key for the account. example: '384' id: type: string description: Offset account number. example: '1234.36' name: type: string description: Offset account name. readOnly: true example: AP ACCOUNT href: type: string readOnly: true example: /objects/general-ledger/account/384 accountLabel: type: object description: Meaningful name of AP account. properties: key: type: string description: System-assigned key for the account label. example: '14' nullable: true id: type: string description: Meaningful name of the account. example: Accounting Fees nullable: true href: type: string readOnly: true example: /objects/accounts-payable/account-label/14 baseAmount: type: string format: decimal-precision-2 description: >- Amount for the line item in your company's base currency, which is calculated based on the exchange rate defined in the header. readOnly: true example: '100.00' txnAmount: type: string format: decimal-precision-2 description: >- For multi-currency companies, provide a transaction amount, which is the amount in the transaction currency. example: '100.00' totalTxnAmount: type: string format: decimal-precision-2 description: For tax inclusive bills, provide a total transaction amount. example: '100.00' memo: type: string description: Memo about the line item. example: Service charges nullable: true allocation: type: object description: >- Transaction allocation template for the line item, which distributes the bill amount across specified dimensions. properties: key: type: string description: System-assigned key for the allocation. example: '1' nullable: true id: type: string description: System-assigned ID for the allocation. example: Alloc1-WBS-US nullable: true currency: type: object description: Currency details for the bill. properties: baseCurrency: type: string description: Base currency for the company. readOnly: true example: USD txnCurrency: type: string description: Transaction currency for the bill. readOnly: true example: GBP exchangeRate: type: object title: exchangeRate description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true nullable: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: 1.0789 nullable: true typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '1' nullable: true paymentInformation: type: object description: Payment information for the line item. properties: totalBaseAmountPaid: type: string format: decimal-precision-2 description: Total base amount that was paid. readOnly: true example: '100.00' totalTxnAmountPaid: type: string format: decimal-precision-2 description: Total transaction amount that was paid. readOnly: true example: '100.00' totalBaseAmountSelectedForPayment: type: string format: decimal-precision-2 description: Total base amount selected for the payment. readOnly: true example: '100.00' totalTxnAmountSelectedForPayment: type: string format: decimal-precision-2 description: Total transaction amount selected for the payment. readOnly: true example: '100.00' releaseToPay: type: boolean description: | If `true`, then this line item is available for the payment. example: true default: false nullable: true isSubTotal: type: string description: | If set to `S`, this is a subtotal. If set to'T', this is tax. enum: - subtotal - tax - null readOnly: true example: subtotal nullable: true default: null baseLocation: type: object allOf: - $ref: '#/components/schemas/location-ref' - type: object properties: key: type: string description: Base location key. example: '4' retainage: type: object description: >- Retainage information for the line item. (For Construction subscriptions only.) Retainage is a portion of the agreed upon contract price withheld until the work is substantially complete. readOnly: true properties: hasRetainage: type: boolean description: If `true`, retainage applies to the line item. readOnly: true example: true default: false percentage: type: string format: decimal-precision-2 description: Retainage percentage for the line item. readOnly: true example: '2' baseAmountRetained: type: string format: decimal-precision-2 description: Base amount retained for the line item. readOnly: true example: '20.00' txnAmountRetained: type: string format: decimal-precision-2 description: Transaction amount retained for the line item. readOnly: true example: '20.00' txnAmountReleased: type: string format: decimal-precision-2 description: Transaciton amount released for the line item. readOnly: true example: '10.00' release: type: boolean description: Indicates whether retainage is released to pay. readOnly: true example: true default: false project: type: object description: Project-related information for the line item. properties: isBillable: type: boolean description: Indicates whether the line item is marked as billable. example: true default: false isBilled: type: boolean description: Indicates whether the line item is billed. readOnly: true example: true default: false fixedAsset: type: object description: Asset information for the line item. properties: nameOfAcquiredAsset: type: string description: Identified for asset acquisition name. example: ergonomic chair nullable: true includeTaxInAssetCost: type: boolean description: Indicates whether the line item taxable for asset. readOnly: false default: false example: true purchasing: type: object description: Purchasing information for the line item. properties: document: type: object title: purchasingDocument properties: key: type: string description: System-assigned key of the primary purchasing document. example: '2437' id: type: string description: User assigned document number. example: Sales Invoice-INV0110 href: type: string readOnly: true example: /objects/purchasing/document/15 documentLine: type: object description: Line details for the purchasing document. title: purchasingDocumentLine properties: key: type: string description: System-assigned key for the line in the primary document. example: '750' id: type: string description: Number of the line in the primary document. example: '3' href: type: string readOnly: true example: /objects/purchasing/document-line/750 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of locations to reflect how your company is organized. title: location properties: key: type: string description: System-assigned key for the location. example: '4' nullable: true id: type: string description: Unique identifier of the location. example: AU nullable: true name: type: string description: Name of the location. readOnly: true example: Australia nullable: true href: type: string readOnly: true example: /objects/company-config/location/4 department: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string description: System-assigned key for the department. example: '9' nullable: true id: type: string description: Unique identifier of the department. example: '01' nullable: true name: type: string description: Name of the department. readOnly: true example: Accounting nullable: true href: type: string readOnly: true example: /objects/company-config/department/9 bill: type: object description: Header level details for the bill's line entries. properties: id: type: string description: System-assigned ID for the bill. example: '19876' key: type: string description: System-assigned key for the bill. example: '19876' href: type: string description: URL for the bill. readOnly: true example: /objects/accounts-payable/bill/19876 accounts-payable-bill: type: object description: >- An AP bill is a statement of charges for money owed to a vendor for goods or services. properties: key: type: string description: System-assigned key for the bill. readOnly: true example: '986' id: type: string description: System-assigned ID for the bill. readOnly: true example: '986' billNumber: type: string description: > Vendor-assigned identifier for the bill. This is the vendor-assigned number provided on the bill. This number is unique and can be used to look up bill details. You must specify a bill number when creating a bill unless document sequencing is configured, in which case the number is auto-generated. example: Bill-001 nullable: true state: type: string description: > A bill's state shows the current status of the bill within the workflow. For details about each state, see [Bill state descriptions](https://www.intacct.com/ia/docs/en_US/help_action/Accounts_Payable/Bills/bill-state-descriptions.htm). enum: - reversed - reversal - analyzing - partiallyApproved - submitted - declined - noValue - posted - paid - partiallyPaid - selected example: posted readOnly: true recordType: type: string description: >- The record type for the bill. Accounts Payable bills are record type `pi`. readOnly: true example: pi vendor: type: object description: Vendor to which this bill is linked. properties: key: type: string description: System-assigned key for the vendor. example: '15' id: type: string description: Unique identifier of the vendor. example: V-00014 name: type: string description: Name of the vendor. readOnly: true example: Pac bell href: type: string readOnly: true example: /objects/accounts-payable/vendor/15 vendorDue: type: string format: decimal-precision-2 description: Total transaction amount due for the vendor. readOnly: true example: '100' form1099: type: object description: Form 1099 information for the vendor. title: Form1099 readOnly: true properties: type: type: string description: | Type of 1099 form for the vendor. readOnly: true example: NEC nullable: true box: type: string description: | Box number for form 1099. readOnly: true example: 15A nullable: true vendorTypeForm1099Type: type: string description: | Type of 1099 form for the vendor. readOnly: true example: MISC nullable: true term: type: object description: Term details for the bill. properties: key: type: string description: System-assigned key for the term. example: '16' nullable: true id: type: string description: Name of the term. example: Net 75 nullable: true href: type: string readOnly: true example: /objects/accounts-payable/term/16 referenceNumber: type: string description: >- This is a number such as a purchase order or account number that might be useful in searches or reports. This number shows on the GL Details report and prints on the check and vendor Stubs. example: INV-902852 nullable: true description: type: string description: Additional information about the bill. example: Annual maintenance charge nullable: true dueInDays: type: string description: Number of days until due date for the bill. readOnly: true example: '8' postingDate: type: string format: date example: '2021-01-23' description: GL Posting date of the bill. discountCutOffDate: type: string format: date example: '2021-01-23' description: Date after which the discount for the bill is no longer valid. nullable: true dueDate: type: string format: date example: '2021-01-23' description: Due date for the bill. recommendedPaymentDate: type: string format: date example: '2021-01-23' description: >- Recommended payment date for the bill. If a Default bill payment date is set on the vendor record, Intacct calculates the recommended payment date.\nYou can override the calculated date or, if there is no Default payment date for the vendor, provide a date when you create a bill. nullable: true createdDate: type: string format: date example: '2021-01-23' description: Date that the bill was created. isOnHold: type: boolean description: Set to `true` to place this bill on hold. example: false default: false isTaxInclusive: type: boolean description: Set to `true` if bill amounts already include taxes. example: false default: false paymentPriority: type: string enum: - urgent - high - normal - low description: > The payment priority for this bill, which enables you to easily identify and pay the most urgent bills first. example: urgent default: normal totalBaseAmount: type: string format: decimal-precision-2 description: >- Total base amount calculated for the bill. For multi-currency companies, Intacct calculates this amount in your company's base currency by applying the exchange rate to the total transaction amount. readOnly: true example: '100' totalBaseAmountDue: type: string format: decimal-precision-2 description: >- For multi currency companies, the total amount due for the bill in your company's base currency. readOnly: true example: '10' totalTxnAmount: type: string format: decimal-precision-2 description: Total transaction amount of the bill. readOnly: true example: '100' totalTxnAmountDue: type: string format: decimal-precision-2 description: Total amount due for the bill. readOnly: true example: '10' isSystemGenerated: type: string readOnly: true description: > If `T`, then this bill record is created by the system internally and not created based on user input. example: F default: F purchasing: type: object properties: documentId: type: string description: Document ID of the vendor invoice. example: Vendor Invoice-root-VI#0031#doc nullable: true recurringSchedule: type: object description: Recurring schedule used to automate the billing process. properties: key: type: string description: System-assigned key to uniquely identify the recurring schedule. example: '20' nullable: true contacts: type: object properties: payTo: type: object description: Pay to contact information from the vendor record. title: payTo properties: key: type: string description: System-assigned key to uniquely identify the contact. example: '416' id: type: string description: Name of the contact. example: Klay Vanderbilt tax: type: object title: tax description: Tax related information for the pay to contact. properties: taxId: type: string description: Tax Identification Number example: 252-85-7897 nullable: true group: type: object description: Contact tax group associated with the pay to contact. properties: key: type: string example: '288' nullable: true id: type: string example: Goods Zero Rate - CA nullable: true href: type: string readOnly: true example: /objects/tax/contact-tax-group/288 href: type: string readOnly: true example: /objects/company-config/contact/416 returnTo: type: object description: Return to contact information from the vendor record. title: returnTo properties: key: type: string description: System-assigned key to uniquely identify the contact. example: '416' id: type: string description: Name of the contact example: Yusuf Pringle href: type: string readOnly: true example: /objects/company-config/contact/416 currency: type: object description: Currency details for this bill. properties: baseCurrency: type: string description: Base currency for your company. example: USD txnCurrency: type: string description: >- The transaction currency to use for this bill. If this currency is different from the base currency, provide an exchange rate. example: USD exchangeRate: type: object description: Exchange rate details used to calculate the base amount. title: exchangeRate properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. nullable: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. example: 1.0789 nullable: true typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: '1' nullable: true taxSolution: type: object description: Tax solution details for this bill. properties: key: type: string description: System-assigned key to uniquely identify the tax solution. example: '4' nullable: true id: type: string description: Name or other unique identifier for the tax solution. example: Australia GST nullable: true showMultiLineTax: type: string description: Set to `true` to enable multiple taxes per line. example: 'true' nullable: true method: type: string description: Tax method used in this bill. example: VAT nullable: true href: type: string readOnly: true example: /objects/tax/tax-solution/4 billSummary: type: object description: >- Summary details for this bill. Summaries are collections of the same types of transactions grouped together for processing. properties: key: type: string description: System-assigned key to uniquely identify the summary. example: '280' id: type: string description: System-assigned ID for the summary. example: '280' name: type: string description: Name of the summary. readOnly: true example: 'Bills: 2022/01/01 Batch' isSummaryOpen: type: string description: >- A summary can be open or closed. Items, such as invoices, can be added to open summaries. enum: - open - closed example: open readOnly: true isSummaryPosted: type: string description: If `true`, the summary has been posted to the General Ledger. readOnly: true example: 'false' href: type: string readOnly: true example: /objects/accounts-payable/bill-summary/280 sourceModule: type: string description: Source module for the bill. enum: - accountsPayable - purchasing example: purchasing readOnly: true default: accountsPayable paymentInformation: type: object description: Payment information for the bill. properties: fullyPaidDate: type: string format: date example: '2021-01-23' description: Date on which the bill was fully paid. nullable: true totalBaseAmountPaid: type: string format: decimal-precision-2 description: Total base amount that was paid. readOnly: true example: '100' totalBaseAmountSelectedForPayment: type: string format: decimal-precision-2 description: Total base amount selected for the payment. readOnly: true example: '100' totalTxnAmountSelectedForPayment: type: string format: decimal-precision-2 description: Total transaction amount selected for the payment. readOnly: true example: '100' totalTxnAmountPaid: type: string format: decimal-precision-2 description: Total transaction amount that was paid. readOnly: true example: '100' retainage: type: object description: >- Retainage information for the bill. (For Construction subscriptions only.) Retainage is a portion of the agreed upon contract price withheld until the work is substantially complete. properties: defaultPercentage: type: string format: decimal-precision-2 description: Default retainage percentage for the customer. readOnly: true example: '5' nullable: true totalTxnAmountRetained: type: string format: decimal-precision-2 description: Total transaction amount retained. readOnly: true example: '200' totalTxnAmountReleased: type: string format: decimal-precision-2 description: Total transaction amount released. readOnly: true example: '100' totalBaseAmountRetained: type: string format: decimal-precision-2 description: Total base amount retained. readOnly: true example: '100' billBackTemplate: type: object description: Bill back template for recurring bill back transactions. properties: key: type: string description: System-assigned key for the bill back template. example: '121' id: type: string description: System-assigned ID for the bill back template. example: '121' enableInterEntityPostings: type: boolean description: >- Flag used to enable inter entity posting to post directly to the mapped inter-entity offset accounts instead of the AR and AP offset accounts. readOnly: true default: true example: true href: type: string readOnly: true example: /objects/accounts-payable/billback-template/12 smartTransactions: type: object description: Smart transactions information for the bill. properties: fileUpload: type: object title: File upload description: >- Smart transactions information for transactions created using file upload. properties: importExceptions: type: string description: Import status for uploaded files. enum: - null - resolve - completed - pending - draftReady example: pending nullable: true default: null importIssuesErrorMessage: type: string description: Error message related to file upload. readOnly: true example: The vendor A100 is invalid nullable: true email: type: object title: Email description: >- Smart transactions information for transactions created using email. properties: recipientEmail: type: string description: recipient email readOnly: true example: joe.smith@abcompany.com nullable: true senderEmail: type: string description: sender email readOnly: true example: john.doe@acme.com nullable: true documentSource: type: string description: Source of a supporting document. enum: - null - billUpload - email example: email nullable: true default: null attachment: type: object description: Supporting document attached to the bill. properties: key: type: string description: System-assigned key for the supporting document. example: '18' nullable: true id: type: string description: System-assigned ID for the supporting document. example: '18' nullable: true href: type: string readOnly: true example: /objects/company-config/attachment/18 location: $ref: '#/components/schemas/location-ref' lines: type: array description: Line items of the bill items: $ref: '#/components/schemas/accounts-payable-bill-line' audit: $ref: '#/components/schemas/audit' record-type: type: string description: Record type enum: - debitCardTransaction - creditCardFees - depositSlips - bankCharge - creditCardCharge - manualCheck - bankInterest - creditCardPayment - quickInvoice - otherReceipts - fundsTransfer - cashMgmtPrintedQuickCheck - chargePayoffPayment - employeeExpenses - expenseRealizedMultiCurrencyGainLoss - appliedEmployeeAdvance - employeeReimbursements - employeeAdvance - apAdjustments - apDiscount - interEntityPayable - apBill - apRealizedMultiCurrencyGainLoss - apAppliedAdvance - apPayment - apAdvance - arAdjustments - arDiscount - interEntityReceivable - arInvoice - arRealizedMultiCurrencyGainLoss - arAppliedAdvanceOverpayment - arReceipts - arAdvance - journalEntry - arJournalEntry - apJournalEntry - arInitialOpenItems - apInitialOpenItems - arInitialOpenItemSummary - apInitialOpenItemSummary - arCcInitialOpenItems - apCcInitialOpenItems - arCcInitialOpenItemSummary - apCcInitialOpenItemSummary readOnly: true example: otherReceipts accounts-payable-bill-summary: type: object description: >- Accounts Payable (AP) summaries are collections of the same type of transactions, grouped together for processing. properties: key: type: string description: System-assigned key for th AP bill summary. readOnly: true example: '1' id: type: string description: Unique identifier for the AP bill summary. readOnly: true example: '1' href: type: string description: Endpoint for the bill-summary readOnly: true example: /objects/accounts-payable/bill-summary/1 name: type: string description: >- Name of the AP bill summary. This name is used to identify the summary throughout the Accounts Payable application. example: Bill Batch Jan 2021 summaryCreationType: type: string enum: - system - manual description: >- If set to manual, then the summary was created by a user and if set to system, then the summary was created by Intacct based on the summary frequency. default: manual example: manual readOnly: true status: $ref: '#/components/schemas/status' recordType: $ref: '#/components/schemas/record-type' description: The bill summary type. readOnly: true example: apBill totalAmount: type: string format: decimal-precision-2 description: The bill summary total amount. readOnly: true example: '656.82' parent: type: object description: Parent bill summary. properties: key: type: string description: System-assigned key for the parent bill summary. example: '22' id: type: string description: Identifier for the parent. example: '22' href: type: string description: URL for the Bill Summary. readOnly: true example: /objects/accounts-payable/summary/22 preventGLPosting: type: boolean description: Specifies whether to allow posting to the general ledger (GL). default: false readOnly: true bankAccountId: type: object description: Bank account ID. properties: key: type: string description: System-assigned key for the GL account. example: BOA id: type: string description: Identifier for the GL account. example: BOA href: type: string description: URL for the bankaccount. readOnly: true example: /objects/cash-management/bank-account/23 glPostingDate: type: string format: date description: >- The date that the items in the bill summary should post to the general ledger. example: '2022-08-02' readOnly: true state: type: string enum: - open - closed description: >- State of the Bill summary, which can be `open` or `closed`. An open Bill summary can have items added to it. example: open isQuickPaymentSummary: type: boolean description: >- This field is set to true only for manual and quick payment summaries. It is set to false for transactions of type bill/adjustment. default: false example: false accounts-payable-paymentRequiredProperties: type: object required: - financialAccount - vendor - paymentMethod - paymentDate properties: details: type: array items: type: object required: - bill properties: txnCurrency: type: object required: - paymentAmount txnCurrency: type: object required: - currency accounts-payable-payment-detail: type: object description: >- An AP payment detail object includes an AP bill or AP adjustment credit memo to pay and optional transactions to apply as credits. properties: key: type: string description: ID for the AP payment detail. readOnly: true example: '1083' id: type: string description: >- Identifier for the AP payment detail. This value is the same as `key` for this object. readOnly: true example: '1083' href: type: string description: URL endpoint for the ap-payment-detail object. readOnly: true example: /objects/accounts-payable/payment-detail/1083 paymentDate: type: string format: date description: Date the payment was made. readOnly: true nullable: false example: '2023-04-04' baseCurrency: type: object description: Detail amounts in the company's base currency. properties: paymentAmount: type: string description: The amount of the payment in the company's base currency. example: '10' inlineAmount: type: string description: Inline transaction base amount. readOnly: true example: '10' nullable: true discountAmount: type: string description: Discount base amount. readOnly: true example: '10' nullable: true adjustmentAmount: type: string description: Adjustment transaction base amount. readOnly: true example: '10' nullable: true postedAdvanceAmount: type: string description: Posted advance base amount. readOnly: true example: '10' nullable: true txnCurrency: type: object description: Detail amounts in the transaction currency. properties: currency: type: string description: Payment currency. readOnly: true example: USD paymentAmount: type: string description: The amount of the payment in the transaction currency. nullable: false example: '10' inlineAmount: type: string description: Inline transaction amount. example: '10' nullable: true discountAmount: type: string description: Discount transaction amount. readOnly: true example: '10' nullable: true adjustmentAmount: type: string description: Adjustment transaction amount. example: '10' nullable: true postedAdvanceAmount: type: string description: Posted advance transaction amount. example: '10' nullable: true discountDate: type: string format: date description: Discount date. example: '2023-04-04' nullable: true state: type: string description: State of the payment. readOnly: true example: D moduleKey: type: string description: Module key. readOnly: true nullable: false example: 3.AP apDebitAdjustment: type: object description: AP adjustment to pay. properties: href: type: string description: URL for the AP adjustment. readOnly: true example: /objects/accounts-payable/adjustment/3319 key: type: string description: System-assigned key for the AP adjustment. example: '3319' nullable: true id: type: string description: Identifier for the AP adjustment. example: '3319' nullable: true apDebitAdjustmentLine: type: object description: Line item in the AP adjustment. properties: href: type: string description: URL for the AP adjustment line item. readOnly: true example: /objects/accounts-payable/adjustment-line/30854 key: type: string description: System-assigned key for the AP adjustment line item. example: '30854' nullable: true id: type: string description: Identifier for the AP adjustment line item. example: '30854' nullable: true bill: type: object description: AP bill to pay. properties: href: type: string description: URL for the AP bill. readOnly: true example: /objects/accounts-payable/bill/3318 key: type: string description: System-assigned key for the bill. example: '3318' id: type: string description: ID for the bill. example: '3318' billLine: type: object description: Line item in the AP bill. properties: href: type: string description: URL for the bill line item. readOnly: true example: /objects/accounts-payable/bill-line/30844 key: type: string description: System-assigned key for the bill line item. example: '30844' id: type: string description: ID for the bill line item. example: '30844' apDiscount: type: object description: Discount transaction included in the AP payment details. properties: key: type: string description: System-assigned key for the discount. example: '123' nullable: true id: type: string description: ID for the discount. example: '123' nullable: true apDiscountLine: type: object description: Line item in the discount transaction. properties: key: type: string description: System-assigned key for the discount line item. readOnly: true example: '12344' nullable: true id: type: string description: ID for the discount line item. readOnly: true example: '12344' nullable: true readOnly: true apPayment: type: object description: ap-payment object that this ap-payment-detail object is part of. properties: href: type: string description: URL for the AP payment. readOnly: true example: /objects/accounts-payable/payment/3325 key: type: string description: System-assigned key for the AP payment. example: '3325' id: type: string description: System-assigned key for the AP payment. example: '3325' apPaymentLine: type: object description: >- ap-payment-line object that this ap-payment-detail object is part of. properties: href: type: string description: URL for the AP payment line. readOnly: true example: /objects/accounts-payable/payment-line/30917 key: type: string description: System-assigned key for the AP payment line. example: '30917' id: type: string description: ID for the AP payment line. example: '30917' inlineBill: type: object properties: href: type: string description: URL endpoint for the inline bill. readOnly: true example: /objects/accounts-payable/bill/3321 key: type: string description: Inline transaction record number. example: '3321' nullable: true id: type: string description: Inline transaction record ID. example: '3321' nullable: true inlineBillLine: type: object properties: href: type: string description: URL endpoint for the inline bill line. readOnly: true example: /objects/accounts-payable/bill-line/30866 key: type: string description: Inline transaction entry record number. example: '30866' nullable: true id: type: string description: Inline transaction entry record ID. example: '30866' nullable: true apCreditAdjustment: type: object properties: href: type: string description: URL for the positive adjustment. readOnly: true example: /objects/accounts-payable/adjustment/3321 key: type: string description: Positive adjustment record number. example: '3321' nullable: true id: type: string description: Positive adjustment record ID. example: '3321' nullable: true apCreditAdjustmentLine: type: object properties: href: type: string description: URL for the positive adjustment item. readOnly: true example: /objects/accounts-payable/adjustment/33213 key: type: string description: Positive adjustment record number. example: '33213' nullable: true id: type: string description: Positive adjustment record ID. example: '33213' nullable: true audit: $ref: '#/components/schemas/audit' accounts-payable-payment-line: type: object description: AP payment line items represent entries in an AP payment object. properties: key: type: string description: System-assigned unique key for the AP payment line item. readOnly: true example: '23' id: type: string description: >- ID for the AP payment line item. This value is the same as `key` for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the AP payment line item. readOnly: true example: /objects/accounts-payable/payment-line/23 description: type: string description: Memo or brief description of the AP payment line item. example: Penalty exchangeRate: type: object description: Exchange rate details used to calculate the base amount. readOnly: true properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. readOnly: true rate: type: string description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: '1.0789' typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '1' nullable: true lineNumber: type: integer description: Line number of the AP payment line item. readOnly: true example: 1 baseCurrency: type: object description: Line item amounts in base currency. readOnly: true properties: currency: type: string description: Base currency. readOnly: true example: USD amount: type: string description: Base amount. readOnly: true example: '10' totalPaid: type: string description: Total paid for the line item. readOnly: true example: '10' totalSelected: type: string description: Total selected for the line item. readOnly: true example: '0' txnCurrency: type: object description: Line item amounts in transaction currency. readOnly: true properties: currency: type: string description: Transaction currency. readOnly: true example: USD amount: type: string description: Transaction amount. readOnly: true example: '10' totalPaid: type: string description: Transaction total paid for the line item. readOnly: true example: '10' totalSelected: type: string description: Total transaction selected for the line item. readOnly: true example: '0' paymentLineRecord: type: string description: | Record type of the line item: * `pp` - AP payment record * `po` - applied advance record readOnly: true example: pp baseLocation: type: string description: Base location key. readOnly: true example: '2' isTax: type: boolean description: Indicates whether the line item amount includes taxes. readOnly: true example: true default: false taxDetail: type: object description: Tax category for the line item. readOnly: true properties: key: type: string description: System-assigned key for the tax detail. readOnly: true example: '13' nullable: true id: type: string description: ID for the tax detail. readOnly: true example: AUS-TAX nullable: true href: type: string description: URL for the tax detail. readOnly: true example: /objects/tax/purchasing-tax-detail/13 glAccount: type: object readOnly: true properties: key: type: string description: Account key readOnly: true example: '23' id: type: string description: Account number readOnly: true example: '6330' name: type: string description: GL account title readOnly: true example: Compensation- Salary href: type: string description: GL account URL. readOnly: true example: /objects/general-ledger/account/23 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: department: type: object description: Department associated with the AP payment line item. readOnly: true properties: key: type: string description: System-assigned key for the department. readOnly: true example: '12' nullable: true id: type: string description: Identifier for the department. readOnly: true example: '12' nullable: true name: type: string description: Name of the department. readOnly: true example: Accounts nullable: true href: type: string description: URL for the department. readOnly: true example: /objects/company-config/department/12 location: type: object description: Location associated with the AP payment line item. readOnly: true properties: key: type: string description: System-assigned key for the location. readOnly: true example: '22' nullable: true id: type: string description: Identifier for the location. readOnly: true example: LOC-22 nullable: true name: type: string description: Name of the location. readOnly: true example: India nullable: true href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/22 apPayment: type: object description: Header level details for the AP payment's line entries. readOnly: true properties: key: type: string description: System-assigned key for the AP payment. readOnly: true example: '3220' id: type: string description: ID for the AP payment. readOnly: true example: '3220' href: type: string description: URL for the AP payment. readOnly: true example: /objects/accounts-payable/payment/3220 audit: $ref: '#/components/schemas/audit' accounts-payable-payment: type: object description: >- An AP payment is a transaction that records a payment against an AP bill or AP adjustment. properties: key: type: string description: System-assigned unique key for the AP payment. readOnly: true example: '23' id: type: string description: >- Identifier for the AP payment. This value is the same as `key` for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the AP payment. readOnly: true example: /objects/accounts-payable/payment/23 recordType: type: string description: | Record type: * `pp` - AP payment record * `po` - applied advance record readOnly: true example: pp financialAccount: type: object description: Financial entity from which the payment will be paid. nullable: false properties: entityId: type: string description: ID of the financial entity. example: Visdb entityType: type: string description: Type of the financial entity. readOnly: true example: cc name: type: string description: Name of the financial entity. readOnly: true example: VISA currency: type: string description: Currency of the financial entity. readOnly: true example: USD action: type: string description: > The action to take when the payment is created or updated. * `submit` - Submit or post the payment, depending on the approval workflow * `draft` - Move the payment to the outbox in the system enum: - draft - submit example: submit default: draft state: type: string description: Current state of the AP payment. readOnly: true enum: - partiallyApproved - submitted - voided - confirmed - approved - draft - declined - delivered - printVoided - deleted - quickDelivery example: Approved documentNumber: type: string description: >- Reference number for the payment, which can be the check number or the transaction number, depending on the payment method used. example: '3086' description: type: string description: Description of the payment (memo). example: From billing through August 31 documentId: type: string description: Document ID for the payment. example: Prim-Vendor-Invoice-VI#0008#doc txnDate: type: string format: date example: '2023-01-03' description: Date the payment was created. readOnly: true txnPaidDate: type: string format: date example: '2023-01-04' description: Date the payment transaction was paid. readOnly: true paymentDate: type: string format: date example: '2021-01-23' description: The date to make the payment. nullable: false baseCurrency: type: object description: Transaction totals in base currency. properties: currency: type: string description: The company's base currency. example: USD totalAmount: type: string description: Total amount. readOnly: true example: '10' totalSelected: type: string description: Total selected. readOnly: true example: '0' totalPaid: type: string description: Total paid. readOnly: true example: '10' totalDue: type: string description: Amount due. readOnly: true example: '0' txnCurrency: type: object description: Transaction totals in the currency in which it was paid. properties: currency: type: string description: The currency in which the payment was made. example: USD totalAmount: type: string description: Total transaction amount. readOnly: true example: '10' totalSelected: type: string description: Total transaction amount selected. readOnly: true example: '0' totalPaid: type: string description: Total transaction amount paid. readOnly: true example: '10' totalDue: type: string description: Transaction amount due. readOnly: true example: '0' cleared: type: string description: Reconciliation status. readOnly: true example: F clearedDate: type: string format: date example: '2021-01-23' description: Reconciliation date. readOnly: true nullable: true isInclusiveTax: type: boolean description: Indicates whether the transaction is tax inclusive. readOnly: true example: false default: false paymentSummary: type: object description: > [AP summary](/openapi/ap/accounts-payable-summary/tag/Summaries) that the payment is part of. Summaries are collections of transactions grouped together for processing. readOnly: true properties: key: type: string description: System-assigned key for the summary. readOnly: true example: '399' id: type: string description: Identifier for the summary. readOnly: true example: '399' name: type: string description: Name of the summary. readOnly: true example: Hidden AP Batch postingDate: type: string format: date description: GL posting date. readOnly: true example: '2022-07-21' href: type: string description: URL for the summary. readOnly: true example: /objects/accounts-payable/summary/399 exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. nullable: true rate: type: string description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: '1.0789' nullable: true typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: '1' nullable: true paymentProvider: type: object description: Payment provider who processed the payment. readOnly: true properties: key: type: string description: System-assigned key for the payment provider. readOnly: true example: '1' id: type: string description: Unique identifier for the payment provider. readOnly: true example: CSI href: type: string description: URL for the payment provider. readOnly: true example: /objects/cash-management/payment-provider/1 paymentMethod: type: string description: Payment method for the payment. nullable: false example: printedCheck enum: - printedCheck - creditCard - eft - cash - onlineChargeCard - onlineACHDebit - manualCheck - ach payToContact: description: >- Contact that the payment will be made to. Leave blank to use the `payTo` contact set for the vendor. type: object readOnly: true properties: payTo: type: object description: >- Contact that the payment will be made to. Leave blank to use the `payTo` contact set for the vendor. properties: href: type: string description: URL endpoint for the contact. readOnly: true example: /objects/company-config/contact/23 key: type: string description: System-assigned unique key of the contact. readOnly: true example: '6886' id: type: string description: Contact ID. readOnly: true example: ksmith name: type: string description: Contact name. readOnly: true example: Klay Vanderbilt readOnly: true taxSolution: type: object description: Tax solution used to calculate and capture taxes on the payment. readOnly: true properties: key: type: string description: System-assigned key of the tax solution. readOnly: true example: '5' nullable: true id: type: string description: ID of the tax solution. readOnly: true example: GST nullable: true taxCalculationMethod: type: string description: Tax calculation method used for the payment. readOnly: true example: simpleTax nullable: true href: type: string description: URL endpoint for the tax solution. readOnly: true example: /objects/tax/tax-solution/5 vendor: type: object description: Vendor to receive the payment. nullable: false properties: href: type: string description: URL endpoint for the vendor. readOnly: true example: /objects/accounts-payable/vendor/201 entity: type: string description: Vendor entity. readOnly: true example: V201 key: type: string description: System-assigned key of the vendor. example: '201' id: type: string description: ID of the vendor. example: V-00014 name: type: string description: Name of the vendor. readOnly: true example: PG & E details: type: array description: >- Array of details for the payment, including transaction payment amounts, line items, discounts, adjustments, and so forth. minItems: 1 items: $ref: '#/components/schemas/accounts-payable-payment-detail' lines: type: array description: Array of payment lines in the payment. items: $ref: '#/components/schemas/accounts-payable-payment-line' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true accounts-payable-payment-detailRequiredProperties: type: object required: - moduleKey - paymentDate - txnPaymentAmount accounts-payable-summaryRequiredProperties: type: object required: - id - name - glPostingDate - recordType - status accounts-payable-summary: type: object description: Payment batches of all payment processed in the system. properties: key: type: string description: System-assigned key for the AP Summary readOnly: true example: '1' id: type: string description: Unique identifier for the AP Summary readOnly: true example: '1' href: type: string description: Endpoint for the ap-summary readOnly: true example: /objects/accounts-payable/summary/1 name: type: string description: >- Name for the AP summary. The system uses this name to identify the summary throughout the Accounts Payable application. example: Bills for 2022/08/02 summaryCreationType: type: string description: >- If set to manual, then the summary was created by a user and if set to system, then the summary was created by Intacct based on the summary frequency. enum: - system - manual default: manual example: manual readOnly: true glPostingDate: type: string format: date description: The date summary items post to the general ledger example: '2022-08-02' recordType: type: string description: >- Options Bill, Adjustment, Manual payment. This determines the type of transaction that the summary contains $ref: '#/components/schemas/ap-record-type' example: apBill totalAmount: type: string description: Total Amount format: decimal-precision-2 example: '7000.22' readOnly: true state: type: string description: >- State of the summary, which can be `open` or `closed`. An open summary can have items added to it enum: - open - closed example: open parent: type: object description: Parent AP Summary Key properties: key: type: string description: Parent AP Summary Key example: '23' id: type: string description: Identifier for the parent example: '23' href: type: string description: URL for the AP Summary readOnly: true example: /objects/accounts-payable/summary/23 preventGLPosting: type: boolean description: Not for GL posting example: false default: false bankAccountId: type: object description: Bank account ID. properties: key: type: string description: System-assigned key for the GL account. example: BOA id: type: string description: Identifier for the GL account. example: BOA href: type: string description: URL for the bankaccount. readOnly: true example: /objects/cash-management/bank-account/23 isQuickPaymentSummary: type: boolean description: >- This field is set to true only for manual and quick payment summaries. It is set to false for transactions of type bill/adjustment. example: false default: false status: $ref: '#/components/schemas/status' accounts-payable-recurring-billRequiredProperties: type: object properties: vendor: type: object required: - id schedule: type: object required: - startDate - repeatInterval currency: type: object required: - txnCurrency term: type: object required: - id lines: type: array items: required: - txnAmount - glAccount accounts-payable-recurring-bill-line: type: object description: >- Line items in a recurring bill represent transactions captured in that recurring bill. properties: key: type: string description: System-assigned key for the line item. readOnly: true example: '23' id: type: string description: >- ID for the line item. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '23' href: type: string description: URL for the line item. readOnly: true example: /objects/accounts-payable/recurring-bill-line/23 memo: type: string description: >- Memo provides information about the line item that may be of use in the future. example: Service charges nullable: true baseAmount: type: string format: decimal-precision-2 description: >- For multi-currency companies, Sage Intacct calculates the base amount by applying the exchange rate from the header to the transaction amount. example: '100' lineNumber: type: string description: Line number of the line item. example: '1' hasForm1099: type: string description: > If the vendor is set up for 1099 tracking and enabled for 1009 flag override, you can set to `true` to enable individual line items for 1099 treatment. If `false`, this line item does not have associated 1099 form type and box values. example: 'false' form1099: type: object description: Form 1099 information for the line item. properties: type: type: string description: | Type of form 1099. example: NEC nullable: true box: type: string description: | Box value of form 1099. example: 15A nullable: true txnAmount: type: string format: decimal-precision-2 description: Amount for the line item in the transaction currency. example: '100' isBillable: type: boolean description: Indicates whether the line item is marked as billable. default: false example: true glAccount: type: object description: GL account the line item is assigned to. properties: key: type: string description: System-assigned key for the GL account. example: '220' id: type: string description: ID for the GL account. example: '200' name: type: string description: Name or title of the GL account. example: Entertainment href: type: string description: URL for the GL account. readOnly: true example: /objects/general-ledger/account/220 currency: type: object description: Currency details for the recurring bill line. properties: baseCurrency: type: string description: Base currency for the company. example: USD txnCurrency: type: string description: Transaction currency for the recurring bill. example: USD exchangeRate: type: object description: Exchange rate details used to calculate the base amount. title: exchangeRate properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: number 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: INR-Rate allocation: type: object description: >- Transaction allocation template for the line item, which distributes the bill amount across specified dimensions. properties: key: type: string description: System-assigned key for the allocation. example: '1' nullable: true id: type: string description: System-assigned ID for the allocation. example: '1' nullable: true name: type: string description: Identifier of the allocation. readOnly: true example: Alloc1-WBS-US nullable: true accountLabel: type: object description: Meaningful name of AP account. properties: key: type: string description: System-assigned key for the account label. example: '14' nullable: true id: type: string description: Meaningful name of the account. example: Accounting Fees nullable: true href: type: string readOnly: true example: /objects/accounts-payable/account-label/14 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: department: type: object description: Department to assign the expense to. properties: key: type: string description: System-assigned key for the department. example: '1' nullable: true id: type: string description: ID of the department. example: '1' nullable: true name: type: string description: Name of the department. example: Accounting nullable: true href: type: string description: URL of the department. readOnly: true example: /objects/company-config/department/1 location: type: object description: Location to assign the expense to. properties: key: type: string description: System-assigned key for the location. example: '1' nullable: true id: type: string description: ID of the location. example: '1' nullable: true name: type: string description: Name of the location. example: India nullable: true href: type: string description: URL of the location. readOnly: true example: /objects/company-config/location/1 overrideOffsetGLAccount: type: object description: >- An alternative AP account to override the default GL AP account for the bill. properties: key: type: string description: System-assigned key for the account. example: '384' id: type: string description: Offset account number. example: '1234.36' name: type: string description: Offset account name. readOnly: true example: AP ACCOUNT href: type: string readOnly: true example: /objects/general-ledger/account/384 recurringBill: type: object description: Header level details for the recurring bill's line entries. properties: id: type: string description: System-assigned ID for the recurring bill. readOnly: true example: '19876' key: type: string description: System-assigned key for the recurring bill. readOnly: true example: '19876' href: type: string description: Endpoint for the AP recurring bill. readOnly: true example: /objects/accounts-payable/recurring-bill/23 readOnly: true status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' accounts-payable-recurring-bill: type: object description: Header information for recurring bills. properties: key: type: string description: System-assigned key for the AP recurring bill. readOnly: true example: '23' id: type: string description: Bill sequence number. example: '1' nullable: true description: type: string description: Additional information about the recurring bill. example: Recurring Bill created on date 2021-01-23 nullable: true referenceNumber: type: string description: >- This is a number such as a purchase order or account number that might be useful in searches or reports. This number shows on the GL Details report and prints on the check and vendor Stubs. example: RecurBill-100 nullable: true moduleKey: type: string description: This field is used internally to identify the module. readOnly: true example: 3.AP contract: type: object description: Often, recurring bills are the result of an ongoing contract. properties: key: type: string description: System-assigned key for the contract. example: '2' nullable: true id: type: string description: Unique identifier for the contract. example: CON-2 nullable: true description: type: string description: Description of the contract. example: CON-2 nullable: true href: type: string description: URL for the contract. readOnly: true example: /objects/contracts/contract/2 totalEntered: type: string format: decimal-precision-2 description: Total amount of the AP Recurring bill. readonly: true example: '100' txnTotalEntered: type: string format: decimal-precision-2 description: Total transaction amount. example: '100' currency: type: object description: Currency details for this bill. properties: baseCurrency: type: string description: Base currency for your company. example: USD txnCurrency: type: string description: >- The transaction currency to use for this bill. If this currency is different from the base currency, provide an exchange rate. example: USD exchangeRate: type: object description: Exchange rate details used to calculate the base amount. title: exchangeRate properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. nullable: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. example: 1.0789 nullable: true typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: '1' nullable: true contacts: type: object description: Contacts for this AP adjustment. properties: payTo: type: object description: The vendor contact to be paid. title: payTo properties: key: type: string description: System-assigned key for the contact. example: '916' id: type: string description: Unique identifier for the contact. example: Power Aerospace Materials(C1) href: type: string description: URL for the contact. readOnly: true example: /objects/company-config/contact/1 returnTo: type: object description: The vendor contact for return of the purchase. title: returnTo properties: key: type: string description: System-assigned key for the contact. example: '916' id: type: string description: Unique identifier for the contact. example: Power Aerospace Materials(C1) href: type: string description: URL for the contact. readOnly: true example: /objects/company-config/contact/1 schedule: type: object description: The schedule sets the frequency for the recurring bill. properties: startDate: type: string format: date description: Start date of the Recurring bill scheduled execution. example: '2021-01-01' endDate: type: string format: date description: End date of the Recurring bill scheduled execution. example: '2022-01-01' nextExecutionDate: type: string format: date description: Next execution date for the Recurring bill. example: '2021-02-01' lastExecutionDate: type: string format: date description: Last execution date for the Recurring bill. example: '2021-12-01' recurringDueDate: type: string format: date description: Due date for the Recurring bill execution. example: '2021-06-01' frequency: type: string description: >- Frequency in which the bill will recur and it will interact with repeat interval. enum: - none - days - weeks - months - years - endOfMonth example: days executionCount: type: string description: Count of transactions created. example: '100' repeatCount: type: string description: Count of repeat transactions. example: '50' repeatBy: type: string description: Schedule repeat. enum: - none - days - weeks - months - years - endOfMonth default: days example: days repeatInterval: type: string description: Repeat interval of the scheduler in the recurring bill. default: '1' example: '1' recurringSchedule: type: object description: Recurring schedule used to automate the billing process. properties: key: type: string description: System-assigned key to uniquely identify the recurring schedule. readOnly: true example: '20' id: type: string description: Unique identifier for the schedule. readOnly: true example: '20' href: type: string description: URL for the recurring schedule. readOnly: true example: /objects/core/schedule/20 readOnly: true term: type: object description: >- Payment terms, which are used to calculate due date, discounts, and penalties associated with this bill. properties: key: type: string description: System-assigned key for the payment term. example: '3' nullable: true id: type: string description: Name or other unique identifier for the payment term. example: N15 nullable: true href: type: string description: URL for the payment term. readOnly: true example: /objects/accounts-payable/term/16 vendor: type: object description: Vendor associated with the AP recurring bill. properties: id: type: string description: Unique identifier for the vendor. example: Vendor_01 key: type: string description: System-assigned key for the vendor. example: '15' name: type: string description: name of the vendor. example: Logic Solutions vendorDue: type: string format: decimal-precision-2 description: Transaction vendor total due. readOnly: true example: '100' href: type: string description: URL for the vendor. readOnly: true example: /objects/accounts-payable/vendor/1 lines: type: array description: Line items of the Recurring bill. items: $ref: '#/components/schemas/accounts-payable-recurring-bill-line' audit: $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' accounts-payable-vendor-contactRequiredProperties: type: object properties: contact: required: - id vendor: required: - key required: - categoryName accounts-payable-vendor-email-templateRequiredProperties: type: object required: - vendor - emailTemplate vendorAccountGroupRequiredProperties: type: object required: - id accounts-payable-vendor-account-group: type: object description: Organize accounts into groups for reporting purposes. properties: key: type: string description: System-assigned key for the vendor account group. readOnly: true example: '1' id: type: string description: Name or other unique identifier for the vendor account group. example: Electronic VGL Group groupType: type: string description: Vendor account group type. enum: - null - vendor - customer example: vendor nullable: true default: null status: $ref: '#/components/schemas/status' href: type: string description: URL for the vendor account group. readOnly: true example: /objects/accounts-payable/vendor-account-group/1 accounts-payable-vendor-account-numberRequiredProperties: type: object required: - vendor - location - vendorAccountNumber accounts-receivable-invoiceRequiredProperties: type: object properties: customer: required: - id example: '1' lines: type: array items: type: object properties: glAccount: required: - id example: '4010' dimensions: properties: location: required: - id example: '1' required: - txnAmount example: '100' required: - invoiceDate - dueDate accounts-receivable-invoice-line: type: object description: >- Line items in an AR invoice represent transactions captured in that invoice. properties: key: type: string description: System-assigned key for the AR invoice line item. readOnly: true example: '103' id: type: string description: Identifier for the AR invoice line item. readOnly: true example: '103' glAccount: type: object description: General Ledger (GL) account associated with the line item. properties: key: type: string description: System-assigned key for the GL account. example: '163' id: type: string description: User-assigned number for the GL account. example: '4010' name: type: string description: Name of the GL account. readOnly: true example: Sales Revenue Licensing href: type: string readOnly: true example: /objects/general-ledger/account/163 overrideOffsetGLAccount: type: object description: >- An alternative AR account to override the default GL AR account for the invoice line item. properties: key: type: string description: System-assigned key for the GL account. example: '263' id: type: string description: GL account number. example: '1103' name: type: string description: GL account name. readOnly: true example: Accounts Receivable - Microcomputer href: type: string description: URL for the GL account. readOnly: true example: /objects/general-ledger/account/263 baseAmount: type: string format: decimal-precision-2 description: >- For multi-currency companies, Sage Intacct calculates the base amount by applying the exchange rate from the header to the transaction amount. readOnly: true example: '24115.65' txnAmount: type: string description: Amount for the AR invoice line item in the transaction currency. format: decimal-precision-2 example: '16740.00' memo: type: string description: Memo or notes about the AR invoice line item. example: Replaces discontinued part currency: type: object description: Currency details for multi-currency companies. readOnly: true properties: baseCurrency: type: string description: Base currency for the invoice line item. readOnly: true example: USD txnCurrency: type: string description: Transaction currency for the invoice line item. readOnly: true example: EUR exchangeRate: type: object title: exchangeRate description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' paymentInformation: type: object description: Payment information for the line item. readOnly: true properties: totalBaseAmountPaid: type: string format: decimal-precision-2 description: Total base amount that was paid. readOnly: true example: '100.00' totalTxnAmountPaid: type: string format: decimal-precision-2 description: Total transaction amount that was paid. readOnly: true example: '100.00' totalBaseAmountSelectedForPayment: type: string format: decimal-precision-2 description: Total base amount selected for the payment. readOnly: true example: '100.00' totalTxnAmountSelectedForPayment: type: string format: decimal-precision-2 description: Total transaction amount selected for the payment. readOnly: true example: '100.00' allocation: type: object description: >- Transaction allocation template for the line item, which distributes the invoice amount across specified dimensions. properties: key: type: string description: System-assigned key for the allocation. example: '22' nullable: true id: type: string description: System-assigned ID for the allocation. example: Premium Allocation nullable: true lineNumber: type: number description: Line number readOnly: true example: 1 isSubtotal: type: string description: | Indicates if the line item is a subtotal, tax item, or neither. enum: - null - subtotal - tax readOnly: true example: subtotal nullable: true default: null baseLocation: type: object readOnly: true allOf: - $ref: '#/components/schemas/location-ref' - type: object properties: key: type: string description: Base location key. example: '4' createdDate: type: string format: date example: '2021-01-23' description: Entry date for the line item. readOnly: true accountLabel: type: object description: Meaningful name of AR account. properties: key: type: string description: System-assigned key for the account label. example: '14' id: type: string description: Meaningful name of the account. example: Accounts Receivable - Microcomputer name: type: string description: Name of the account label. readOnly: true example: Sales Midwest href: type: string description: URL for the account label. readOnly: true example: /objects/accounts-receivable/account-label/14 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of locations to reflect how your company is organized. title: location properties: key: type: string description: System-assigned key for the location. example: '4' id: type: string description: Unique identifier of the location. example: AU name: type: string description: Name of the location. readOnly: true example: Australia href: type: string readOnly: true example: /objects/company-config/location/4 department: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string description: System-assigned key for the department. example: '9' id: type: string description: Unique identifier of the department. example: '01' name: type: string description: Name of the department. readOnly: true example: Sales href: type: string readOnly: true example: /objects/company-config/department/9 invoice: description: Header level details for the AR invoice's line items. type: object readOnly: true properties: id: type: string description: Identifier for the AR invoice. readOnly: true example: '6' key: type: string description: System-assigned key for the AR invoice. readOnly: true example: '6' href: type: string description: URL for the AR invoice. readOnly: true example: /objects/accounts-receivable/invoice/6 audit: $ref: '#/components/schemas/audit' entity-ref: type: object properties: key: type: string description: System-assigned key for the objects Entity Location. readOnly: true nullable: true example: '46' id: type: string description: User-assigned ID for the objects Entity Location readOnly: true nullable: true example: CORP name: type: string description: User-assigned NAME for the objects Entity Location readOnly: true nullable: true example: Corp href: type: string readOnly: true example: /objects/company-config/entity/46 readOnly: true accounts-receivable-invoice: type: object description: >- An AR invoice object represents an invoice sent to a customer for goods or services provided. properties: key: type: string description: System-assigned key for the AR invoice. readOnly: true example: '11' id: type: string description: Unique identifier for the AR invoice. readOnly: true example: '11' recordType: type: string description: The record type for the invoice. readOnly: true example: ri moduleKey: type: string description: Key of the module from which the invoice was created. enum: - accountsReceivable - orderEntry example: accountsReceivable readOnly: true invoiceNumber: type: string description: >- Specify a unique invoice number while creating an invoice unless document sequencing is configured, in which case the number is auto-generated. example: INV-001 state: type: string description: > A invoices's state shows the current status of the invoice within the workflow. enum: - reversed - reversal - draft - noValue - posted - paid - partiallyPaid - selected example: posted readOnly: true dueInDays: type: integer description: Number of days until the invoice is due. readOnly: true example: 108 referenceNumber: type: string description: Customer purchase order number or another reference number. example: PO6917 description: type: string description: >- Description of the invoice, which prints on the Customer Ledger report. example: Regular invoice documentId: type: string description: ID of the associated document. example: Sales Invoice-SI-00188 discountCutOffDate: type: string format: date example: '2022-12-13' description: Date of the discount. readOnly: true invoiceDate: type: string format: date description: Date the invoice was created. example: '2022-12-06' dueDate: type: string format: date example: '2022-12-31' description: Date the invoice is due. currency: type: object description: Currency details for this invoice. properties: baseCurrency: type: string description: Base currency for the invoice. example: USD txnCurrency: type: string description: >- The transaction currency to use for this invoice. If this currency is different from the base currency, provide an exchange rate. example: USD exchangeRate: type: object description: Exchange rate details used to calculate the base amount. title: exchangeRate properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: number 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: Intacct Daily Rate totalBaseAmount: type: string format: decimal-precision-2 description: >- For multi-currency companies, total entered in the base currency of the company. readOnly: true example: '700000' totalBaseAmountDue: type: string format: decimal-precision-2 description: >- For multi-currency companies, total due in the base currency of the company. readOnly: true example: '700000' totalTxnAmount: type: string format: decimal-precision-2 description: Total transaction amount in the currency of the invoice. readOnly: true example: '700000' totalTxnAmountDue: type: string format: decimal-precision-2 description: Total transaction amount due in the currency of the invoice. readOnly: true example: '700000' dunningCount: type: integer description: Number of associated dunning notices. readOnly: true example: 1 customerMessageId: type: string example: Greeting01 customerMessage: type: string description: Information to communicate to the customer via the invoice. readOnly: true example: Thank you for your business. recurringSchedule: type: object description: Recurring schedule used to automate the billing process. readOnly: true properties: key: type: string description: System-assigned key to uniquely identify the recurring schedule. readOnly: true example: '20' paymentInformation: type: object description: Payment information for the invoice. readOnly: true properties: fullyPaidDate: type: string format: date example: '2021-01-23' description: Date the invoice was paid. readOnly: true nullable: true totalBaseAmountPaid: type: string format: decimal-precision-2 description: Total paid in the company's base currency. readOnly: true example: '500' totalBaseAmountSelectedForPayment: type: string format: decimal-precision-2 description: Total selected for payment in the company's base currency. readOnly: true example: '500' totalTxnAmountSelectedForPayment: type: string format: decimal-precision-2 description: Total amount selected for payment in the invoice currency. readOnly: true example: '500' totalTxnAmountPaid: type: string format: decimal-precision-2 description: Total amount paid in the invoice currency. readOnly: true example: '500' contacts: type: object description: Associated contacts properties: payTo: type: object description: Pay to contact information from the customer record. title: payTo properties: key: type: string description: System-assigned key to uniquely identify the contact. example: '176' id: type: string description: Name of the contact. example: Power Aerospace Materials(C1) returnTo: type: object title: returnTo description: Return to contact information from the customer record. properties: key: type: string description: System-assigned key to uniquely identify the contact. example: '176' id: type: string description: Name of the contact example: Power Aerospace Materials(C1) isSystemGeneratedDocument: type: boolean readOnly: true description: > If `true`, this invoice record is created by the system internally and not created based on user input. example: true default: false billbackTemplate: type: object description: >- If AR is configured for inter-entity bill back, the template to use to create a matching bill. properties: key: type: string description: System-assigned key for the template. example: '18' id: type: string description: ID for the template. example: BBT-error5 href: type: string description: URL for the template. readOnly: true example: /objects/accounts-receivable/billback-template/18 attachment: type: object description: Supporting document attached to the invoice. properties: key: type: string description: System-assigned key for the supporting document. example: '11' id: type: string description: System-assigned ID for the supporting document. example: '11' href: type: string description: URL for the attachment. readOnly: true example: /objects/company-config/attachment/11 customer: type: object description: Customer to receive the invoice. properties: key: type: string description: System-assigned key for the customer. example: '14' id: type: string description: Unique identifier of the customer. example: C-00019 name: type: string description: Name of the customer. readOnly: true example: Haversham Textiles Corp emailOption: type: boolean description: Indicates whether email is a delivery option for the customer. readOnly: true default: false example: false customerDue: type: string format: decimal-precision-2 description: Amount due from the customer. readOnly: true example: '124041.29' deliveryOptions: type: string description: Invoice delivery options for the customer. enum: - print - email - both default: print example: both href: type: string description: URL for the customer. readOnly: true example: /objects/accounts-receivable/customer/14 term: type: object description: Term details for the invoice. properties: key: type: string description: System-assigned key for the term. example: '16' id: type: string description: Name of the term. example: 30 Days href: type: string description: URL for the term. readOnly: true example: /objects/accounts-receivable/term/16 invoiceSummary: type: object description: >- Summary details for this invoice. Summaries are collections of the same types of transactions grouped together for processing. properties: key: type: string description: System-assigned key to uniquely identify the summary. example: '33' id: type: string description: System-assigned ID for the summary. example: '33' glPostingDate: type: string description: GL posting date for the summary. format: date readOnly: true example: '2023-02-06' title: type: string description: Name of the summary. readOnly: true example: 'OE Sales Invoice: 2023 Batch 1' isSummaryOpen: type: string description: >- A summary can be `open` or `closed`. Items, such as invoices, can be added to open summaries. enum: - open - closed example: open readOnly: true isSummaryPosted: type: string description: If `true`, the summary has been posted to the General Ledger. readOnly: true example: 'false' lines: type: array description: Line items of the invoice. items: $ref: '#/components/schemas/accounts-receivable-invoice-line' entity: $ref: '#/components/schemas/entity-ref' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true accounts-receivable-account-labelRequiredProperties: type: object required: - id accounts-receivable-account-label: type: object description: AR account labels provide more descriptive names for accounts. properties: key: type: string description: System-assigned key for the AR account label. readOnly: true example: '8' id: type: string description: >- Name or other unique identifier for the account label. This unique identifier cannot be modified. example: Software description: type: string description: A note about the purpose and use of the account label. example: Software sales href: type: string description: URL for the AR account label. readOnly: true example: /objects/accounts-receivable/account-label/8 status: $ref: '#/components/schemas/status' description: Status of the account label. default: active glAccount: type: object description: General ledger account this AR account label is assigned to. properties: id: type: string description: General ledger account number. example: '1501' key: type: string description: System-assigned key for the general ledger account. example: '356' href: type: string readOnly: true example: /objects/general-ledger/account/356 offsetGLAccount: type: object description: >- The general ledger account where the system posts offsets to this label. properties: id: type: string description: Account number for the offset general ledger account. example: '9999' key: type: string description: System-assigned key for the offset general ledger account. example: '406' href: type: string readOnly: true example: /objects/general-ledger/account/406 accounts-receivable-termRequiredProperties: type: object required: - id accounts-receivable-term: type: object description: >- Accounts Receivable (AR) terms are the rules a company establishes for extending credit to customers. properties: key: type: string description: System-assigned key for the AR term. readOnly: true id: type: string description: Name or other unique identifier for the AR term. status: $ref: '#/components/schemas/status' description: type: string description: Note about the purpose and use of the AR term. value: type: string description: Value readOnly: true audit: $ref: '#/components/schemas/audit' due: type: object description: >- The due date is a combination of a number of days and a reference point. For example, to set terms that reference the number of days from the invoice date, set the number of days in `day`, and set `fromBillbillDate` in `from`. properties: days: type: integer description: Number of days until the term is due. from: type: string description: >- The reference point from which to begin counting the number of days until the term is due. enum: - null - fromInvoiceDate - ofTheMonthOfInvoiceDate - ofNextMonthFromInvoiceDate - of2ndMonthFromInvoiceDate - of3rdMonthFromInvoiceDate - of4thMonthFromInvoiceDate - of5thMonthFromInvoiceDate - of6thMonthFromInvoiceDate - afterEndOfMonthOfInvoiceDate - fromInvoiceDateExtendingToEom nullable: true default: null discount: type: object description: >- A discount is a combination of a number of days, a reference point, and the amount of the discount. properties: days: type: integer description: Number of days until the discount goes into effect. amount: type: integer description: Amount of the discount. from: type: string description: >- The reference point from which to begin counting the number of days until the discount goes into effect. enum: - null - fromInvoiceDate - ofTheMonthOfInvoiceDate - ofNextMonthFromInvoiceDate - of2ndMonthFromInvoiceDate - of3rdMonthFromInvoiceDate - of4thMonthFromInvoiceDate - of5thMonthFromInvoiceDate - of6thMonthFromInvoiceDate - afterEndOfMonthOfInvoiceDate - fromInvoiceDateExtendingToEom nullable: true default: null unit: type: string enum: - null - amount - percentage description: >- The type of discount, which can be a dollar amount or a percentage. nullable: true default: null graceDays: type: integer description: Number of days before the discount is withdrawn. calculateOn: type: string enum: - lineItemsTotal - invoiceTotal description: >- How the system calculates discounts in transactions that use this term. The calculation can be based on the line item total, excluding added charges (such as shipping and taxes), or on the invoice total, including all charges. default: invoiceTotal penalty: type: object description: Penalty for paying after the due date. properties: cycle: type: string enum: - noPenalty - daily - weekly - biweekly - monthly - bimonthly - quarterly - halfYearly - annually description: Time span in which the penalty accrues. default: noPenalty amount: type: integer description: Amount of the penalty. unit: type: string enum: - null - amount - percentage description: >- The type of penalty, which can be a dollar amount or a percentage. nullable: true default: null graceDays: type: integer description: >- The number of days after the due date that the penalty takes effect. accounts-receivable-customerRequiredProperties: type: object required: - name accounts-receivable-customer-contact: type: object description: A customer-contact is a contact record on a customer's `contactList`. properties: key: type: string description: System-assigned key for the customer contact information. readOnly: true example: '1' id: type: string description: >- Unique identifier for the customer contact information. This value is the same as `key` for this object. readOnly: true example: '1' categoryName: type: string description: User-defined category for grouping and sorting contacts. example: Billing contact href: type: string readOnly: true example: /objects/accounts-receivable/customer-contact/1 contact: type: object description: Contact to associate with the customer. properties: key: type: string description: System-assigned key for the contact. example: '197' id: type: string description: Unique identifier for the contact example: Jeffrey Palms href: type: string readOnly: true example: /objects/company-config/contact/197 audit: $ref: '#/components/schemas/audit' customer: type: object description: Customer that has the contactList where this contact appears. properties: key: type: string description: System-assigned key for the customer. example: '15' id: type: string description: ID for the customer. example: '15' href: type: string readOnly: true example: /objects/accounts-receivable/customer/15 accounts-receivable-customer-email-template: type: object description: >- Customer email templates can be used to automate standard messages sent to multiple customers. properties: key: type: string description: System-assigned unique key for the customer email template. readOnly: true example: '1' id: type: string description: >- Identifier for the customer email template. This value is the same as `key` for this object. readOnly: true example: '1' href: type: string description: URL endpoint for the customer email template. readOnly: true example: /objects/accounts-receivable/customer-email-template/1 customer: type: object description: > [Customer](/openapi/ar/accounts-receivable-customer/tag/Customers) associated with the email template. properties: key: type: string description: System-assigned key for the customer. example: '127' id: type: string description: Unique identifier for the customer. example: '014' href: type: string description: URL endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/127 txnDefinition: type: object description: >- Transaction definition, which is the template that contains accounting settings, workflow rules, and other configuration settings for a transaction. properties: href: type: string description: URL for the order-entry-txn-definition. readOnly: true example: /objects/order-entry/txn-definition/23 key: type: string description: Document template Key. example: '23' readOnly: true id: type: string description: Document template ID. example: Customer Invoice templateType: type: string description: Specify the type of transaction that will use the email template. enum: - arInvoice - arStatement - contract - soDocument - poDocument example: arInvoice default: arInvoice readOnly: true emailTemplate: type: object description: Associated email template. properties: key: type: string description: System-assigned key for the email template. example: '1' id: type: string description: Unique identifier for the email template. example: '1' name: type: string description: Name of the email template. readOnly: true example: Customer Trial href: type: string description: URL of the email template. readOnly: true example: /objects/company-config/email-template/1 accounts-receivable-customer: type: object description: A customer is any company to which you sell goods and services. properties: key: type: string description: System-assigned key for the customer. readOnly: true example: '24' id: type: string description: Unique identifier for the customer. example: C-00003 name: description: Name of the customer, which is usually the company name. type: string example: Gomez Manufacturers href: type: string description: URL for the customer. readOnly: true example: /objects/accounts-receivable/customer/24 status: $ref: '#/components/schemas/dimension-status' customerType: type: object description: >- The category assigned to the customer (for example, Consultants, Subcontractors, or Equipment). properties: key: type: string description: System-assigned key for the customer type. example: '1' id: type: string description: ID for the customer type. example: Customer - Direct href: type: string description: URL for the customer type. readOnly: true example: /objects/accounts-receivable/customer-type/1 parent: type: object description: Parent customer, which creates a customer hierarchy. properties: key: type: string description: System-assigned key for the parent customer. example: '10' id: type: string description: ID of the parent customer. example: C-00014 name: type: string description: Name of the parent customer. readOnly: true example: Pan American Global Partners href: type: string description: URL for the parent customer. readOnly: true example: /objects/accounts-receivable/customer/10 salesRepresentative: type: object description: Name of the employee responsible for this customer account. properties: key: type: string description: System-assigned key for the employee. example: '39' id: type: string description: ID of the employee. example: awong name: type: string description: Name of the employee. readOnly: true example: Anna Wong href: type: string description: URL for the employee. readOnly: true example: /objects/company-config/employee/39 taxId: type: string description: Tax identification number for the customer. example: 12-3434900 defaultRevenueGLAccount: type: object description: GL account for customer revenue. properties: key: type: string description: System-assigned key for the GL account. example: '41' id: type: string description: ID of the GL account. example: '1001' name: type: string description: Name of the GL account. readOnly: true example: Sterling Bank Operating href: type: string description: URL of the GL account. readOnly: true example: /objects/general-ledger/account/41 shippingMethod: type: object description: How goods are shipped to the customer. properties: key: type: string description: System-assigned key for the shipping method. example: '3' id: type: string description: ID of the shipping method. example: Fedex href: type: string description: URL of the shipping method. readOnly: true example: /objects/accounts-receivable/shipping-method/3 creditLimit: type: number description: Credit limit extended to the customer. example: 10000 isOnHold: type: boolean description: Indicates whether customer is on credit hold. default: false example: true contacts: type: object description: Contacts for the customer. properties: default: type: object description: > Display contact for this customer. Used as the default for other customer contacts, such as `shipTo`, that are not defined. allOf: - $ref: '#/components/schemas/contact-ref' - type: object properties: hideContactList: type: boolean description: Set to `true` to exclude from the company contact list. default: false example: true tax: type: object title: tax properties: isTaxable: type: boolean description: Indicates whether the contact is taxable. default: false example: true group: type: object description: Tax group the contact belongs to. properties: key: type: string description: System-assigned key for the tax group. example: '90' id: type: string description: Identifier for the tax group. example: Los Angeles href: type: string description: URL for the tax group. readOnly: true example: /objects/tax/contact-tax-group/90 primary: type: object description: Primary contact for the customer. title: primary properties: key: type: string description: System-assigned key for the contact. example: '87' id: type: string description: ID of the contact. example: Ben Jones href: type: string description: URL for the contact. readOnly: true example: /objects/company-config/contact/87 billTo: type: object description: >- Customer contact for company activity such as sales transactions, invoice creation, and manual deposits. title: billTo properties: key: type: string description: System-assigned key for the contact. example: '63' id: type: string description: ID of the contact. example: Rose Garcia href: type: string description: URL for the contact. readOnly: true example: /objects/company-config/contact/63 shipTo: type: object title: shipTo description: >- Customer contact for company activity such as sales transactions, invoice creation, and tax calculations. properties: key: type: string description: System-assigned key for the contact. example: '29' id: type: string description: ID of the contact. example: Veronica Clark href: type: string description: URL for the contact. readOnly: true example: /objects/company-config/contact/29 contactList: type: array description: List of contacts for the customer. items: $ref: '#/components/schemas/accounts-receivable-customer-contact' restrictions: type: object properties: restrictionType: type: string description: > Restrict customers to only the top-level company or for specific locations and departments. These restriction options are valid only for multi-entity companies that are [configured for restrictions](https://www.intacct.com/ia/docs/en_US/help_action/Multi-entity/Setup/configure-multi-entity.htm). Learn more about [restricting customers](https://www.intacct.com/ia/docs/en_US/help_action/Accounts_Receivable/Setup/Customers/setup-customers-in-ME.htm). The following values specify who can view and post transactions against this customer. **Valid values:** - `unrestricted` - The top level and all entities within the multi-entity structure. - `rootOnly` - Only the top level of the multi-entity structure. - `restricted` - Only the chosen locations, location groups, departments, or department groups within the multi-entity structure. enum: - null - unrestricted - rootOnly - restricted example: restricted nullable: true default: null locations: type: array description: Locations to which the customer can be restricted. example: - Dallas - Santa Fe - Las Vegas items: type: string departments: type: array description: Departments to which the customer can be restricted. example: - Sales - RDA - BD items: type: string audit: $ref: '#/components/schemas/audit' customerEmailTemplates: type: array description: Email templates for the customer. items: $ref: '#/components/schemas/accounts-receivable-customer-email-template' discountPercent: type: string description: Discount percentage for the customer. example: '10' term: type: object description: >- AR term for the customer, which are the rules for extending credit to the customer. properties: key: type: string description: System-assigned key for the term. example: '20' id: type: string description: Name of the term. example: Net 15 href: type: string description: URL for the term. readOnly: true example: /objects/accounts-receivable/term/20 advanceBillBy: type: string description: >- Bill in advance setting, which instructs Sage Intacct to create billing schedules that automatically start before a contract line starts. example: '7' advanceBillByType: type: string description: >- Bill in advance type to indicate whether the advance value is number of days or months. enum: - '' - days - months example: days totalDue: type: string description: Total amount currently due from the customer. readOnly: true example: '3250.00' lastInvoiceCreatedDate: type: string format: date description: Date the most recent invoice was created. readOnly: true example: '2023-05-15' lastStatementGeneratedDate: type: string format: date description: Date the most recent statement was generated. readOnly: true example: '2023-01-01' resaleNumber: type: number description: >- Resale number, which applies to customers who are resellers of your company's products or services. example: 1534 deliveryOptions: type: string description: Delivery option for the customer's statements. enum: - print - email - both example: both overridePriceList: type: string description: >- By default, the customer price list is assigned to the entire customer, including the customer contacts. But, you can override the customer price list with the corresponding options for either the billing or shipping contact. enum: - Customer - Billing contact - Shipping contact default: Customer example: Billing contact customerMessageId: type: string description: ID of the default message to print on the customer's invoices. example: StndMsg1 currency: type: string description: Currency for the customer. example: CAD emailOptIn: type: boolean description: Indicates whether the customer accepts emailed invoices. default: false example: true activationDate: type: string format: date description: Monthly recurring revenue activation date. readOnly: true example: '2022-04-03' subscriptionEndDate: type: string format: date description: Monthly recurring revenue end date. readOnly: true example: '2023-03-31' territory: type: object description: The sales territory to which the customer is assigned. properties: key: type: string description: Territory key. example: '6' id: type: string description: Territory ID. example: NE name: type: string description: Territory name. example: Northeast enableOnlineACHPayment: type: boolean description: Set to `true` to enable automation of customer payments using ACH. default: true example: true enableOnlineCardPayment: type: boolean description: Set to `true` to automate customer payments using a credit card. default: true example: true isOneTimeUse: type: boolean description: >- Set to `true` to designate the customer as a one-time use customer that should not be included in standard look-up lists. default: false example: false accountGroup: type: object description: >- Customer GL group to control the GL account that transactions with the customer should post to. properties: key: type: string description: System-assigned key for the customer GL group. example: '41' id: type: string description: ID for the customer GL group. example: Direct href: type: string description: URL for the customer GL group. readOnly: true example: /objects/accounts-receivable/customer-account-group/41 accountLabel: type: object description: Label for the AR account associated with the customer. properties: key: type: string description: System-assigned key for the AR account label. example: '38' id: type: string description: ID for the account label. example: SW Sales href: type: string description: URL for the account label. readOnly: true example: /objects/accounts-receivable/account-label/38 attachment: type: object description: Attachment that serves as a supporting document for the customer. properties: key: type: string description: System-assigned key for the attachment. example: '51' id: type: string description: ID for the attachment. example: '123' href: type: string description: URL for the attachment. readOnly: true example: /objects/company-config/attachment/51 retainagePercentage: type: number description: >- Default retainage percentage for the customer. Retainage must be enabled for a customer and a Construction subscription is required to enable this capability. example: 25 notes: type: string description: Notes or comments about the customer. example: Service tier 1 priceList: type: object description: Price list associated with the customer. properties: key: type: string description: System-assigned key for the price list. example: '7' id: type: string description: ID for the price list. example: Base Price List href: type: string description: URL for the price list. readOnly: true example: /objects/order-entry/price-list/7 priceSchedule: type: object description: Price schedule associated with the customer. properties: key: type: string description: System-assigned key for the price schedule. example: '4' id: type: string description: ID for the price schedule. example: PREF href: type: string description: URL for the price schedule. readOnly: true example: /objects/purchasing/price-schedule/4 overrideOffsetGLAccount: type: object description: Default AR override offset account for this customer. properties: key: type: string description: System-assigned key for the GL account. example: '12' id: type: string description: ID for the GL account. example: '134' name: type: string description: Name of the GL account. readOnly: true example: 1225 - Sales href: type: string description: URL for the GL account. readOnly: true example: /objects/general-ledger/account/12 accounts-receivable-customer-typeRequiredProperties: type: object required: - id accounts-receivable-customer-type: type: object description: >- Customer types provide a way to group customers into categories, such as reseller and end user. properties: key: type: string description: System-assigned key for the customer type. readOnly: true example: '16' id: type: string description: Name of the customer type. example: Top Level Customer href: type: string description: URL for the customer type. readOnly: true example: /objects/accounts-receivable/customer-type/16 status: $ref: '#/components/schemas/status' parent: type: object description: Parent of a subordinate customer type. properties: key: type: string description: System-assigned key for the parent customer type. example: '5' id: type: string description: Identifier for the parent customer type. example: Level 1 Customer href: type: string description: URL for the parent customer type. readOnly: true example: /objects/accounts-receivable/customer-type/5 audit: $ref: '#/components/schemas/audit' accounts-receivable-customer-email-templateRequiredProperties: type: object properties: customer: required: - key example: '127' emailTemplate: required: - key example: '1' accounts-receivable-adjustmentRequiredProperties: type: object required: - createdDate properties: customer: required: - id example: '1' txnCurrency: required: - currency example: USD lines: type: array items: type: object properties: glAccount: required: - id example: '2995' txnCurrency: required: - amount example: '100' dimensions: properties: location: required: - id example: '1' accounts-receivable-adjustment-line: type: object description: >- Line items in an AR adjustment represent debits or credits to modify the amount owed by a customer. properties: id: type: string description: ID for the AR adjustment line item. readOnly: true example: '125' key: type: string description: System-assigned key for the AR adjustment line item. readOnly: true example: '125' memo: type: string description: Memo to describe the line item. example: 50 USD credit lineNumber: type: string description: Number of the line item. readOnly: true example: '125' baseCurrency: type: object description: Base currency for the line item. readOnly: true properties: currency: type: string description: Base currency readOnly: true example: USD amount: type: string description: Base amount readOnly: true example: '120.20' txnCurrency: type: object description: Transaction currency for the line item. properties: currency: type: string description: Transaction currency example: INR amount: type: string description: Transaction amount example: '145' exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: string 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' adjustmentType: type: string description: Record type readOnly: true example: ra isTax: type: boolean description: Indicates whether the line item amount includes taxes. default: false readOnly: true example: false accountLabel: type: object description: Label for the AR account. properties: key: type: string description: System-assigned key for the AR account label. example: '1' id: type: string description: ID for the AR account label. example: '1' href: type: string description: Endpoint for the AR account label. readOnly: true example: /objects/accounts-receivable/account-label/9 arAdjustment: type: object description: Header level details for the AR adjustment's line entries. properties: key: type: string description: System-assigned key for the AR adjustment. example: '10' id: type: string description: ID of the AR adjustment. example: '10' href: type: string description: Endpoint for the AR adjustment. readOnly: true example: /objects/accounts-receivable/adjustment/1 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: department: type: object description: Department to assign the expense amount to. properties: key: type: string description: System-assigned key for the department. example: '1' id: type: string description: ID of the department. example: '1' name: type: string description: Name of the department. example: Accounting href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/1 location: type: object description: Location to assign the expense amount to. properties: key: type: string description: System-assigned key for the location. example: '1' id: type: string description: ID of the location. example: '1' name: type: string description: Name of the location. example: India href: type: string description: Endpoint of the location. readOnly: true example: /objects/company-config/location/1 glAccount: $ref: '#/components/schemas/gl-account-ref' audit: $ref: '#/components/schemas/audit' accounts-receivable-adjustment: type: object description: >- An AR adjustment is a transaction that applies a credit or debit in order to modify the amount owed by a customer. properties: key: type: string description: System-assigned key for the AR adjustment. readOnly: true example: '15' id: type: string description: >- ID for the AR adjustment. This value is the same as key for this object. readOnly: true example: '15' txnType: type: string description: >- Record type to identify the type of transaction. An AR adjustment has a record type of `ra`. readOnly: true example: ra adjustmentNumber: type: string description: Number that can be used to track the AR adjustment. example: ADJ001 href: type: string description: URL endpoint for the AR adjustment. readOnly: true example: /objects/accounts-receivable/adjustment/15 contacts: type: object description: Associated contacts for the AR adjustment. properties: billTo: type: object description: Customer contact to invoice for this sale. title: billTo properties: key: type: string description: System-assigned key for the contact. example: '916' id: type: string description: Name of the contact. example: Power Aerospace Materials (C1) href: type: string description: URL endpoint for the contact. readOnly: true example: /objects/company-config/contact/916 shipTo: type: object description: Customer contact for shipping. title: shipTo properties: key: type: string description: System-assigned key for the contact. example: '312' id: type: string description: Name of the ship-to contact. example: Power Aerospace Materials(C1) href: type: string description: URL endpoint for the contact. readOnly: true example: /objects/company-config/contact/312 state: type: string description: Processing state of the AR adjustment. readOnly: true enum: - reversed - reversal - draft - noValue - posted - paid - partiallyPaid - selected example: paid description: type: string description: Description of the AR adjustment. example: >- Computer Hardware & Software Expenses 03/01/20 - 08/31/21 Subscription charges. documentNumber: type: string description: Invoice number selected as a reference for the adjustment. example: INV-1602 baseCurrency: type: object description: For multi-currency companies, the base currency for the adjustment. properties: currency: type: string description: Base currency example: USD totalPaid: type: string format: decimal-precision-2 description: Total paid amount. readOnly: true example: '1117.8' totalSelected: type: string format: decimal-precision-2 description: Total selected amount. readOnly: true example: '100.10' totalDue: type: string format: decimal-precision-2 description: Total amount due. example: '251464.01' totalAmountEntered: type: string format: decimal-precision-2 description: Total entered readOnly: true example: '100.20' paidDate: type: string format: date description: Payment date example: '2022-11-01' txnCurrency: type: object description: >- For multi-currency companies, the transaction currency for the adjustment. properties: currency: type: string description: Transaction currency example: INR totalEntered: type: string format: decimal-precision-2 description: Total transaction amount entered. readOnly: true example: '1000.20' totalSelected: type: string format: decimal-precision-2 description: Total transaction amount selected. readOnly: true example: '1000.05' totalPaid: type: string format: decimal-precision-2 description: Total transaction amount paid. readOnly: true example: '2000.50' totalDue: type: string format: decimal-precision-2 description: Total transaction amount due. readOnly: true example: '100.50' exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: string 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' moduleKey: type: string description: Key for the source module from which the transaction was created. readOnly: true example: 3.AR customer: type: object description: The customer who is the target of the AR adjustment. properties: key: type: string description: System-assigned key for the customer. example: '16' id: type: string description: ID of the customer. example: Customer_01 name: type: string description: Name of the customer. example: Logic Solutions totalDue: type: string format: decimal-precision-2 description: Transaction total due for the customer. readOnly: true example: '1125.10' href: type: string description: URL endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/16 createdDate: type: string format: date example: '2021-01-23' description: Date the adjustment was created. glPostingDate: type: string format: date description: GL posting date. example: '2023-03-24' attachment: type: object description: Supporting document for the adjustment. properties: key: type: string description: System-assigned key for the supporting document. example: '1' id: type: string description: ID for the supporting document. example: Sales01 href: type: string description: URL endpoint for the attachment. readOnly: true example: /objects/company-config/attachment/1 lines: type: array description: Line items of the AR adjustment. items: $ref: '#/components/schemas/accounts-receivable-adjustment-line' 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 accounts-receivable-advanceRequiredProperties: type: object required: - paymentMethod - paymentDate - receiptDate - financialEntity properties: customer: required: - id example: '1' items: type: array items: type: object properties: glAccount: required: - id example: '4010' dimensions: properties: location: required: - id example: '1' required: - txnAmount example: '100' state: type: string enum: - draft - submitted - partiallyApproved - partiallyPaid - approved - paid - posted - declined - reversalPending - reversed - reversal default: posted description: State to update the entry to. Posted to post to the GL example: draft accounts-receivable-advance-line: type: object description: Detail and header information for AR advance transactions. properties: key: type: string description: System-assigned key for the AR advance line. readOnly: true example: '23' id: type: string description: AR advance line ID. readOnly: true example: '23' href: type: string description: Endpoint for the AR advance line. readOnly: true example: /objects/accounts-receivable/advance-line/23 baseAmount: type: string format: decimal-precision-2 description: >- Amount for the line item in your company's base currency, which is calculated based on the exchange rate defined in the header. readOnly: true example: '100.00' txnAmount: type: string format: decimal-precision-2 description: Amount for the AR advance line item in the transaction currency. example: '100' memo: type: string description: Memo about the line item. example: Service charges currency: type: object description: Currency details for the advance. properties: baseCurrency: type: string description: Base currency for the company. readOnly: true example: USD txnCurrency: type: string description: Transaction currency for the advance. readOnly: true example: GBP exchangeRate: type: object title: exchangeRate description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' lineNumber: type: integer description: Line number readOnly: true example: 1 paymentInformation: type: object description: Payment information for the AR advance line item. properties: totalPaid: type: string format: decimal-precision-2 description: Total paid for the line item. readOnly: true example: '200' txnTotalPaid: type: string format: decimal-precision-2 description: Transaction total paid for the line item. readOnly: true example: '200' totalSelected: type: string format: decimal-precision-2 description: Total selected for the line item. readOnly: true example: '100' txnTotalSelected: type: string format: decimal-precision-2 description: Total transaction selected for the line item. readOnly: true example: '100' baseLocation: type: object allOf: - $ref: '#/components/schemas/location-ref' - type: object properties: key: type: string description: Base location key. example: '4' accountLabel: type: object properties: key: type: string description: System-assigned key for the account label. example: '14' id: type: string description: Meaningful name of the account. example: Accounting Fees name: type: string description: Name of the account label. readOnly: true example: Accounting Fees href: type: string description: Endpoint for the account label. readOnly: true example: /objects/accounts-receivable/account-label/14 glAccount: $ref: '#/components/schemas/gl-account-ref' dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of locations to reflect how your company is organized. title: location properties: key: type: string description: System-assigned key for the location. example: '4' id: type: string description: Unique identifier of the location. example: AU name: type: string description: Name of the location. readOnly: true example: Australia href: type: string description: Endpoint for the location. readOnly: true example: /objects/company-config/location/4 department: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string description: System-assigned key for the department. example: '9' id: type: string description: Unique identifier of the department. example: '01' name: type: string description: Name of the department. readOnly: true example: Accounting href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/9 arAdvance: description: Header level details for the AR advance's line items. type: object readOnly: true properties: id: type: string description: Identifier for the AR advance. readOnly: true example: '23' key: type: string description: System-assigned key for the AR advence. readOnly: true example: '23' href: type: string description: Endpoint for the AR advance. readOnly: true example: /objects/accounts-receivable/advance/23 recordType: type: string description: Record type. readOnly: true example: rr audit: $ref: '#/components/schemas/audit' accounts-receivable-advance: type: object description: Header information for AR advance transactions. properties: key: type: string description: System-assigned key for the ar-advance. readOnly: true example: '23' id: type: string description: AR advance ID. readOnly: true example: '23' recordType: type: string description: >- Record type to identify the type of transaction. AR Advances record type refers to `rr`. readOnly: true example: rr href: type: string description: Endpoint for the ar-advance. readOnly: true example: /objects/accounts-receivable/advance/23 referenceNumber: type: string description: >- This is a number such as a purchase order or account number that might be useful in searches or reports. This number shows on the GL Details report. example: INV-902852 description: type: string description: Description of the AR advance. example: >- Computer Hardware & Software Expenses 03/01/20 - 08/31/21 Subscription charges. receiptDate: type: string format: date description: Receipt date. example: '2021-01-25' paymentDate: type: string format: date description: Payment date. example: '2021-01-25' state: $ref: '#/components/schemas/state' totalEntered: type: string format: decimal-precision-2 description: Total amount of the AR advance. example: '100' txnTotalEntered: type: string format: decimal-precision-2 description: Total transaction amount. example: '100.20' paymentInformation: type: object description: Payment information for the AR advance. properties: paidDate: type: string format: date example: '2021-01-23' description: Date the AR advance was paid. readOnly: true totalPaid: type: string format: decimal-precision-2 description: Total paid for the AR advance. readOnly: true example: '100' totalSelected: type: string format: decimal-precision-2 description: Total selected for the AR advance. readOnly: true example: '100.10' txnTotalSelected: type: string format: decimal-precision-2 description: Total transaction selected. readOnly: true example: '1000.05' txnTotalPaid: type: string format: decimal-precision-2 description: Transaction total paid. readOnly: true example: '2000.50' totalDue: type: string format: decimal-precision-2 description: Total amount due. readOnly: true example: '251464.01' totalTxnAmountDue: type: string format: decimal-precision-2 description: Total amount due for the advance. readOnly: true example: '10' reconciliationGroup: type: object properties: clearingDate: type: string format: date description: Automatically added when reconciliation is done. example: '2021-01-23' cleared: type: string enum: - 'true' - 'false' - matched description: Status to mark the reconciliation stage default: 'false' example: 'false' isSystemGenerated: type: boolean description: System generated example: false default: false accountType: type: string description: Account Type. example: bank enum: - bank - undepositedFundsAccount default: bank advanceSummary: type: object description: >- Summary details for this advance. Summaries are collections of the same types of transactions grouped together for processing. properties: href: type: string description: Endpoint for the batch. readOnly: true example: /objects/batch/23 key: type: integer description: System-assigned key to uniquely identify the summary. example: 280 id: type: string description: System-assigned ID for the summary. example: '280' name: type: string description: >- Name for the AR summary. The system uses this name to identify the summary throughout the Accounts Receivable application. example: 'Bills: 2022/01/01 Batch' glPostingDate: type: string format: date description: Posted date of the AR advance summary. example: '2021-01-23' isSummaryOpen: type: string description: >- A summary can be open or closed. Items, such as invoices, can be added to open summaries. enum: - open - closed example: open readOnly: true customer: type: object properties: href: type: string description: Endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/23 id: type: string description: ID of the customer. example: Customer_01 key: type: string description: System-assigned key for the customer. example: '15' name: type: string description: Customer name. example: Logic Solutions currency: $ref: '#/components/schemas/currency' financialEntity: type: string description: Financial entity. example: BOA glAccount: type: object properties: href: type: string description: Endpoint for the glaccount. readOnly: true example: /objects/glaccount/23 id: type: string description: General ledger account number. example: '1501' key: type: string description: System-assigned key for the general ledger account. example: '356' undepositedGLAccountNumber: type: string description: Undeposited funds account no.. example: '100444' paymentMethod: type: string description: Payment method. nullable: false example: printedCheck enum: - printedCheck - creditCard - eft - cash - ach attachment: type: object properties: key: type: string example: '21' id: type: string example: Sales01 href: type: string readOnly: true example: /objects/company-config/attachment/21 items: type: array description: Line items of the advance. items: $ref: '#/components/schemas/accounts-receivable-advance-line' audit: $ref: '#/components/schemas/audit' accounts-receivable-advance-lineRequiredProperties: type: object required: - txnAmount accounts-receivable-billback-templateRequiredProperties: type: object required: - id - description properties: lines: type: array items: type: object required: - txnAmount properties: invoiceGLAccount: type: object required: - key billGLAccount: type: object required: - key accounts-receivable-billback-template-line: type: object description: Billback template lines properties: key: type: string description: Record key readOnly: true example: '5' id: type: string description: BillBack Template Line Item ID readOnly: true example: '5' href: type: string description: URL for the billback template line. readOnly: true example: /objects/accounts-receivable/billback-template-line/5 lineNumber: type: string description: Line No readOnly: true example: '2' memo: type: string description: Memo example: Line number 2 invoiceGLAccount: type: object description: The account for the line item in the invoice properties: key: type: string example: '5' id: type: string example: '4000' name: type: string example: Sales href: type: string description: URL for the account. readOnly: true example: /objects/general-ledger/account/5 billGLAccount: type: object description: >- The bill GL Account is used in the corresponding line item of generated bill. properties: key: type: string example: '6' id: type: string example: '2000' name: type: string example: School Fees href: type: string description: URL for the account. readOnly: true example: /objects/general-ledger/account/6 department: type: object description: Department properties: key: type: string example: '9' id: type: string example: '11' name: type: string example: Accounting href: type: string description: URL for the account. readOnly: true example: /objects/company-config/department/9 billbackTemplate: description: Header level details for the Billback templete's line items. type: object properties: id: type: string description: Identifier for the billback template. readOnly: true example: '5' key: type: string description: System-assigned key for the Billback template. readOnly: true example: '5' href: type: string description: URL for the billback template. readOnly: true example: /objects/accounts-receivable/billback-template/5 readOnly: true accounts-receivable-billback-template: type: object description: Billback template properties: key: type: string description: BillBack Template Key readOnly: true example: '23' id: type: string description: BillBack Template ID example: Template 1 href: type: string description: URL for the billback template. readOnly: true example: /objects/accounts-receivable/billback-template/23 description: type: string description: Description example: Billback template for sales account enableInterEntityPostings: type: boolean description: >- Set to true to post directly to the mapped inter-entity offset accounts instead of the Accounts Receivable and Accounts Payable offset accounts. default: false example: true status: $ref: '#/components/schemas/status' lines: type: array description: Line items of the billback template. items: $ref: '#/components/schemas/accounts-receivable-billback-template-line' accounts-receivable-invoice-summary: type: object description: Collection of invoices grouped together for processing. properties: key: type: string description: System-assigned key for the invoice summary. readOnly: true example: '13' id: type: string description: >- ID for the invoice summary. This value is the same as key for this object. readOnly: true example: '13' href: type: string description: URL endpoint for the invoice summary. readOnly: true example: /objects/accounts-receivable/invoice-summary/23 name: type: string description: >- Name of the invoice summary. The system uses this name to identify the summary throughout the Accounts Receivable application. example: batch4 summaryCreationType: type: string description: >- If set to `manual`, the summary was created by a user and if set to `system`, the summary was created by Sage Intacct based on the summary frequency. example: manual enum: - system - manual default: manual readOnly: true glPostingDate: type: string format: date description: >- The date that the items included in the summary should post to the general ledger. example: '2023-05-06' recordType: type: string description: >- The record type determines the type of items the summary should contain. example: ri enum: - pi - pp - pa - pb - pd - ri - rp - ra - rd - ro - rc - ei - ep - ea - cm totalAmount: type: string description: Total amount of all transactions included in the summary. format: decimal-precision-2 example: '120.12' readOnly: true state: type: string description: >- State of the summary, which can be `open` or `closed`. An open summary can have items added to it. example: open enum: - open - closed parent: type: object description: Parent of the invoice summary. properties: key: type: string description: System-assigned key for the parent summary. example: '13' id: type: string description: Identifier for the parent summary. example: '13' href: type: string description: URL endpoint for the parent summary. readOnly: true example: /objects/accounts-receivable/summary/13 preventGLPosting: type: boolean description: >- Set to `true` to prevent posting the summary items to the general ledger. default: false example: false bankAccount: type: object description: Bank account associated with the invoice summary. properties: key: type: string description: System-assigned key for the bank account. example: '1' id: type: string description: ID for the bank account. example: '1' href: type: string description: URL endpoint for the bank account. readOnly: true example: /objects/cash-management/bank-account/1 isQuickPaymentSummary: type: boolean description: >- This field is set to `true` only for manual and quick payment summaries. example: false default: false status: $ref: '#/components/schemas/status' accounts-receivable-paymentRequiredProperties: type: object properties: paymentDetails: type: array items: type: object properties: arInvoice: required: - id example: '1' txnCurrency: required: - paymentAmount example: '100' paymentSummary: required: - receiptDate example: '2021-01-23' customer: required: - id example: '1' txnCurrency: required: - currency example: USD required: - paymentMethod example: cash accounts-receivable-payment-detail: type: object description: >- An AR payment detail object can specify either an object, like an invoice or an adjustment, as a whole (header level), or it can specify a line item. An AR payment detail object also provides the transaction amount that was received. properties: key: type: string description: System-assigned key for the AR payment detail. readOnly: true example: '94' id: type: string description: >- Identifier for the AR payment detail. This value is the same as `key` for this object. readOnly: true example: '94' href: type: string description: URL for the AR payment detail. readOnly: true example: /objects/accounts-receivable/payment-detail/94 paymentDate: type: string format: date description: >- Date the payment was received. For example, for a credit card payment, this date is the date the credit card transaction occurred. readOnly: true example: '2023-04-30' discountDate: type: string format: date description: Discount date example: '2023-04-30' baseCurrency: type: object description: For multi-currency companies, the company's base currency. properties: paymentAmount: type: string format: decimal-precision-2 description: The amount of the payment in the company's base currency. example: '10' inlineAmount: type: string format: decimal-precision-2 description: Inline transaction base amount. readOnly: true example: '10' adjustmentAmount: type: string format: decimal-precision-2 description: Adjustment transaction base amount. readOnly: true nullable: true example: '10' postedAdvanceAmount: type: string format: decimal-precision-2 description: Posted advance base amount. readOnly: true nullable: true example: '10' negativeInvoiceAmount: type: string format: decimal-precision-2 description: Negative invoice transaction base amount. readOnly: true nullable: true example: '10' postedOverPaymentAmount: type: string format: decimal-precision-2 description: Posted overpayment base amount. nullable: true readOnly: true example: '10' txnCurrency: type: object description: Transaction currency for the payment detail. properties: currency: type: string description: Payment currency. readOnly: true example: USD paymentAmount: type: string description: The amount of the transaction in the payment currency. format: decimal-precision-2 nullable: false example: '243.00' inlineAmount: type: string description: Inline transaction amount. format: decimal-precision-2 nullable: true example: '100.00' adjustmentAmount: type: string description: Adjustment transaction amount. format: decimal-precision-2 nullable: true example: '10' postedAdvanceAmount: type: string description: Posted advance transaction amount. format: decimal-precision-2 nullable: true example: '10' postedOverPaymentAmount: type: string description: Posted overpayment transaction amount. format: decimal-precision-2 nullable: true example: '40' negativeInvoiceAmount: type: string description: Negative invoice transaction amount. format: decimal-precision-2 nullable: true example: '30' inlineTxn: type: object description: Inline transaction record details. properties: key: type: string description: System generated key for the inline transaction. example: '89' id: type: string description: Inline transaction identifier. example: '89' href: type: string description: URL for the inline transaction. readOnly: true example: /objects/accounts-receivable/invoice/89 inlineTxnLine: type: object description: Inline transaction line item record. properties: key: type: string description: System generated key for the inline transaction line item. example: '4' id: type: string description: Identifier for the inline transaction line item. example: '4' href: type: string description: URL for the inline transaction line item. readOnly: true example: /objects/accounts-receivable/invoice-line/4 postedAdvance: type: object description: Posted advance record. readOnly: true properties: key: type: string description: System-generated key for the posted advance. readOnly: true nullable: true example: '25' id: type: string description: Identifier for the posted advance. readOnly: true nullable: true example: '25' href: type: string readOnly: true example: /objects/accounts-receivable/advance/25 postedAdvanceLine: type: object description: Posted advance line item record. readOnly: true properties: key: type: string description: System-assigned key for the posted advance line item. readOnly: true nullable: true example: '112' id: type: string description: Identifier for the posted advance line item. readOnly: true nullable: true example: '112' href: type: string readOnly: true example: /objects/accounts-receivable/advance-line/112 postedOverPayment: type: object description: Posted overpayment record. readOnly: true properties: key: type: string description: System-generated key for the posted overpayment record. readOnly: true nullable: true example: '3328' id: type: string description: Identifier for the posted overpayment record. readOnly: true nullable: true example: '3328' href: type: string description: URL for the posted overpayment record. readOnly: true example: /objects/accounts-receivable/payment/3328 postedOverPaymentLine: type: object description: Posted overpayment line item record. readOnly: true properties: key: type: string description: System generated key for the posted overpayment line item. readOnly: true nullable: true example: '56' id: type: string description: Identifer for the posted overpayment line item. readOnly: true nullable: true example: '56' href: type: string description: URL for the posted overpayment line item. readOnly: true example: /objects/accounts-receivable/payment-line/56 negativeInvoice: type: object description: Negative invoice transaction record properties: key: type: string description: System-generated key for the negative invoice transaction. example: '33' nullable: true id: type: string description: Identifier for the negative invoice transaction. example: '33' nullable: true href: type: string description: URL for the negative invoice transaction. readOnly: true example: /objects/accounts-receivable/invoice/33 negativeInvoiceLine: type: object description: Negative invoice transaction line item record. properties: key: type: string description: >- System-generated key for the negative invoice transaction line item. example: '4' nullable: true id: type: string description: Identifier for the negative invoice transaction line item. nullable: true example: '4' href: type: string description: URL for the invoice transaction line item. readOnly: true example: /objects/accounts-receivable/invoice-line/4 arAdjustment: type: object description: AR adjustment transaction record. properties: key: type: string description: System-generated key for the AR adjustment. example: '41' nullable: true id: type: string description: Identifier for the AR adjustment. nullable: true example: '41' href: type: string readOnly: true example: /objects/accounts-receivable/adjustment/41 arAdjustmentLine: type: object description: AR adjustment transaction line item record. properties: key: type: string description: System-generated key for the adjustment line item. example: '86' nullable: true id: type: string description: Identifier for the adjustment line item. example: '86' nullable: true href: type: string description: URL for the adjustment line item. readOnly: true example: /objects/accounts-receivable/adjustment-line/86 arInvoice: type: object description: AR invoice record. properties: key: type: string description: System-assigned key for the AR invoice. example: '1202' id: type: string description: Identifier for the AR invoice. example: '1202' href: type: string description: URL for the AR invoice. readOnly: true example: /objects/accounts-receivable/invoice/1202 arInvoiceLine: type: object description: AR invoice line item record. properties: key: type: string description: System-assigned key for the AR invoice line item. example: '6012' id: type: string description: Identifier for the AR invoice line item. example: '6012' href: type: string description: URL for the AR invoice line item readOnly: true example: /objects/accounts-receivable/invoice-line/6012 arAdvance: type: object description: AR advance record. properties: key: type: string description: System-generated key for the AR advance. example: '999' nullable: true id: type: string description: Identifier for the AR advance. example: '999' nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/advance/999 arAdvanceLine: type: object description: AR advance line item record. properties: key: type: string description: System-generated key for the AR advance line item. example: '59' nullable: true id: type: string description: Identifier for the AR advance line item. example: '59' nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/advance-line/59 arPostedOverPayment: type: object description: AR posted overpayment record. properties: key: type: string description: System-generated key for the posted overpayment. example: '4428' nullable: true id: type: string description: Identifier for the posted overpayment. example: '4428' nullable: true href: type: string description: URL for the posted overpayment. readOnly: true example: /objects/accounts-receivable/payment/4428 arPostedOverPaymentLine: type: object description: AR posted overpayment line item record. properties: key: type: string description: System-generated key for the posted overpayment line item. nullable: true example: '1642' id: type: string description: Identifier for the posted overpayment line item example: '1642' nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/payment-line/1642 arPayment: type: object description: AR payment record. readOnly: true properties: key: type: string description: System-assigned key for the AR payment. readOnly: true example: '2527' id: type: string description: Identifier for the AR payment. readOnly: true example: '2527' href: type: string description: URL for the AR payment. readOnly: true example: /objects/accounts-receivable/payment/2527 arPaymentLine: type: object description: AR payment line item record. readOnly: true properties: key: type: string description: System-assigned key for the AR payment line. readOnly: true example: '6663' id: type: string description: Identifier for the AR payment line. readOnly: true example: '6663' href: type: string description: URL for the AR payment line. readOnly: true example: /objects/accounts-receivable/payment-line/6663 positiveAdjustment: type: object description: Postive adjustment record. properties: key: type: string description: System-assigned key for the positive adjustment. example: '3379' nullable: true id: type: string description: Identifier for the positive adjustment. example: '3379' nullable: true href: type: string description: URL for the positive adjustment. readOnly: true example: /objects/accounts-payable/subledger-record/3379 positiveAdjustmentLine: type: object description: Positive adjustment line item record. properties: key: type: string description: System-assigned key for the positive adjustment line item. nullable: true example: '5678' id: type: string description: Identifier for the positive adjustment line item. nullable: true example: '5678' href: type: string description: URL for the positive adjustment line item. readOnly: true example: /objects/accounts-payable/subledger-record-line/5678 audit: $ref: '#/components/schemas/audit' accounts-receivable-payment-line: type: object description: >- Line items in a payment represent charges for items or services included in an invoice or adjustment. properties: id: type: string description: >- Identifier for the AR payment line item. This value is the same as `key` for this object. readOnly: true example: '98545678' key: type: string description: System-assigned key for the AR payment line item. readOnly: true example: '98545678' href: type: string description: URL for the AR payment line item. readOnly: true example: /objects/accounts-receivable/payment-line/98545678 memo: type: string description: Memo or brief description of the AR payment line item. example: Annual service charge baseCurrency: type: object description: >- For multi-currency companies, base currency information for the line item. readOnly: true properties: currency: type: string description: Base currency of the company. readOnly: true example: USD amount: type: string format: decimal-precision-2 description: >- For multi-currency companies, the amount of the line item in the company's base currency. readOnly: true example: '10' totalPaid: type: string format: decimal-precision-2 description: Total amount paid for the line item. readOnly: true example: '10' totalSelected: type: string format: decimal-precision-2 description: Total selected for the line item. readOnly: true example: '0' txnCurrency: type: object description: Transaction currency information for the line item. readOnly: true properties: currency: type: string description: Transaction currency. readOnly: true example: USD amount: type: string format: decimal-precision-2 description: >- For payment involving multi-currency, the amount of the item in the currency for the invoice. readOnly: true example: '10' totalPaid: type: string format: decimal-precision-2 description: Transaction total paid for the line item. readOnly: true example: '10' totalSelected: type: string format: decimal-precision-2 description: Total transaction selected for the line item. readOnly: true example: '0' exchangeRate: type: object description: >- Exchange rate details used to calculate the base amount for the line item. readOnly: true properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' lineNumber: type: number description: Line number of the AR payment line item. readOnly: true example: 1 arPayment: type: object description: Header level details for the AR payment's line entries. readOnly: true properties: key: type: string description: Parent payment record number. readOnly: true example: '310' id: type: string description: Parent payment record number. readOnly: true example: '310' href: type: string description: URL for the AR payment. readOnly: true example: /objects/accounts-receivable/payment/310 glAccount: type: object description: GL account associated with the line item. properties: key: type: string description: Account key example: '87' id: type: string description: Account number example: '1100' name: type: string description: GL account title example: Sales href: type: string description: GL account URL readOnly: true example: /objects/general-ledger/account/87 offsetGLAccount: type: object description: >- The general ledger account where the system posts offsets to this line item. properties: key: type: string description: Offset GL account key. example: '83' id: type: string description: Offset GL account number. example: '4000' href: type: string description: Offset GL account URL. readOnly: true example: /objects/general-ledger/account/83 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of locations to reflect how your company is organized. title: location properties: key: type: string description: Location key. example: '4' id: type: string description: Location ID. example: US name: type: string description: Location name. example: United States href: type: string description: Location URL. readOnly: true example: /objects/company-config/location/4 department: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string description: Department key. example: '9' id: type: string description: Department ID. example: ENG name: type: string description: Department name. example: Engineering href: type: string description: Department URL. readOnly: true example: /objects/company-config/department/9 audit: $ref: '#/components/schemas/audit' accounts-receivable-payment: type: object description: >- An AR payment is a transaction used to record a payment against an AR invoice or an AR adjustment/debit memo. properties: key: type: string description: System-assigned key for the AR payment. readOnly: true example: '310' id: type: string description: >- ID for the AR payment. This value is the same as the key for this object. readOnly: true example: '310' href: type: string description: URL endpoint for the AR payment. readOnly: true example: /objects/accounts-receivable/payment/310 recordType: type: string description: Type of payment record. readOnly: true example: rp payerName: type: string description: Name of the payer. example: NF Power and Light financialEntity: type: object description: Financial account from which the payment will be made. properties: entityId: type: string description: Financial entity ID, such as a checking account ID. example: CHK002 entityType: type: string description: Financial entity type. readOnly: true example: ba name: type: string description: Bank or other financial institution name. readOnly: true example: HSBC currency: type: string description: Bank currency readOnly: true example: USD state: type: string description: State of the AR payment. readOnly: true enum: - confirmed - reconciled - draft - reversed - reversal example: confirmed nullable: false default: null multiEntityPayment: type: object description: Multi-entity payment details. properties: key: type: string description: System-assigned key for the multi-entity payment. example: '123' readOnly: true nullable: true id: type: string description: Identifier for the multi-entity payment. readOnly: true nullable: true example: PAY-00136 href: type: string description: URL for the multi-entity payment. readOnly: true example: /objects/accounts-receivable/payment/123 paymentMethod: type: string description: Payment Method enum: - printedCheck - creditCard - eft - cash - onlineChargeCard - onlineACHDebit example: printedCheck documentNumber: type: string description: Document number, such as a check number. example: '1567' description: type: string description: Memo or notes about the AR payment. maxLength: 1000 example: Regular payment for services baseCurrency: type: object description: For multi-currency companies, the company's base currency. properties: currency: type: string description: The company's base currency. example: USD amountToPay: type: string format: decimal-precision-2 description: Amount to pay in the base currency. example: '500' totalAmount: type: string format: decimal-precision-2 description: Total base amount. readOnly: true example: '500' totalPaid: type: string format: decimal-precision-2 description: Total base amount paid. readOnly: true example: '500' totalDue: type: string format: decimal-precision-2 description: Total base amount due. readOnly: true example: '0' txnCurrency: type: object description: Transaction currency for the payment. properties: currency: type: string description: The currency in which the payment was made. example: USD amountToPay: type: string format: decimal-precision-2 description: Amount to pay in the transaction currency. example: '500' totalAmount: type: string description: Total transaction amount. format: decimal-precision-2 maxLength: 14 example: '100.00' totalPaid: type: string format: decimal-precision-2 description: Total transaction amount paid. readOnly: true example: '100.00' totalDue: type: string description: Total transaction amount due. format: decimal-precision-2 maxLength: 14 example: '0' readOnly: true exchangeRate: type: object description: Exchange rate details used to calculate the base amount. readOnly: true properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' bankReconciliationStatus: type: string description: If set to `true`, the payment has been reconciled. example: 'true' enum: - 'true' - 'false' default: 'false' readOnly: true bankReconciliationDate: type: string format: date description: Reconciliation date for the payment. readOnly: true example: '2022-04-30' referenceNumber: type: string description: >- Reference number, which can be a transaction number from the bank or a document number. maxLength: 21 example: '1234' paymentSummary: type: object description: >- AR summary the payment is part of. Summaries are collections of transactions grouped together for processing. properties: key: type: string description: System-assigned key for the AR summary. maxLength: 8 example: '1259' id: type: string description: Identifier for the AR summary. example: '1259' receiptDate: type: string format: date description: Posting date for the AR payment. example: '2021-01-23' title: type: string description: Title of the AR summary. example: 'Receipts (Bank-CHK0002): Batch 02-07-2023' name: type: string description: Name of the AR summary. maxLength: 100 example: Feb 2023 batch href: type: string description: URL endpoint for the AR summary. readOnly: true example: /objects/accounts-receivable/summary/1259 undepositedGLAccount: type: object description: Undeposited funds account associated with this payment. properties: href: type: string description: URL endpoint for the undeposited funds account. readOnly: true example: /objects/general-ledger/account/23 id: type: string description: Undeposited funds account number. example: '1501' nullable: true key: type: string description: System-assigned key for the undeposited funds account. example: '356' nullable: true customer: type: object description: Customer associated with the AR payment. properties: key: type: string description: System-assigned key for the customer. example: '45' entity: type: string description: Customer entity example: C100 readOnly: true id: type: string description: Identifier for the customer. maxLength: 21 example: Cust-00064 name: type: string description: Name of the customer. example: NF Power and Light readOnly: true totalDueAmount: type: string format: decimal-precision-2 description: Total due for the customer. readOnly: true example: '100.0' href: type: string description: URL endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/45 attachment: type: object description: Supporting document for the payment. properties: key: type: string description: System-assigned key for the attachment. example: '123' id: type: string description: Identifier for the attachment. example: '123' href: type: string description: URL endpoint for the attachment. readOnly: true example: /objects/company-config/attachment/123 paidDate: type: string format: date example: '2023-01-23' description: Date when the invoice was fully paid. overPaymentDimensions: type: object description: >- Overpayments can be applied to future invoices and can be tagged to specific dimensions for future use. properties: customerId: type: string description: Customer who made the payment. example: C-00013 locationId: type: string description: ID of the location to assign any overpayment amount to. example: CA departmentId: type: string description: ID of the department to assign any overpayment amount to. example: '04' classId: type: string description: ID of the class to assign any overpayment amount to. example: Class1 projectId: type: string description: ID of the project to assign any overpayment amount to. example: '11' overPaymentAmount: type: string format: decimal-precision-2 description: >- Amount of the overpayment. When a payment is received that exceeds what the customer owes on all invoices and the amount of the payment is entered, Sage Intacct tracks the excess as an overpayment. example: '100.20' contacts: type: object description: Contact information for the AR payment. properties: payTo: type: object description: Pay-to contact for the AR payment. title: payTo properties: key: type: string description: System-assigned key for the pay-to contact. example: '8' id: type: string description: Identifier for the pay-to contact. example: Klay Vanderbilt paymentDetails: type: array description: Details for the AR payment. items: $ref: '#/components/schemas/accounts-receivable-payment-detail' lines: type: array description: Line items of the AR payment. items: $ref: '#/components/schemas/accounts-receivable-payment-line' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true accounts-receivable-payment-summary: type: object description: >- Collections of payments received from customers, such as invoice payments, grouped together for processing. properties: key: type: string description: System-assigned key for the AR payment summary. readOnly: true example: '5' id: type: string description: AR payment summary ID. readOnly: true example: '5' href: type: string description: Endpoint for the AR payment summary. readOnly: true example: /objects/accounts-receivable/payment-summary/5 name: type: string description: >- Name for the AR payment summary. The system uses this name to identify the summary throughout the Accounts Receivable application. example: 'Reversed Receipts(Bank-BOA): 2023/04/12 Batch' summaryCreationType: type: string description: >- If set to manual, then the summary was created by a user and if set to system, then the summary was created by Intacct based on the summary frequency. example: system enum: - system - manual default: manual readOnly: true glPostingDate: type: string format: date description: The date summary items post to the general ledger. example: '2023-04-12' recordType: type: string description: This determines the type of transactions of AR payment summary. example: rp enum: - pi - pp - pa - pb - pd - ri - rp - ra - rd - ro - rc - ei - ep - ea - cm totalAmount: type: string description: >- Total amount of transactions in the summary. Transactions amount include quick payments. format: decimal-precision-2 example: '200' readOnly: true state: type: string description: >- State of the summary, which can be `open` or `closed`. An open summary can have items added to it. example: open enum: - open - closed parent: type: object description: Parent of the AR payment summary. properties: key: type: string description: System-assigned key for the parent. example: '13' id: type: string description: Identifier for the parent. example: '13' href: type: string description: URL for the parent. readOnly: true example: /objects/accounts-receivable/summary/13 preventGLPosting: type: boolean description: >- Set to `true` to prevent posting summary items to the general ledger. default: false example: false bankAccount: type: object description: Bank account ID. properties: key: type: string description: System-assigned key for the bank account. example: '1' id: type: string description: Identifier for the bank account. example: '1' href: type: string description: URL for the bankaccount. readOnly: true example: /objects/cash-management/bank-account/1 isQuickPaymentSummary: type: boolean description: >- This field is set to true only for manual and quick payment summaries. Default is false. example: false default: false status: $ref: '#/components/schemas/status' accounts-receivable-summaryRequiredProperties: type: object required: - name - glPostingDate - recordType - status accounts-receivable-summary: type: object description: >- Summaries are collections of the same type of transactions, grouped together for processing. properties: key: type: string description: System-assigned key for the AR summary. readOnly: true example: '14' id: type: string description: >- Identifier for the AR summary. This value is the same as key for this object and can be ignored. Use key for all references to this object. readOnly: true example: '14' href: type: string description: URL the AR summary. readOnly: true example: /objects/accounts-receivable/summary/14 name: type: string description: >- Name for the AR summary. The system uses this name to identify the summary throughout the Accounts Receivable application. example: batch5 summaryCreationType: type: string description: >- If set to manual, then the summary was created by a user and if set to system, then the summary was created by Intacct based on the summary frequency. example: manual enum: - system - manual default: manual readOnly: true glPostingDate: type: string format: date description: The date summary items post to the general ledger. example: '2023-05-10' recordType: type: string description: >- Options Invoice, Adjustment, QuickDeposit, Payments. This determines the type of transaction that the summary contains. example: ra enum: - pi - pp - pa - pb - pd - ri - rp - ra - rd - ro - rc - ei - ep - ea - cm totalAmount: type: string description: >- Total amount of transactions in the summary. Transactions amount include invoices/adjustments and quick payment summaries. format: decimal-precision-2 example: '100' readOnly: true state: type: string description: >- State of the summary, which can be `open` or `closed`. An open summary can have items added to it. example: open enum: - open - closed parent: type: object description: Parent of the AR summary. properties: key: type: string description: System-assigned key for the parent. example: '11' id: type: string description: Identifier for the parent. example: '11' href: type: string description: URL for the parent. readOnly: true example: /objects/accounts-receivable/summary/11 preventGLPosting: type: boolean description: >- Set to `true` to prevent posting summary items to the general ledger. example: false default: false bankAccount: type: object description: Detail of the bank accounts. properties: key: type: string description: System-assigned key for the GL account. example: '13' id: type: string description: ID for the bank account. example: '13' href: type: string description: URL for the bank account. readOnly: true example: /objects/cash-management/bank-account/1 isQuickPaymentSummary: type: boolean description: >- This field is set to true only for manual and quick payment summaries. It is set to false for transactions of type invoice/adjustment. example: false default: false status: $ref: '#/components/schemas/status' accounts-receivable-territoryRequiredProperties: type: object required: - id - name accounts-receivable-territory: type: object description: >- Territories are optionally included in customer records and are used with Accounts Receivable reports. properties: key: type: string description: System-assigned key for the territory. readOnly: true example: '1' id: type: string description: >- Unique identifier for the territory. After an ID is created, it cannot be modified. example: T1 href: type: string readOnly: true description: Endpoint of the territory. example: /objects/accounts-receivable/territory/1 name: type: string description: Name of the territory. example: Southwest US status: $ref: '#/components/schemas/status' parent: type: object description: Parent territory if territories are organized in a hierarchy. properties: key: type: string description: System-assigned key for the parent territory. example: '2' id: type: string description: ID of the parent territory. example: 1-North href: type: string readOnly: true description: Endpoint of the parent territory. example: /objects/accounts-receivable/territory/21 manager: type: object description: >- Employee who manages the territory. Used for informational purposes only. properties: key: type: string description: System-assigned key for the employee. example: '81' id: type: string description: >- Unique identifier of the territory manager. When creating a territory, this must be the `id` of an existing employee. example: dwilson href: type: string description: Endpoint of the territory manager. example: /objects/company-config/employee/81 readOnly: true audit: $ref: '#/components/schemas/audit' accounts-receivable-territory-groupRequiredProperties: type: object required: - id - name - members accounts-receivable-territory-group-member: type: object description: Territory group members properties: key: type: string description: System-assigned key for the territory-group-member. readOnly: true example: '23' id: type: string description: System-assigned key for the territory-group-member. example: '23' href: type: string description: Endpoint for the territory-group-member. readOnly: true example: /objects/accounts-receivable/territory-group-member/23 territory: type: object description: Territory details. properties: key: type: string description: Territory object record no example: '1' id: type: string description: Territory ID example: T1 name: type: string description: Territory name readOnly: true example: India Territory href: type: string description: Endpoint for the territory. readOnly: true example: /objects/accounts-receivable/territory/23 sortOrder: type: string description: Territory group members sort order example: '1' territoryGroup: type: object description: Territory Group readOnly: true properties: key: type: string readOnly: true example: '10' id: type: string description: Parent group record number example: TG-1 href: type: string description: Endpoint for the territory-group. example: /objects/accounts-receivable/territory-group/23 audit: $ref: '#/components/schemas/audit' accounts-receivable-territory-group: type: object description: Territory groups properties: key: type: string description: System-assigned key for the territory-group. readOnly: true example: '23' id: type: string description: Territoty Group ID. example: T1 href: type: string description: Endpoint for the territory-group. readOnly: true example: /objects/accounts-receivable/territory-group/23 name: type: string description: Territory group name example: Group A description: type: string description: Description of the territory group maxLength: 500 example: Group 1 members: type: array description: Territory group members. minItems: 1 items: $ref: '#/components/schemas/accounts-receivable-territory-group-member' audit: $ref: '#/components/schemas/audit' accounts-receivable-customer-item-cross-referenceRequiredProperties: type: object required: - id accounts-receivable-customer-item-cross-reference: type: object description: list of customer item cross references properties: key: type: string description: Customer Item Cross Reference Key readOnly: true id: type: string description: Customer Item Cross Reference id readOnly: true href: type: string description: URL of the customer-item-cross-reference. readOnly: true customer: type: object description: Customer. properties: key: type: string description: Customer key id: type: string description: Customer ID name: type: string href: type: string description: URL of the customer. readOnly: true item: type: object properties: key: type: string description: Item key id: type: string description: Item ID example: null name: type: string example: null href: type: string description: URL of the item. readOnly: true referenceType: type: string description: Reference type example: customer enum: - customer default: customer itemAliasId: type: string description: Cross-reference item ID example: null itemAliasDescription: type: string description: Cross-reference item description example: null unit: type: string description: Unit example: null referenceTypeContext: type: string description: Reference type Context example: null enum: - internal - external audit: $ref: '#/components/schemas/audit' customerAccountGroupRequiredProperties: type: object required: - id accounts-receivable-customer-account-group: type: object properties: key: type: string description: Customer account group key readOnly: true example: '5' id: type: string description: Customer account group name example: Top Level customer groupType: type: string description: Customer account group type enum: - customer example: customer default: customer status: $ref: '#/components/schemas/status' href: type: string readOnly: true example: /objects/accounts-receivable/customer-account-group/5 accounts-receivable-recurring-invoiceRequiredProperties: type: object required: - invoiceNumber properties: customer: type: object required: - key term: type: object required: - key currency: type: object required: - txnCurrency schedule: type: object required: - startDate lines: type: array items: required: - txnAmount properties: glAccount: type: object required: - key accounts-receivable-recurring-invoice-line: type: object description: >- Line items in a recurring invoice represent transactions captured in that recurring invoice. properties: key: type: string description: System-assigned key for the line item. readOnly: true example: '23' id: type: string description: >- ID for the line item. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '23' href: type: string description: URL for the line item. readOnly: true example: /objects/accounts-receivable/recurring-invoice-line/23 description: type: string description: >- Memo provides information about the line item that may be of use in the future. nullable: true example: Service charges amount: type: string description: Base amount format: decimal-precision-2 example: '100' lineNumber: type: number description: Line number of the line item. readOnly: true example: 1 txnAmount: type: string description: Transaction amount format: decimal-precision-2 example: '100' isBillable: type: boolean description: Indicates whether the line item is billable. example: true default: false currency: type: object description: Currency information for the line item. properties: baseCurrency: type: string description: Base currency readOnly: true example: USD txnCurrency: type: string description: Transaction currency readOnly: true example: USD exchangeRateDate: type: string format: date example: '2021-01-23' description: Exchange rate date nullable: true readOnly: true exchangeRate: type: number description: Exchange rate readOnly: true example: 1.0789 exchangeRateTypeId: type: string description: Exchange rate type nullable: true readOnly: true example: INR-Rate isTax: type: boolean description: Indicates whether the line item is taxable. example: true default: false isSubTotal: type: boolean description: Indicates whether the line item is a subtotal. default: false example: true allocation: type: object description: Type of transaction allocation for the line item. properties: key: type: string description: System-assigned key for the allocation. example: '1' id: type: string description: System-assigned ID for the allocation. example: Alloc1-WBS-US href: type: string description: URL for the allocation. readOnly: true example: /objects/general-ledger/txn-allocation-template/1 accountLabel: type: object description: Account the line item is assigned to. properties: key: type: string description: Account label key example: '14' id: type: string description: Account label example: Accounting Fees href: type: string description: URL for the account label. readOnly: true example: /objects/accounts-receivable/account-label/14 taxDetail: type: object description: >- For companies subscribed to the Taxes application, the tax category for the line item. properties: key: type: string description: Tax detail key example: '1' id: type: string description: Tax detail ID example: '1' taxRate: type: string description: >- The percent tax rate defined for the tax detail used to calculate the amount of tax. readOnly: true example: '1.45' href: type: string description: URL for the tax detail. readOnly: true example: /objects/tax/order-entry-tax-detail/384 startDate: type: string format: date description: Revenue recognition start date. nullable: true example: '2021-01-23' endDate: type: string format: date description: Revenue recognition end date. nullable: true example: '2021-01-23' deferredRevenueGLAccount: type: object description: GL account for deferred revenue for the line item. properties: key: type: string description: Deferred revenue GL account key. example: '384' id: type: string description: Deferred revenue GL account number. example: '384' name: type: string description: Deferred revenue GL account name. readOnly: true example: AR ACCOUNT href: type: string description: URL for the deferred revenue GL account. readOnly: true example: /objects/general-ledger/account/384 glAccount: type: object description: GL account the line item is assigned to. properties: key: type: string description: System-assigned key for the GL account. example: '384' id: type: string description: ID for the GL account. example: '1234.36' name: type: string description: Name or title of the GL account. readOnly: true example: AR ACCOUNT href: type: string description: URL for the GL account. readOnly: true example: /objects/general-ledger/account/384 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Where multiple locations exist, the location to which the system should assign the expense. properties: key: type: string description: System-assigned key for the location. example: '1' id: type: string description: ID for the location. example: '1' name: type: string description: Name of the location. readOnly: true example: India href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/1 department: type: object description: Department the line item is assigned to. properties: key: type: string description: Department key example: '1' id: type: string description: Department ID example: '1' name: type: string description: Department name readOnly: true example: Accounting href: type: string description: URL for the department. readOnly: true example: /objects/company-config/department/1 offsetGLAccount: type: object description: GL account for discounts and penalties. properties: key: type: string description: System-assigned key for the offset GL account. example: '384' id: type: string description: ID for the offset GL account. example: '1234.36' name: type: string description: Name or title of the offset GL account. readOnly: true example: AR ACCOUNT href: type: string description: URL for the offset GL account. readOnly: true example: /objects/general-ledger/account/384 recurringInvoice: type: object description: Header level details for the AR recurring invoice line entries. properties: id: type: string description: ID for the AR recurring invoice. readOnly: true example: '23' key: type: string description: System-assigned key for the AR recurring invoice. example: '23' href: type: string description: URL for the AR recurring invoice. readOnly: true example: /objects/accounts-receivable/recurring-invoice/23 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' accounts-receivable-recurring-invoice: type: object description: >- Recurring invoices are invoices that repeat at periods and durations defined in a recurrence schedule. properties: key: type: string description: System-assigned key for the recurring invoice. readOnly: true example: '23' id: type: string description: >- ID for the recurring invoice. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '23' href: type: string description: URL for the recurring invoice. readOnly: true example: /objects/accounts-receivable/recurring-invoice/23 invoiceNumber: type: string description: >- Each occurrence of the invoice gets an incremented number based on the sequence type defined in Document Numbering on the company setup. example: ARINV totalEntered: type: string format: decimal-precision-2 description: Total amount entered. readOnly: true example: '100.00' description: type: string description: Description of the recurring invoice. nullable: true example: Memo referenceNumber: type: string description: >- This is a number such as a purchase order or account number that may be useful in searches or reports on this invoice. example: Doc 1 schedule: type: object properties: startDate: type: string description: The first date on which the invoice will be generated. format: date example: '2021-01-01' endDate: type: string description: >- If the scheduleEnd field is set to End Date, this establishes the final date on which the invoice will be generated. format: date nullable: true example: '2021-01-01' repeatCount: type: string description: >- If the scheduleEnd field is set to Number of occurrences, this establishes the number of times the invoice will be generated. nullable: true example: '1' repeatInterval: type: string description: >- Repeat interval of the scheduler in the recurring invoice. For example, if the frequency is set to days and the repeat interval is 2, an invoice is created every 2 days after the start date. nullable: true example: '1' default: '1' repeatBy: type: string description: Schedule repeat. enum: - none - day - week - month - year - endOfMonth default: day example: day scheduleEnd: type: string description: Termination point for the recurring invoice schedule. enum: - never - numberOfOccurrences - endDate example: never nextExecutionDate: type: string description: The next date on which the invoice will be generated. format: date example: '2021-01-01' readOnly: true lastExecutionDate: type: string description: The last date on which the invoice was generated. format: date readOnly: true example: '2021-01-01' term: type: object description: >- Payment terms, which are used to calculate due date, discounts, and penalties associated with this invoice. properties: key: type: string description: System-assigned key for the payment term. example: '1' id: type: string description: Name or other unique identifier for the payment term. example: N15 href: type: string description: URL for the payment term. readOnly: true example: /objects/accounts-receivable/term/16 contract: type: object properties: id: type: string description: Unique identifier for the contract. nullable: true example: CON-2 description: type: string description: Description of the contract. nullable: true example: Contract 2 currency: type: object properties: baseCurrency: type: string description: For multi-currency companies, the company's base currency. example: USD txnCurrency: type: string description: For multi-currency companies, the currency for the invoice. example: USD exchangeRate: type: number description: Exchange rate nullable: true example: 1.0789 exchangeRateTypeId: type: string description: Exchange rate type nullable: true example: INR-Rate customerMessage: type: string description: Message to include on the customer's invoice. nullable: true example: Customer message txnTotalEntered: type: string description: Transaction currency amount. format: decimal-precision-2 example: '100' contacts: type: object description: Contacts for the invoice. properties: billTo: type: object description: The bill-to contact is used as the address for the invoice. title: billTo properties: key: type: string description: System-assigned key for the contact. example: '1' id: type: string description: Name of the contact. example: 1099 Int href: type: string description: URL for the contact. readOnly: true example: /objects/company-config/contact/1 shipTo: type: object description: Ship-to contact for the invoice. title: shipTo properties: key: type: string description: System-assigned key for the contact. example: '1' id: type: string description: Name of the contact. example: 1099 Int href: type: string description: URL of the contact. readOnly: true example: /objects/company-config/contact/1 customer: type: object description: Person to receive the invoice. properties: key: type: string description: System-assigned key for the customer. example: '10' id: type: string description: ID for the customer. example: '2' name: type: string description: Name of the customer. readOnly: true example: Logic Solutions href: type: string description: URL for the customer. readOnly: true example: /objects/accounts-receivable/customer/2 payment: type: object description: List of payments on recurring AR invoices. properties: paymentMethod: type: string description: Payment method. example: creditCard enum: - none - printedCheck - creditCard - eft - cash - onlineChargeCard - onlineAchDebit paymentAmount: type: string description: Recurring invoice payment amount. format: decimal-precision-2 nullable: true example: '100.00' creditCardType: type: string description: Card type. nullable: true example: visa enum: - null - visa - mc - discover - amex - diners - other accountType: type: string description: Type of account to which the payment will be deposited. nullable: true enum: - null - bank - undepositedFundsAccount example: bank default: null payInFull: type: boolean description: Pay in full. default: true example: true bankAccountID: type: string description: Bank account record number. nullable: true example: SBME undepositFundsAccountId: type: string description: Undeposit account number nullable: true example: '1070' customerCreditCard: type: object properties: key: type: string description: Customer credit card key. nullable: true example: '10' id: type: string description: Customer credit card id. nullable: true example: Card101 attachment: type: object description: An attachment for invoice. properties: key: type: string description: System-assigned key for the attachment. example: '1' id: type: string description: Unique ID of the attachment. example: Attachment 1 href: type: string description: Endpoint for the attachment. readOnly: true example: /objects/company-config/attachment/1 lines: type: array description: Line items of the invoice. items: $ref: '#/components/schemas/accounts-receivable-recurring-invoice-line' audit: $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' accounts-receivable-posted-over-payment-line: type: object description: AR posted over payment line properties: key: type: string description: System-assigned key for the ar-posted-over-payment-line. readOnly: true example: '23' id: type: string description: AR posted overpayment line ID. readOnly: true example: '23' href: type: string description: URL for the ar-posted-over-payment-line. readOnly: true example: /objects/accounts-receivable/posted-over-payment-line/23 baseCurrency: type: object description: Grouping all the base currency fields. properties: currency: type: string description: Base currency of the company. readOnly: true example: USD amount: type: string description: >- For multi-currency companies, the base amount of the item in the company's base currency. readOnly: true example: '10' totalPaid: type: string description: Total amount paid for the line item. readOnly: true example: '10' totalSelected: type: string description: Total selected for the line item. readOnly: true example: '0' txnCurrency: type: object description: Grouping all the transaction currency fields. properties: currency: type: string description: Transaction currency. readOnly: true example: USD amount: type: string description: >- For payment involving multi-currency, the amount of the item in the currency for the invoice. readOnly: true example: '10' totalPaid: type: string description: Transaction total paid for the line item. readOnly: true example: '10' totalSelected: type: string description: Total transaction selected for the line item. readOnly: true example: '0' description: type: string description: Memo or brief description of the AR posted over payment line item. example: Description for line. exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: string description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: '1.0789' typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' lineNumber: type: number description: Line number of the AR payment line item. readOnly: true example: 1 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of locations to reflect how your company is organized. title: location properties: key: type: string example: '1' id: type: string description: Location ID example: US name: type: string description: Location name example: United States href: type: string readOnly: true example: /objects/company-config/location/4 department: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string example: '98545678' id: type: string description: Department ID example: ENG name: type: string description: Department name example: Engineering href: type: string readOnly: true example: /objects/company-config/department/9 glAccount: type: object properties: key: type: string description: Account key example: '98545678' id: type: string description: Account number example: '100' name: type: string description: GL account title example: Sales href: type: string description: GL account URL readOnly: true bankLocation: type: string description: Base location key. readOnly: true example: '2' arPostedOverPayment: type: object properties: key: type: string description: System-assigned key for the ar-posted-over-payment-line. readOnly: true example: '23' id: type: string description: >- System-assigned id for the ar-posted-over-payment-line. Same as key. readOnly: true example: '23' href: type: string description: URL for the ar-posted-over-payment. readOnly: true example: /objects/accounts-receivable/posted-over-payment/23 readOnly: true audit: $ref: '#/components/schemas/audit' accounts-receivable-posted-over-payment: type: object description: AR posted over payment properties: key: type: string description: System-assigned key for the ar-posted-over-payment. readOnly: true example: '23' id: type: string description: AR posted overpayment ID. readOnly: true example: '23' href: type: string description: URL for the ar-posted-over-payment. readOnly: true example: /objects/accounts-receivable/posted-over-payment/23 recordType: type: string description: Record type. example: ro state: type: string description: State of the AR posted over payment. enum: - null - partiallyApproved - submitted - voided - confirmed - approved - draft - declined - delivered - printVoided - deleted - quickDelivery example: approved paymentMethod: type: string description: Payment method. example: printedCheck enum: - printedCheck - creditCard - eft - cash - ach - manualCheck - checkDelivery default: printedCheck documentNumber: type: string description: Document number, such as a check number. example: '123' description: type: string description: Memo or notes about the AR posted over payment. maxLength: 1000 example: Memo for the line documentId: type: string description: Document ID. example: null paymentDate: type: string format: date description: Payment date. example: '2021-01-23' baseCurrency: type: object description: Grouping all the base currency fields. properties: currency: type: string description: The company's base currency. example: USD totalAmount: type: string description: Total amount. readOnly: true example: '10' totalSelected: type: string description: Total selected. readOnly: true example: '0' totalAmountPaid: type: string description: Total amount paid. readOnly: true example: '10' totalAmountDue: type: string description: Total amount due. readOnly: true example: '0' txnCurrency: type: object description: Grouping all the transaction currency fields. properties: currency: type: string description: The currency in which the payment was made. example: USD totalAmount: type: string description: Total transaction amount format: decimal-precision-2 maxLength: 14 example: '100.0' totalSelected: type: string description: Total transaction amount selected. readOnly: true example: '0' totalPaid: type: string description: Total transaction amount paid. readOnly: true example: '10' totalDue: type: string description: Transaction amount due format: decimal-precision-2 maxLength: 14 example: '100.0' readOnly: true financialAccount: type: string description: Financial account from which the payment will be paid. example: '22334455' receiptDate: type: string format: date description: Receipt date. example: '2021-01-23' cleared: type: string description: Indicates whether the payment has been cleared or matched. example: matched enum: - 'true' - 'false' - matched default: 'false' clearDate: type: string description: Reconciliation date. example: '2021-01-23' arSummary: type: object properties: href: type: string description: URL for the ar-summary. readOnly: true example: /objects/accounts-receivable/summary/23 key: type: string description: System-assigned key for the AR summary. example: '23' id: type: string description: Identifier for the AR summary. Same as key. example: '23' name: type: string description: Name for the AR summary. example: CR01152001 postingDate: type: string description: Posting date. example: '2021-01-23' customer: type: object description: Customer associated with the AR posted over payment. properties: key: type: string description: System-assigned key for the customer. example: '23' entity: type: string description: Customer entity example: C100 readOnly: true id: type: string description: Identifier for the customer. maxLength: 21 example: Cust-1 name: type: string description: Name of the customer. example: Ganesh readOnly: true totalDueAmount: type: string description: Total due for the customer. readOnly: true example: '100.00' href: type: string description: URL for the customer. example: /objects/accounts-receivable/customer/23 readOnly: true exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: string description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: '1.0789' typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' paymentDetails: type: array description: Details for the AR posted over payment. items: $ref: '#/components/schemas/accounts-receivable-payment-detail' lines: type: array description: Line items of the AR posted over payment. items: $ref: '#/components/schemas/accounts-receivable-posted-over-payment-line' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true accounts-receivable-revenue-recognition-templateRequiredProperties: type: object required: - id accounts-receivable-revenue-recognition-template: type: object description: >- Revenue recognition templates define how to amortize deferred revenue. Each template is associated with an Accounts Receivable label or Order Entry Item GL group. properties: key: type: string description: System-assigned key for the revenue recognition template. readOnly: true example: '1' id: type: string description: Unique identifier for the revenue recognition template. example: '1001' href: type: string description: URL for the revenue recognition template. example: /objects/accounts-receivable/revenue-recognition-template/1 readOnly: true description: type: string description: Description of the revenue recognition template. example: null useStandard: type: boolean description: Indicates whether to use standard calendar amortization. example: null default: false schedulePeriod: type: string description: >- The intervals at which Sage Intacct should schedule the journal entries to post. example: daily enum: - daily - monthly - quarterly - semiAnnually - annually postingDay: type: string description: The day of the month the revenue should post. example: endOfPeriod enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - endOfPeriod - daily recognitionTerm: type: string description: Recognition term. example: fixedPeriod enum: - fixedPeriod - contractTerm - project default: fixedPeriod resumeOption: type: string description: System resume option. example: catchUp enum: - catchUp - walkforward default: walkforward totalPeriods: type: string description: >- Number of periods. If `fixedPeriod` is set for `recognitionTerm` Sage Intacct uses this value to generate the schedule. example: null recognitionMethod: type: string description: Recognition method. example: straightLine enum: - straightLine - straightLine,prorateExactDays - straightLine,percentAllocation - straightLine,percentAllocation,endOfPeriod - exactDaysPerPeriod,prorateDays - exactDaysPerPeriod,prorateDays,endOfPeriod - percentCompleted - milestone - custom recognitionStartDate: type: string description: Recognition start date. example: transactionDate enum: - transactionDate - userSpecified default: transactionDate postingMethod: type: string description: Posting method. example: manual enum: - automatic - manual default: manual latestVersion: type: string description: Latest version key. example: null milestoneSource: type: string description: Percent or milestone source. example: manual enum: - manual - project default: manual calculation: type: object properties: source: type: string description: >- For a Percent completed template, select whether to calculate at the project or task level. example: project enum: - null - project - task nullable: true default: null basedOn: type: string description: Method to use to calculate the completion percentage. example: estimatedHours enum: - null - estimatedHours - plannedHours - budgetedHours - budgetedCostFromGL - budgetedCostFromSummary - observed%Completed nullable: true default: null status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' accounts-receivable-revenue-recognition-template-line: type: object description: This object represents line entries in a revenue recognition template. properties: key: type: string description: System-assigned key for the revenue recognition template line entry. readOnly: true example: '23' id: type: string description: >- Revenue recognition template line entry ID. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '23' href: type: string description: URL for the revenue recognition template line entry. readOnly: true example: /objects/accounts-receivable/revenue-recognition-template-line/23 template: type: object description: >- Header level details for the revenue recognition template's line entries. properties: key: type: string description: System-assigned key for the revenue recognition template. example: null id: type: string description: Unique identifier for the revenue recognition template. example: null href: type: string description: URL for the revenue recognition template. readOnly: true periodOffset: type: string description: >- Determines how many periods in the future to create the potential revenue recognition journal entries in the schedule. example: null percentAmount: type: number description: >- Indicates the percentage of the revenue recognition that should be applied to the corresponding account for the corresponding offset period. example: null glAccount: type: object description: GL account associated with the template line entry. properties: href: type: string description: URL for the GL account. readOnly: true example: /objects/general-ledger/account/23 key: type: string description: System-assigned key for the GL account. example: null id: type: string description: GL account number. example: null name: type: string description: GL account title. example: null accounts-receivable-revenue-recognition-template-milestone: type: object description: >- Milestone information for revenue recognition templates that have a recognition method of percent complete, milestone, or custom. properties: key: type: string description: System-assigned key for the revenue recognition template milestone. readOnly: true example: '23' id: type: string description: >- Revenue recognition template milestone ID. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '23' href: type: string description: URL for the revenue recognition template milestone. readOnly: true example: >- /objects/accounts-receivable/revenue-recognition-template-milestone/23 template: type: object description: >- Header level details for the revenue recognition template's milestone entries. properties: key: type: string description: System-assigned key for the revenue recognition template. example: null id: type: string description: Unique identifier for the revenue recognition template. example: null href: type: string description: URL for the revenue recognition template. readOnly: true periodOffset: type: integer description: >- Determines how many periods in the future to create the potential revenue recognition journal entries in the schedule. example: null percentAmount: type: number description: >- Indicates the percentage of the revenue recognition that should be applied to the corresponding account for the corresponding offset period. example: null description: type: string description: Description of the milestone. example: null cash-management-financial-institutionRequiredProperties: type: object required: - id cash-management-financial-institution: type: object properties: key: type: string description: System-assigned key for the financial institution. readOnly: true example: '1' id: type: string description: Unique identifier for the financial institution. example: USA_FinInst name: type: string description: Name of the financial institution. example: USA financial institution addOnServices: type: array items: type: object properties: name: type: string example: MAL serviceContract: type: object properties: key: type: string example: BOA accountType: type: string enum: - checking - savings - creditCard example: checking checkingAccounts: type: array items: type: object properties: key: type: string example: '2' externalBankAccount: type: object properties: id: type: string writeOnly: true example: a421d6c8-ed48-454d-a60e-7b697c67b956 name: type: string writeOnly: true example: Plaid Checking requestedStartDate: type: string format: date writeOnly: true example: '2021-01-23' savingsAccounts: type: array items: type: object properties: key: type: string example: '2' externalBankAccount: type: object properties: id: type: string writeOnly: true example: a421d6c8-ed48-454d-a60e-7b697c67b956 name: type: string writeOnly: true example: Plaid Saving requestedStartDate: type: string format: date writeOnly: true example: '2021-01-23' creditCards: type: array readOnly: true items: type: object properties: key: type: string example: '2' externalBankAccount: type: object properties: id: type: string writeOnly: true example: a421d6c8-ed48-454d-a60e-7b697c67b956 name: type: string writeOnly: true example: Plaid CC requestedStartDate: type: string format: date writeOnly: true example: '2021-01-23' totalAccounts: type: integer description: Total number of accounts associated readOnly: true example: 5 href: type: string readOnly: true example: /objects/cash-management/financial-institution/1 cash-management-bank-account: type: object description: This object provides information about a bank account. properties: key: type: string description: System-assigned key for the bank account. readOnly: true example: '1' id: type: string description: Unique identifier for the bank account. readOnly: true example: BOA-Checking referenceKey: type: string description: Reference key for the bank account. readOnly: true example: '90' name: type: string description: Name of the bank account. readOnly: true example: BOA checking account currency: type: string description: >- The currency for this account. The default is the base currency for the company or entity. If this account is with a foreign bank, the currency should match the country. example: USD accountType: type: string description: Type of bank account. readOnly: true enum: - checking - savings - creditCard example: checking connectionStatus: type: string description: Bank feed connection status of the account. enum: - null - notConnected - connectionRequested - inProgress - pending - pendingConfirmation - connected - authRequired - verifyingAuth - inactiveFeed - inactiveClient - cancelled - invalid - canceling - disconnecting readOnly: true example: connected nullable: true supportMultiAccountLinking: type: boolean description: Indicates whether the account supports multi-account linking. readOnly: true default: true example: true financialInstitution: description: Financial institution where the account is held. type: object properties: id: type: string readOnly: true example: '1' key: type: string readOnly: true example: '1' href: type: string readOnly: true example: /objects/cash-management/financial-institution/1 readOnly: true href: type: string description: URL for the bank account. readOnly: true example: /objects/cash-management/bank-account/1 cash-management-checking-accountRequiredProperties: type: object required: - id - location properties: bankAccountDetails: type: object required: - bankName - currency accounting: type: object required: - glAccount timezone: type: string description: Time zone nullable: true enum: - null - GMT (Greenwich Mean Time) Dublin, Edinburgh, London - GMT+00:00 Western Europe Time - GMT+01:00 Western Europe Summer Time - GMT+01:00 British Summer Time - GMT+01:00 Irish Summer Time - GMT+01:00 Central Europe Time - GMT+01:00 Berlin, Stockholm, Rome, Bern, Brussels - GMT+01:00 Lisbon, Warsaw - GMT+01:00 Paris, Madrid - GMT+01:00 Prague - GMT+02:00 Central Europe Summer Time - GMT+02:00 Eastern Europe Time - GMT+02:00 Athens, Helsinki, Istanbul - GMT+02:00 Cairo - GMT+02:00 Harare, Pretoria - GMT+02:00 Israel - GMT+03:00 Eastern Europe Summer Time - GMT+03:00 Baghdad, Kuwait, Nairobi, Riyadh - GMT+03:00 Moscow, St. Petersburg, Volgograd - GMT+03:30 Tehran - GMT+04:00 Moscow Summer Time - GMT+04:00 Abu Dhabi, Muscat, Tbilisi, Kazan - GMT+04:30 Kabul - GMT+05:00 Islamabad, Karachi, Sverdlovsk, Tashkent - GMT+05:30 Bombay, Calcutta, Madras, New Delhi - GMT+06:00 Almaty, Dhaka - GMT+07:00 Bangkok, Jakarta, Hanoi - GMT+08:00 Beijing, Chongqing, Urumqi - GMT+08:00 Hong Kong SAR, Perth, Singapore, Taipei - GMT+08:00 (Australian) Western Standard Time - GMT+09:00 Tokyo, Osaka, Sapporo, Seoul, Yakutsk - GMT+09:30 (Australian) Central Standard Time - GMT+10:30 (Australian) Central Daylight Time - GMT+09:30 Adelaide - GMT+09:30 Darwin - GMT+10:00 Brisbane, Melbourne, Sydney - GMT+10:00 Guam, Port Moresby - GMT+10:00 Vladivostok - GMT+10:00 (Australian) Eastern Standard Time - GMT+11:00 (Australian) Eastern Daylight Time - GMT+12:00 Fiji Islands, Marshall Islands - GMT+12:00 Kamchatka - GMT+12:00 Magadan, Solomon Islands, New Caledonia - GMT+12:00 Wellington, Auckland - GMT+13:00 Nuku`alofa - GMT+13:00 Samoa - GMT-01:00 Azores, Cape Verde Island - GMT-03:00 Brasilia - GMT-03:00 Buenos Aires, Georgetown - GMT-03:30 Newfoundland Standard Time - GMT-02:30 Newfoundland Daylight Time - GMT-04:00 Atlantic Standard Time - GMT-03:00 Atlantic Daylight Time - GMT-04:00 Caracas, La Paz - GMT-05:00 Bogota, Lima - GMT-05:00 Eastern Standard Time - GMT-04:00 Eastern Daylight Saving Time - GMT-05:00 Indiana (East) - GMT-06:00 Central Standard Time - GMT-05:00 Central Daylight Saving Time - GMT-06:00 Mexico City, Tegucigalpa - GMT-06:00 Saskatchewan - GMT-07:00 Arizona - GMT-07:00 Mountain Standard Time - GMT-06:00 Mountain Daylight Saving Time - GMT-08:00 Pacific Standard Time - GMT-07:00 Pacific Daylight Saving Time - GMT-09:00 Alaska Standard Time - GMT-08:00 Alaska Standard Daylight Saving Time - GMT-10:00 Hawaii - GMT-11:00 Midway Island, Samoa - GMT-12:00 Eniwetok, Kwajalein banking-cloud-connection: type: object properties: name: type: string description: Name of the connected bank account readOnly: true example: Plaid Checking bankName: type: string description: Name of the connected bank readOnly: true example: Bank of America status: type: string description: Connected bank status enum: - null - notConnected - connectionRequested - inProgress - pending - pendingConfirmation - connected - authRequired - verifyingAuth - inactiveFeed - inactiveClient - canceled - invalid - canceling - disconnecting readOnly: true example: connected nullable: true lastBankTxnDateTime: type: string format: date-time description: Date of the last bank transaction received readOnly: true example: '2014-01-08T11:28:12Z' lastRefreshedDateTime: type: string format: date-time description: Date of the last attempt of fetching bank transactions readOnly: true example: '2014-01-08T11:28:12Z' refreshStatus: type: string description: Current status Of fetching bank transaction enum: - null - queued - refreshing - success - partialSuccess - failure example: queued readOnly: true nullable: true default: null supportMultiAccountLinking: type: boolean description: Does account support multi account linking readOnly: true example: true default: true cash-management-checking-account: type: object properties: key: type: string description: System-assigned key for the checking account. readOnly: true example: '2' id: type: string description: >- Name or other unique identifier for the checking account. The ID cannot be modified. example: BOA bankAccountDetails: type: object description: Bank account details properties: accountNumber: type: string description: Bank account number for this checking account. example: '4356789402' bankName: type: string description: Name of the bank for this checking account. example: Bank of America accountHolderName: type: string description: >- The official name that the bank has on file for this checking account. maxLength: 100 example: ABC Software routingNumber: type: string description: Routing number for this checking account. example: '121000358' branchId: type: string description: Bank branch ID for this checking account. example: '89099' phoneNumber: type: string description: Phone number of the bank branch. example: '5559878978' currency: type: string description: >- The currency for this account. The default is the base currency for the company or entity. If this account is with a foreign bank, the currency should match the country. example: USD bankAddress: type: object properties: city: type: string description: City where the bank is located. example: Newark state: type: string description: State where the bank is located. example: CA postCode: type: string description: Zip or postal code for the bank. example: '94560' country: type: string description: Country where the bank is located. example: United States addressLine1: type: string description: Line 1 of the street address for the bank. example: 36900 Neward Blvd addressLine2: type: string description: Line 2 of the street address for the bank. example: Suite 101 addressLine3: type: string description: >- Line 3 of the street address for the bank which provides additional geographical information. example: Western industrial area accounting: type: object description: Accounting Information properties: glAccount: type: object description: >- General Ledger account that this checking account is associated with. properties: key: type: string example: '256' id: type: string example: 9899--My Ledger Account-33 href: type: string readOnly: true example: /objects/general-ledger/account/256 apJournal: type: object description: Default payables GL journal properties: key: type: string description: System-assigned key for the gl-journal. example: '3' id: type: string description: The id of the journal example: AP ADJ--AP Adjustment Journal href: type: string description: URL for this journal. example: /objects/general-ledger/journal/3 readOnly: true arJournal: type: object description: Default receivables GL journal properties: key: type: string description: System-assigned key for the gl-journal. example: '3' id: type: string description: The id of the journal example: AR ADJ--AR Adjustment Journal href: type: string description: URL for this journal. example: /objects/general-ledger/journal/3 readOnly: true disableInterEntityTransfer: type: boolean description: >- Exclude this account from inter-entity transfers (IET) even if IET is globally enabled for the entire multi-entity shared structure of companies. default: false example: false serviceChargeGLAccount: type: object description: >- General ledger account for service charges. Used for reconciliation. properties: key: type: string example: '432' id: type: string example: 0077--My Ledger Account 54 href: type: string readOnly: true example: /objects/general-ledger/account/432 serviceChargeAccountLabel: type: object description: General ledger account label for service charges. properties: key: type: string example: '15' id: type: string example: Car Payment href: type: string readOnly: true example: /objects/accounts-payable/account-label/15 interestGLAccount: type: object description: >- General ledger account for earned interest. Used for reconciliation. properties: key: type: string example: '419' id: type: string example: 0099--My Ledger Account 40 href: type: string readOnly: true example: /objects/general-ledger/account/419 interestAccountLabel: type: object description: General ledger account label for earned interest. properties: key: type: string example: '35' id: type: string example: Sales href: type: string readOnly: true example: /objects/accounts-receivable/account-label/35 bankingTimeZone: allOf: - $ref: '#/components/schemas/timezone' - type: string nullable: true default: null example: GMT+02:00 Eastern Europe Time reconciliation: type: object description: Reconciliation information properties: lastReconciledBalance: type: string description: Last reconciled balance. format: decimal-precision-2 readOnly: true example: '8970.98' lastReconciledDate: type: string format: date description: Date of the last reconciliation. readOnly: true example: '2019-03-22' cutOffDate: type: string format: date description: The date after which initial reconciliation can begin. readOnly: true example: '2018-01-01' inProgressBalance: type: string description: In-progress reconciliation balance. format: decimal-precision-2 readOnly: true example: '-221021.61' inProgressDate: type: string format: date description: In-progress reconciliation date. readOnly: true example: '2023-01-05' matchSequence: type: object description: Reconciliation match sequence properties: key: type: string description: System-assigned key for the document sequence number. example: '2' nullable: true id: type: string description: Document sequence ID example: 2--Bank sequence Id nullable: true href: type: string description: URL for the sequence number. readOnly: true example: /objects/company-config/document-sequence/2 nullable: true useMatchSequenceForAutoMatch: type: boolean default: true description: Use sequence number for automatically matched transactions. example: false useMatchSequenceForManualMatch: type: boolean default: true description: Use sequence number for manually matched transactions. example: false checkPrinting: type: object properties: disablePrinting: type: boolean default: false description: Disable check printing for this account. example: false addressSettings: type: object description: Address settings for check printing. properties: printAddress: type: boolean default: false description: >- Set to true to print an address on checks. Set to false if using pre-printed check stock that already includes the address, or if you don't want to include an address. example: false addressToPrint: type: string description: > Specifies the address to print on checks. **Valid values:** - Set to `company` to use the address set for the company. - Set to `custom` to use the address defined in the `name` and `address` fields. enum: - null - company - custom nullable: true default: null example: company name: type: string description: >- Company name to print on checks if `addressToPrint` is set to `custom`. maxLength: 100 example: Zine Inc. address: type: object description: >- Address to print on checks if `addressToPrint` is set to `custom`. properties: addressLine1: type: string description: Line 1 of the address. example: 75688 Post st addressLine2: type: string description: Line 2 of the address. example: East Gwalopak addressLine3: type: string description: Line 3 of the address. example: '456' city: type: string description: City example: San Ramon state: type: string description: State example: CA postCode: type: string description: Zip or postal code. example: '94536' country: type: string description: Country example: United States countryCode: type: string description: >- ISO country code. When ISO country codes are enabled for a company, both country and countryCode must be provided. example: US phone: type: string description: Phone number maxLength: 30 example: '6609336532' printLogo: type: boolean default: false description: >- Set to `true` to print company logo on checks. A logo image file must be uploaded through the Sage Intacct user interface. example: false signatures: type: object description: Uploaded signature images to print on checks. properties: firstSignature: type: string description: First signature file name. example: sigimg1_j.jpg limitForFirstSignatureAmount: type: string format: decimal-precision-2 description: >- Print first signature only for checks that are for less than this amount. A blank line for manual signature is printed for checks greater than this amount or if `limitForFirstSignatureAmount` is null. example: '50.00' useSecondSignature: type: boolean default: false description: >- Include second signature on qualifying checks. Set to `false` to always show just one signature. example: true secondSignature: type: string description: Second signature file name. example: sigimg2_j.jpg limitForSecondSignatureAmount: type: string format: decimal-precision-2 description: >- Prints second signature only for checks that are for less than this amount. A blank line for manual signature is printed for checks greater than this amount. example: '60.00' thresholdForSecondSignatureAmount: type: string format: decimal-precision-2 description: >- Print second signature only for checks that are for more than this amount. example: '60.00' printSettings: type: object properties: printOn: type: string description: > Check stock to print on for this account. **Valid values:** - Set to `prePrintedCheckStock` to use check paper that is pre-printed with company information. - Set to `blankCheckStock` to use blank check paper. enum: - prePrintedCheckStock - blankCheckStock example: blankCheckStock default: blankCheckStock nextCheckNumber: type: string description: > Enter a starting check number. For example, 1001. The check number increments by 1 for each succeeding check. maxLength: 10 pattern: ^[0-9]{1,10}$ example: '1012' nullable: true printingFormat: type: string description: > Printing format. **Valid values** - `standard` - For pre-printed checks that already show the bank account number, routing number, and check numbers. This printing format is not available for CAD checking accounts. - `business` - Prints amounts in a font that makes alterations difficult. - `highSecurity` - Same as `Standard`, plus features that reduce fraud related to check washing, forgery, and copying. This printing format is not available for CAD checking accounts. - `cadCheck` - Prints checks with dates formatted for Canadian companies. Can be used with CAD and USD checking accounts. - `jpmorganChaseBusiness` - Prints checks for JPMorgan Chase Business. - `jpmorganChaseStandard` - Prints checks for JPMorgan Chase Standard. enum: - standard - business - highSecurity - cadCheck - jpmorganChaseBusiness - jpmorganChaseStandard example: standard default: standard paperFormat: type: string description: > Sets the location for check printing on three-part forms: top, middle, or bottom panel. Pre-printed check stock is only compatible with the top and middle printing position. Canadian check stock is only compatible with the top printing position. enum: - top - middle - bottom example: top default: top printLineItems: type: boolean description: > Set to true to include additional fields in the non-remittance panel of checks. These fields include columns for the account, department, and location of each line item. A check can include up to 18 line items per page in either summary or detail mode. default: false example: true printLocation: type: string description: > The location information to include on checks. **Valid values** - `id` - Print only the location ID in the location column. - `name` - Print only the location name in the location column. - `both` - (default) Print both the location ID and the location name. enum: - id - name - both example: id default: id additionalText: type: string description: Additional text to print under the signatures. example: Pay to check holder nullable: true numberOfChecksInPreview: type: string description: Number of checks per page. enum: - null - one - three example: one nullable: true default: null micrSettings: type: object description: >- Magnetic Ink Character Recognition (MICR) settings. Use these settings if your bank requires special alignment of the account number on your check. properties: accountNumberAlignment: type: string description: Bank account number alignment in the MICR. enum: - left - right example: right default: right accountNumberPositioning: type: integer description: >- Number of spaces to append before or after the bank account portion of the MICR. example: 1 nullable: true minCheckNumberLength: type: string description: >- Set this value to pad short check numbers with zeros. The minimum number of digits is 6. example: '6' nullable: true regionalSettings: type: object description: >- Regional settings for Magnetic Ink Character Recognition (MICR). properties: printCode45: type: boolean default: false description: >- Set to true to print transaction code 45 on the MICR line. example: true printUSFundsUnderCheckAmount: type: boolean default: false description: >- Set to true to print US funds under the check amount box for CPA member banks. example: true printOnUsSymbol: type: boolean default: false description: >- Set to true to print the ON-US symbol in front of the account number. example: true positionOfOnUsSymbol: type: string description: >- Position of the ON-US symbol. To position the symbol before the checking account number, set to `position31` or `position32`. enum: - position31 - position32 example: position31 default: position31 department: type: object description: Department to use for GL posting (optional). properties: key: type: string example: '9' id: type: string example: 11--Accounting href: type: string readOnly: true example: /objects/company-config/department/9 location: type: object description: Location to use for GL posting (optional). properties: key: type: string example: '1' id: type: string example: 1--United States of America href: type: string readOnly: true example: /objects/company-config/location/1 status: $ref: '#/components/schemas/status' ach: type: object description: Automated clearing house details. properties: enableACH: type: boolean description: >- Set to true to enable your account to make standard ACH or American Express ACH Payment Services payments. default: false example: true bankId: type: string description: The ID of the bank record associated with this bank account. example: BOA_ACH companyName: type: string description: The company name specified in the ACH bank record. maxLength: 16 example: Ventura companyIdentification: type: string description: The 10-digit company ID as specified in the ACH bank record. maxLength: 10 pattern: ^[\w\s_\-\.]{0,20}$ example: Ventura originatingFinancialInstitution: type: string description: >- The first 8 digits of your bank's routing number, as specified in the ACH bank record. maxLength: 8 pattern: ^[0-9]{1,8}$ example: '89096789' companyEntryDescription: type: string description: Optional text that can be included with ACH payments. maxLength: 10 example: Investmant companyDiscretionaryData: type: string description: >- Up to 20 characters of additional information. Typically this will consist of codes that describe any special handling of entries. These codes will be unique to each bank. maxLength: 20 example: '89078900' useRecommendedSetup: type: boolean description: >- Set to true to enable Intacct to generate the most common type of ACH payment file (service class code 220) and automatically set up numbering sequences for standard ACH payments. default: false example: true recordTypeCode: type: string description: Record type code maxLength: 1 default: '5' readOnly: true example: '5' serviceClassCode: type: string description: >- Service class code. Most banks expect to receive files that use code `220` which contain only payments (credits). If your bank requires code `200`, to allow both credits and debits, `useRecommendedSetup` must be false. enum: - null - '220' - '200' nullable: true default: null example: '220' originatorStatusCode: type: string description: Originator status code default: '1' readOnly: true maxLength: 1 pattern: ^[0-9]{1}$ example: '6' batchId: type: string description: >- Required if `useRecommendedSetup` is false. Unique numbering sequence used to automatically number payment batches. Numbers must be 7 digits with no prefixes or suffixes. example: BOA_ACH_BatchNo traceNumberSequence: type: string description: >- Required if `useRecommendedSetup` is false. Created by concatenating the bank's routing number with a unique numbering sequence. Numbers must be 7 digits with no prefixes or suffixes. example: BOA_ACH_TraceNo paymentNumberSequence: type: string description: >- Required if `useRecommendedSetup` is false. You can create a unique payment number sequence to post confirmed AP payments. Or, you can use the same number sequence you set for the trace number. example: CONTINVOICE useTraceNumber: type: string description: Use trace number. enum: - null - useAsPayment - useNumberingSequence nullable: true default: useAsPayment example: useAsPayment bankFile: type: object description: >- Bank file set up for companies subscribed to Sage Cloud Services and enabled for bank file payments. A bank file is a standard file used by banks to make multiple payments. properties: enableBankFile: type: boolean description: Set to true to enable bank file payments to vendors. default: false example: true bankFileFormat: type: string description: >- Bank file format of the bank associated with this checking account. Valid values depend on the country. See [About bank files](https://www.intacct.com/ia/docs/en_US/help_action/Cash_Management/Banking_and_Payment_Cloud/Bank_files/bank-file-payment.htm) for more information. example: ABA - Westpac bankCode: type: string description: Bank code for the bank associated with this checking account. example: Westpac Banking Corporation apcaNumber: type: string description: >- The unique six-digit number used by Australian banks that identifies the company or individual making direct payments. example: '865551' bsbNumber: type: string description: >- The six-digit number used to identify the particular branch of an Australian bank, three digits, followed by a hyphen, and three more digits. example: 042-457 sunNumber: type: string description: >- Optional service user number for UK banks, which is a unique ID for organizations that collect payment with bank files. The service user number, together with the bank file, creates a record of the transaction. example: '6789' sortCode: type: string description: >- Sort code for UK banks. This is a 6-digit number that identifies the bank and branch where the checking account is held. This field is only displayed for those banks that require it. maxLength: 10 nullable: true example: 23-44-16 seedValue: type: string description: >- Seed value for South African banks. The 32-character NedBank seed value for the account from which payments are made. maxLength: 40 nullable: true example: ABFGHETOUFEH1234IOIADRTO78DD899 userReference: type: string description: User reference maxLength: 10 nullable: true example: USER123 clientCode: type: string description: Client user code maxLength: 10 nullable: true example: ProLite serviceType: type: string description: Type of service maxLength: 10 nullable: true example: PAYMENT originatorId: type: string description: Originator Identification Number maxLength: 20 example: IE26SCT803015 businessIdCode: type: string description: Business Identifier Code maxLength: 20 example: BOFIIE2DXXX processingDataCenterCode: type: string maxLength: 5 description: >- 5 digit originating direct clearer's allocated data centre ID number. example: '01674' debtorBankNumber: type: string maxLength: 3 description: >- This is the settlement institutional bank (processing bank) number. example: '674' branchTransitNumber: type: string maxLength: 5 description: >- This is the settlement institutional bank (processing bank) branch transit number. example: '43876' returnAccountNumber: type: string maxLength: 12 description: Return account number. example: IE26SCT80301 messageIdPrefix: type: string maxLength: 23 description: > This is the creditor’s unique identifier of the submitted file, the messageIdPrefix naming convention is customer defined prefix text (length 23 chars) and then, followed by 12 numbers made up with the date and time to make it unique (auto generated). Prefix message identifier is specific to Bank of Ireland SEPA bank file format. example: SEPA240212 audit: $ref: '#/components/schemas/audit' readOnly: true bankingCloudConnection: $ref: '#/components/schemas/banking-cloud-connection' financialInstitution: description: financial-institutionref type: object properties: id: type: string readOnly: true example: '1' key: type: string readOnly: true example: Fintte4 href: type: string readOnly: true example: /objects/cash-management/financial-institution/1 readOnly: true ruleSet: type: object description: Applied rule set properties: key: type: string example: '36' id: type: string example: 36--RuleSetToMatch href: type: string readOnly: true example: /objects/cash-management/bank-txn-rule-set/2 restrictions: type: object description: >- Restrict a bank account to a specfic location or restrict one or more entity/locations to a specific account. properties: restrictionType: type: string description: > Set which entities/locations within the company can access and use this checking account. **Valid values** - `unrestricted` - (default) This account is available to the top-level company and all entity-level locations. - `rootOnly` - Only the top-level company of a multi-entity structure can access this account. - `restricted` - Only specified locations, location groups, departments, or department groups can access this account. enum: - unrestricted - rootOnly - restricted example: unrestricted default: unrestricted locations: type: array description: >- List of location ids that can access this checking account when `restrictionType` is set to `restricted`. items: type: string example: - 1--United States of America - 2--United Kingdom paymentProviderBankAccounts: type: array items: $ref: '#/components/schemas/cash-management-payment-provider-bank-account' cash-management-depositRequiredProperties: type: object required: - txnDate - bankAccount properties: details: type: array items: required: - id cash-management-deposit-line: type: object description: Line items in a deposit represent payments received from customers. properties: key: type: string description: System-assigned key for the deposit line item. readOnly: true example: '101' id: type: string description: ID for the deposit line item. Same as `key` for this object. readOnly: true example: '101' amount: type: string format: decimal-precision-2 readOnly: true description: Base amount of the payment. example: '100.99' txnAmount: type: string format: decimal-precision-2 readOnly: true description: Transaction amount of the payment. example: '100.99' description: type: string readOnly: true description: Optional description for the line item. example: Deposit from other receipt 101 currency: type: object description: Currency details for the deposit line item. properties: baseCurrency: type: string description: Base currency for the company. readOnly: true example: USD txnCurrency: type: string description: Transaction currency for the company. readOnly: true example: GBP exchangeRate: type: object title: exchangeRate description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' baseLocation: type: object description: Location assigned to the deposit. allOf: - $ref: '#/components/schemas/location-ref' - type: object properties: key: type: string description: Base location key. example: '4' arAccountLabel: type: object readOnly: true description: Label for the AR account associated with the line item. properties: key: type: string readOnly: true description: System-assigned key for the account label. example: '10' id: type: string readOnly: true description: ID for the account label. example: '10' label: type: string readOnly: true description: AR account label example: SALES href: type: string description: URL endpoint for the account label. readOnly: true example: /objects/accounts-receivable/account-label/102 glAccount: type: object description: General Ledger (GL) account for the deposit line item. readOnly: true properties: key: type: string description: System-assigned key for the GL account. readOnly: true example: '9' id: type: string description: Identifier for the GL account. readOnly: true example: '9' accountNumber: type: string description: Number of the GL account. readOnly: true example: '9010' name: type: string description: Name of the GL account. readOnly: true example: Service Payments href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/102 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of locations to reflect how your company is organized. title: location properties: key: type: string description: System-assigned key for the location. example: '4' id: type: string description: Unique identifier of the location. example: AU name: type: string description: Name of the location. readOnly: true example: Australia href: type: string description: Endpoint URL for the location. readOnly: true example: /objects/company-config/location/4 department: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string description: System-assigned key for the department. example: '9' id: type: string description: Unique identifier of the department. example: '01' name: type: string description: Name of the department. readOnly: true example: Accounting href: type: string description: Endpoint URL for the department. readOnly: true example: /objects/company-config/department/9 deposit: type: object description: Header level details for the deposit's line entries. readOnly: true properties: key: type: string description: System-assigned key for the deposit. readOnly: true example: '10' id: type: string description: ID for the deposit. readOnly: true example: '10' depositType: type: string description: Record type for the deposit. readOnly: true example: cr href: type: string description: Endpoint URL for the deposit. readOnly: true example: /objects/cash-management/deposit/10 status: readOnly: true $ref: '#/components/schemas/status' audit: readOnly: true $ref: '#/components/schemas/audit' cash-management-deposit-detail: type: object description: >- Deposit detail contains the deposit information related to the parent deposit. properties: key: type: string description: System-assigned key for the deposit-detail. example: '23' id: type: string description: Deposit details ID. example: '23' href: type: string description: Endpoint for the deposit-detail. readOnly: true example: /objects/cash-management/deposit-detail/23 summary: type: string description: Summary. readOnly: true example: 'Cash Management Transactions: 2022/04/08 Batch' customer: type: object description: Customer associated with the deposit. readOnly: true properties: key: type: string description: System-assigned key for the customer. readOnly: true example: '23' id: type: string description: Identifier for the customer. readOnly: true maxLength: 21 example: Cust-1 name: type: string description: Name of the customer. readOnly: true example: Peter Hansen href: type: string description: URL for the customer. example: /objects/accounts-receivable/customer/23 readOnly: true payee: type: string description: Payee. readOnly: true example: Alter Windows Inc totalEntered: type: string format: decimal-precision-2 description: Base amount. readOnly: true example: '100.99' txnTotalEntered: type: string format: decimal-precision-2 description: Transaction amount. readOnly: true example: '100.99' currency: type: string description: Transaction currency. readOnly: true example: USD paymentMethod: type: string description: Payment method. readOnly: true example: cash enum: - check - chargeCard - onlineChargeCard - recordTransfer - cash documentNumber: type: string description: Transaction number. readOnly: true example: Check 0019 state: type: string description: Deposit state. readOnly: true example: undeposited enum: - undeposited - deposited deposit: type: object description: Header level details for the deposit details. readOnly: true properties: key: type: string description: System-assigned key for the deposit. readOnly: true example: '10' id: type: string description: ID for the deposit. readOnly: true example: '10' href: type: string readOnly: true example: /objects/cash-management/deposit/10 status: readOnly: true $ref: '#/components/schemas/status' audit: readOnly: true $ref: '#/components/schemas/audit' cash-management-deposit: type: object description: Transaction record for a deposit. properties: key: type: string description: System-assigned key for the deposit. readOnly: true example: '1234' id: type: string description: Identifier for the deposit object. Same as `key` for this object. example: '1234' depositId: type: string description: >- ID to correlate the deposit transaction record with the actual deposit slip from the bank. example: Deposit slip 09/21/2023 txnDate: type: string format: date example: '2023-09-21' description: Date when the transaction occurred. description: type: string description: Description of the deposit. example: Cash deposit for online service baseCurrency: type: string description: For multi-currency companies, the base currency for the company. readOnly: true example: USD txnCurrency: type: string description: >- For multi-currency companies, the transaction currency for the bank deposit. readOnly: true example: USD totalEntered: type: string format: decimal-precision-2 description: Total base amount of the deposit. readOnly: true example: '100.99' txnTotalEntered: type: string format: decimal-precision-2 description: Total transaction amount of the deposit. readOnly: true example: '100.99' state: type: string description: State of the deposit. readOnly: true example: void enum: - null - void nullable: true default: null reconciliationState: type: string description: Indicates whether the deposit has been cleared or matched. example: cleared enum: - cleared - uncleared - matched default: uncleared readOnly: true bankAccount: type: object description: Bank account in which to make the deposit. properties: key: type: string description: System-assigned key for the bank account. example: '1' id: type: string description: Account number or other unique identifier for the bank account. example: BOA name: type: string description: Name of the bank account. example: Bank of America href: type: string description: URL endpoint for the bank account. readOnly: true example: /objects/cash-management/bank-account/1 reversalDate: type: string format: date example: '2021-09-23' description: Date transaction reversal started. readOnly: true reversedDate: type: string format: date example: '2021-09-23' description: Date transaction was reversed. readOnly: true reversedVoidPaymentKey: type: string description: System-assigned key to uniquely identify reversed voided payments. readOnly: true example: '1235' voidPaymentKey: type: string description: System-assigned key to uniquely identify voided payments. readOnly: true example: '1236' attachment: type: object description: Supporting document attached to the deposit. properties: key: type: string description: System-assigned key for the supporting document. example: '18' id: type: string description: System-assigned ID for the supporting document. example: '18' href: type: string description: URL endpoint for the supporting document. readOnly: true example: /objects/company-config/attachment/18 lines: type: array description: Line items for the deposited receipts. items: readOnly: true $ref: '#/components/schemas/cash-management-deposit-line' details: type: array description: Funds that are part of this deposit. items: $ref: '#/components/schemas/cash-management-deposit-detail' audit: readOnly: true type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true cash-management-other-receiptRequiredProperties: type: object required: - payer - txnDate - depositDate - txnPaidDate - paymentMethod - bankAccount properties: lines: type: array items: type: object required: - txnAmount - glAccount tax-entries: description: Tax Entries for line items type: object properties: key: type: string description: System-assigned key of the Tax Entry. example: '7149' readOnly: true id: type: string description: Unique identifier of the Tax Entry. example: '7149' readOnly: true baseTaxAmount: type: string description: Base tax amount format: decimal-precision-2 example: '100.00' txnTaxAmount: type: string description: Transaction tax amount format: decimal-precision-2 example: '100.00' taxRate: type: number description: Tax rate example: 1.0299 cash-management-other-receipt-tax-entry: type: object description: Other receipt tax entry allOf: - $ref: '#/components/schemas/tax-entries' - type: object properties: taxDetail: type: object description: >- Order Entry tax details describe a specific type of tax that applies to lines in Accounts Receivable and Order Entry transactions. 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: Alaska Tax Detail href: type: string description: URL of the tax detail object. readOnly: true example: /objects/tax/order-entry-tax-detail/1 otherReceiptLine: title: otherReceiptLine type: object properties: id: type: string description: Identifier for the other receipt line object. example: '100' readOnly: true key: type: string description: System-assigned key for the other receipt line object. example: '100' readOnly: true href: type: string description: URL for the other receipt line object. readOnly: true example: /objects/cash-management/other-receipt-line/100 cash-management-other-receipt-line: type: object description: >- Line items in an other receipts object represent transactions that are not associated with a customer or invoice. properties: key: type: string description: System-assigned key for the other receipts line item. readOnly: true example: '123' id: type: string description: Identifier for the other receipts line item. readOnly: true example: '123' href: type: string description: URL for the other receipts line item. readOnly: true example: /objects/cash-management/other-receipt/10 amount: type: string format: decimal-precision-2 description: For single-currency companies, amount of the line item receipt. example: '100.99' totalTxnAmount: type: string format: decimal-precision-2 description: For multi-currency companies, amount of the line item receipt. example: '100.99' txnAmount: type: string format: decimal-precision-2 description: For multi-currency companies, amount of the line item receipt. example: '100.99' description: type: string description: Description of the other receipts line item. example: Cash receipt for rental invoice account 101 exchangeRate: type: object description: Exchange rate used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: number 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' lineNumber: type: integer description: Line number for the other receipts line item. example: 1 baseCurrency: type: string description: For multi-currency companies, the company's base currency. readOnly: true example: USD currency: type: string description: For multi-currency companies, the currency for the transaction. readOnly: true example: USD isTax: type: boolean description: Indicates whether the line item amount includes taxes. example: false default: false arAccountLabel: type: object description: Label for the account associated with the line item. properties: key: type: string description: System-assigned key for the account label. example: '102' id: type: string description: ID for the account label. example: SW Sales href: type: string description: URL for the account label. readOnly: true example: /objects/araccountlabel/102 glAccount: type: object description: GL account for the line item. properties: key: type: string description: System-assigned key for the GL account. example: '55' id: type: string description: Unique identifier for the GL account. example: '1001' href: type: string description: URL for the GL account. readOnly: true example: /objects/glaccount/55 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: Location associated with this line item. properties: key: type: string description: System-assigned key for the location. example: '5' id: type: string description: Location ID example: CAHO name: type: string description: Location name example: California Head Office href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/5 department: type: object description: Department associated with the line item. properties: key: type: string description: System-assigned key for the department. example: '10' id: type: string description: Unique identifier for the department. example: ENGINEERING number: type: string description: Department number example: '10' name: type: string description: Department name example: Engineering department href: type: string description: URL for the department. readOnly: true example: /objects/company-config/department/10 otherReceipts: type: object description: Header level details for the other receipts object's line entries. properties: key: type: string description: System-assigned key for the other receipts object. readOnly: true example: '100' id: type: string description: Identifier for the other receipts object. readOnly: true example: '100' recordType: type: string description: Record type of the other receipts object. readOnly: true example: cr href: type: string description: URL for the other receipts object. readOnly: true example: /objects/cash-management/other-receipt/5 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' taxEntries: type: array description: Tax Entries of the other receipt items: $ref: '#/components/schemas/cash-management-other-receipt-tax-entry' cash-management-other-receipt: type: object description: >- Other receipts are receipts that are not associated with a customer or invoice. Other receipts can include cash, a card charge, a cash transfer, or a check payment. properties: key: type: string description: System-assigned key for the other receipts object. readOnly: true example: '1299' id: type: string description: >- Identifier for the other receipts object. This value is the same as key for this object and can be ignored. Use key for all references to this object. readOnly: true example: '1299' recordType: type: string description: Record type for the other receipts object. readOnly: true example: cr payer: type: string description: Name of the payer. example: Benson Hugo txnDate: type: string format: date description: >- Date of the transaction. Typically, this is the check date, but can be the date of a credit card, record transfer, or cash transaction. example: '2021-01-23' txnPaidDate: type: string format: date description: Date the transaction was paid. example: '2021-01-23' txnNumber: type: string description: Transaction number. example: '22365' description: type: string description: Description of the other receipts object. example: Refund for overpayment arSummary: type: object description: AR summary in which the other receipts transaction is included. properties: key: type: string description: System-assigned key for the AR summary. example: '100' id: type: string description: Identifier for the AR summary. example: '100' date: type: string format: date description: Summary date. example: '2023-10-10' href: type: string description: URL for the AR summary. readOnly: true example: /objects/accounts-receivable/summary/10 baseCurrency: type: string description: For multi-currency companies, the company's base currency. example: USD currency: type: string description: For multi-currency companies, the currency for the transaction. example: USD totalEntered: type: string format: decimal-precision-2 description: Total base amount entered. example: '100.99' readOnly: true txnTotalEntered: type: string format: decimal-precision-2 description: Total transaction amount entered. example: '100.99' readOnly: true reconciliationDate: type: string format: date description: Reconciliation date for the payment. example: '2021-01-23' state: type: string description: State of the other receipts. example: approved enum: - approved - reversed - reversal - reconciled - deposited reconciliationState: type: string description: Indicates whether the receipts have been cleared or matched. example: cleared enum: - cleared - uncleared - matched default: uncleared parentDeposit: type: object description: Parent deposit payment. properties: href: type: string description: URL for the parent deposit. readOnly: true example: /objects/cash-management/deposit/3319 key: type: string description: System-assigned key for the parent deposit. example: '3319' id: type: string description: Identifier for the parent deposit. example: '3319' isInclusiveTax: type: boolean description: >- Set to `true` if the amount for each line item already includes taxes. example: true default: false bankAccount: type: object description: >- Bank account into which all payments in the other receipts object are deposited. This account is required if an 'undepositedAccount' is not specified. properties: key: type: string description: System-assigned key for the bank account. example: '1002' id: type: string description: Account number or other unique identifier for the bank account. example: BOA name: type: string description: Name of the bank account. example: Bank of America currency: type: string description: Currency for the bank account. example: USD href: type: string description: URL for the bank account. readOnly: true example: /objects/cash-management/bank-account/10 undepositedAccount: type: object description: >- The GL undeposited funds account to use when accumulating receipts for deposit. This account is required if a 'bankAccount' is not specified. properties: key: type: string description: System-assigned key for the undeposited funds account. example: '19' id: type: string description: General ledger undeposited funds account number. example: 1020--Undeposited Funds href: type: string readOnly: true example: /objects/general-ledger/account/19 depositDate: type: string format: date description: Deposit date for payments deposited to a bank account. example: '2021-01-23' exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: number 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' paymentMethod: type: string description: Payment method for the transaction. enum: - printedCheck - creditCard - eft - cash example: eft reversalDate: type: string format: date example: '2021-01-23' description: Date transaction reversal started. readOnly: true reversedDate: type: string format: date example: '2021-01-23' description: Date transaction was reversed. readOnly: true reversedVoidPaymentKey: type: string description: System-assigned key to uniquely identify reversed void payments. readOnly: true example: '1400' taxSolution: type: object description: Tax solution used to calculate taxes on the transaction. properties: key: type: string description: System-assigned key for the tax solution. example: '123' id: type: string description: Unique identifier for the tax solution. example: CATAXSOLUTIONID enableMultilineTax: type: boolean description: Set to `true` to enable multiple taxes per line. example: false taxCalculationMethod: type: string description: >- Method used to apply sales tax during transaction entry, such as Advanced or Simple. example: Simple href: type: string description: URL endpoint for the tax solution. readOnly: true example: /objects/tax/tax-solution/5 voidPaymentKey: type: string description: System-assigned key to uniquely identify reversed, voided payments. readOnly: true example: '1923' href: type: string description: URL for the other receipts object. readOnly: true example: /objects/cash-management/other-receipt/10 audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission format: date-time example: '2014-01-08T11:28:12Z' readOnly: true lines: type: array description: Line items of the other receipts transaction. items: $ref: '#/components/schemas/cash-management-other-receipt-line' cash-management-credit-card-txn-templateRequiredProperties: type: object required: - id - name cash-management-credit-card-txn-line-template: type: object description: Template for credit card transaction lines. properties: key: type: string description: System-assigned key for the credit card transaction line template. readOnly: true example: '1' id: type: string description: >- ID for the credit card transaction line template. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '1' href: type: string description: URL for the credit card transaction line template. readOnly: true example: /objects/cash-management/credit-card-txn-line-template/23 memo: type: string description: Memo example: memo-created-by-rule lineNumber: type: integer description: Line number example: 1 isBillable: type: boolean description: Indicates whether the transaction is billable. example: true default: false exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: number 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' accountLabel: type: object description: Meaningful name of AP account. properties: key: type: string description: System-assigned key for the account label. example: '14' id: type: string description: Meaningful name of the account. example: Entertainment href: type: string readOnly: true example: /objects/accounts-payable/account-label/14 glAccount: type: object description: GL account the line item is assigned to. properties: key: type: string description: System assigned key for the GL account. example: '2' id: type: string description: ID for the GL account. example: '1501.01' name: type: string description: Name or title of the GL account. example: Entertainment href: type: string description: URL for the GL account. readOnly: true example: /objects/general-ledger/account/2 dimensions: $ref: '#/components/schemas/dimension-ref' creditCardTxnTemplate: type: object description: >- Header level details for the credit card transaction template's lines. properties: id: type: string description: ID for the credit card transaction template. example: '2' key: type: string description: System-assigned key for the credit card transaction template. example: '2' href: type: string description: URL for the credit card transaction template. readOnly: true example: /objects/cash-management/credit-card-txn-template/2 status: $ref: '#/components/schemas/status' audit: readOnly: true $ref: '#/components/schemas/audit' cash-management-credit-card-txn-template: type: object description: >- Transaction templates define how to create new credit card transactions in Sage Intacct based on data from an import file or bank feed. properties: key: type: string description: System-assigned key for the credit card transaction template. readOnly: true example: '1' id: type: string description: ID for the credit card transaction template. example: cc-txn-template-1 href: type: string description: URL for the credit card transaction template. readOnly: true example: /objects/cash-management/credit-card-txn-template/23 name: type: string description: Name of the credit card transaction template. example: CC-txn-tmpl-1 description: type: string description: Description of the credit card transaction template. example: CC txn template for banks payee: type: string description: Payee. example: testPayee numberOfRulesUsingTemplate: type: integer description: Count of rules this transaction template is used in. readOnly: true example: 1 default: 0 taxImplication: type: string description: >- Tax implications.This field only applies to companies using the Taxes application that need to track VAT or GST. example: inbound nullable: true enum: - null - none - inbound default: null isInclusiveTax: type: boolean description: >- Indicates if txn is inclusive taxes. This field only applies to companies using the Taxes application that need to track VAT or GST. example: false readOnly: true default: true taxSchedule: type: object description: >- In tax enabled companies tax schedule used to capture tax details in the transaction. properties: key: type: string description: System-assigned key for the tax schedule. example: '11' id: type: string description: Unique identifier of the tax schedule. example: '11' name: type: string readOnly: true description: Tax Schedule ID. example: PO-TaxSched-0010 href: type: string description: URL of the tax schedule object. readOnly: true example: /objects/tax/purchasing-tax-schedule/11 taxSolution: type: object description: >- In tax enabled companies tax solution used to capture tax details in the transaction. properties: key: type: string description: Tax solution key example: '2' id: type: string description: Tax solution. example: Australia - GST href: type: string description: Endpoint for the taxsolution. readOnly: true example: /objects/tax/tax-solution/2 lines: type: array items: $ref: '#/components/schemas/cash-management-credit-card-txn-line-template' audit: readOnly: true $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' cash-management-journal-entry-templateRequiredProperties: type: object required: - id - name - glJournal - lines cash-management-journal-entry-line-template: type: object description: Template for bank transaction rule journal entry lines. properties: key: type: string description: >- System-assigned key for the bank transaction rule journal entry line template. readOnly: true example: '1' id: type: string description: >- ID for the bank transaction rule journal entry line template. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '1' href: type: string description: URL for the bank transaction rule journal entry line template. readOnly: true example: /objects/cash-management/journal-entry-line-template/1 documentId: type: string description: Document number of the transaction. example: doc11 memo: type: string description: Memo example: memo-created-by-rule numberOfUnits: type: integer description: Number of units example: 100 exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: number 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' txnType: type: string description: Transaction type; 1 for Debit, -1 for Credit. example: debit enum: - null - debit - credit nullable: true default: null isBillable: type: boolean description: Indicates whether the transaction is billable. example: true default: false allocation: type: object properties: id: type: string example: '2' key: type: string example: '2' href: type: string readOnly: true example: /objects/allocation/2 glAccount: $ref: '#/components/schemas/gl-account-ref' dimensions: $ref: '#/components/schemas/dimension-ref' journalEntryTemplate: type: object description: Header level details for the journal entry template's lines. properties: id: type: string description: ID for the bank transaction rule journal entry template. example: '2' key: type: string description: >- System-assigned key for the bank transaction rule journal entry template. example: '2' href: type: string description: URL for the bank transaction rule journal entry template. readOnly: true example: /objects/cash-management/journal-entry-template/2 cash-management-journal-entry-template: type: object description: >- Transaction templates define how to create new transactions in Sage Intacct based on data from an import file or bank feed. properties: key: type: string description: System-assigned key for the journal entry transaction template. readOnly: true example: '1' id: type: string description: ID for the journal entry transaction template. example: JE-tmpl-1 href: type: string description: URL for the journal entry transaction template. readOnly: true example: /objects/cash-management/journal-entry-template/1 name: type: string description: Name of the journal entry transaction template. example: JournalEntry-tmpl-1 description: type: string description: Description of the journal entry transaction template. example: GL template for banks postingState: type: string description: >- Set the state in which to create the transaction, `Draft` or `Posted`. example: draft enum: - draft - posted glJournal: type: object description: GL journal to which entries will post. properties: key: type: string description: System-assigned key for the gl-journal. example: '3' id: type: string description: Symbol of the journal to which entries will post. example: APJ href: type: string description: URL for this journal. example: /objects/general-ledger/journal/3 readOnly: true lines: type: array items: $ref: '#/components/schemas/cash-management-journal-entry-line-template' audit: readOnly: true $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' numberOfRulesUsingTemplate: type: integer description: Count of rules this transaction template is used in. readOnly: true example: 1 default: 0 taxImplication: type: string description: Tax implications to the transaction in tax enabled companies. example: none nullable: true enum: - null - none - inbound - outbound default: null taxSolution: type: object description: >- Tax solution. Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK Vat. properties: key: type: string description: System-assigned key for the tax solution. example: '11' id: type: string description: ID for the tax solution. example: Australia GST href: readOnly: true description: URL for the tax solution. type: string example: /objects/tax/tax-solution/11 purchasingTaxSchedule: type: object description: >- In tax enabled companies tax schedule used to capture tax details in the purchasng transaction. properties: key: type: string description: System-assigned key for the tax schedule. example: '1' id: type: string description: Unique identifier of the tax schedule. example: '1' name: type: string readOnly: true description: Tax Schedule ID. example: PO-TaxSched-001 href: type: string description: URL of the tax schedule object. readOnly: true example: /objects/tax/purchasing-tax-schedule/1 salesTaxSchedule: type: object description: >- In tax enabled companies tax schedule used to capture tax details in the sales transaction. properties: key: type: string description: System-assigned key for the tax schedule. example: '7' id: type: string description: Unique identifier of the tax schedule. example: '7' name: type: string readOnly: true description: Tax Schedule ID. example: SO-TaxSched-001 href: type: string description: URL of the tax schedule object. readOnly: true example: /objects/tax/order-entry-tax-schedule/7 customer: type: object description: Tax customer. properties: key: type: string description: System-assigned key for customer. example: '23' id: type: string description: Tax customer id. example: Cust-1 name: type: string readOnly: true description: Tax customer name. example: Customer 1 href: type: string description: Tax customer. readOnly: true example: /objects/accounts-receivable/customer/23 vendor: type: object description: Tax vendor. properties: key: type: string description: System-assigned key for vendor. example: '3' id: type: string description: Tax vendor id. example: Vend-1 name: type: string readOnly: true description: Tax vendor name. example: Vendor 1 href: type: string description: Tax vendor. readOnly: true example: /objects/accounts-payable/vendor/3 cash-management-bank-txn-rule-setRequiredProperties: type: object required: - ruleSetId - name cash-management-bank-txn-rule-map: type: object description: >- A bank transaction rule map is used to map bank transaction rule to a rule set. properties: key: type: string description: >- System assigned key on the record to map bank transaction rule to a rule set. readOnly: true example: '1' id: type: string description: System assigned key on the record to map rule to a rule set. readOnly: true example: '1' ruleOrder: type: integer description: Order of rule in the rule set. example: 1 bankTxnRule: description: A bank transaction rule. type: object properties: id: type: string example: '10' key: type: string example: '10' href: type: string readOnly: true example: /objects/cash-management/bank-txn-rule/10 ruleId: type: string description: Rule ID example: rule1 name: type: string description: Rule Name example: rule-name-1 ruleType: type: string description: Rule type enum: - match - create default: match example: match bankTxnRuleSet: type: object readOnly: true description: A bank transaction rule set. properties: id: type: string readOnly: true example: '2' key: type: string readOnly: true example: '2' href: type: string readOnly: true example: /objects/cash-management/bank-txn-rule-set/2 audit: readOnly: true $ref: '#/components/schemas/audit' cash-management-bank-txn-rule-set: type: object description: >- A rule set acts as a container for matching and creation rules. The rules determine how to match incoming bank transactions or create new transactions for reconciliation in Sage Intacct. properties: key: type: string description: System-assigned key for the bank transaction rule set. readOnly: true example: '32' id: type: string description: System-assigned identifier for the the bank transaction rule set. readOnly: true example: '32' href: type: string description: URL for the bank transaction rule set. readOnly: true example: /objects/cash-management/bank-txn-rule-set/32 ruleSetId: type: string description: ID for the bank transaction rule set. example: ruleSet-1 name: type: string description: Name of the bank transaction rule set. maxLength: 100 example: rule-set-for-credit-cards description: type: string description: Description of the bank transaction rule set. example: Rule set for all card accounts accountType: type: string description: Type of the associated account. example: creditcard enum: - bank - creditcard default: bank numberOfAccounts: type: integer description: Number of accounts linked to this bank transaction rule set. readOnly: true example: 10 default: 0 numberOfRules: type: integer description: Number of rules in the bank transaction rule set. readOnly: true example: 3 default: 0 location: type: object description: Location where the bank transaction rule set was created. properties: key: type: string description: System-assigned key for the location. example: '122' id: type: string description: ID for the location. example: 1-Lyon href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/122 status: $ref: '#/components/schemas/status' rules: type: array description: List of the rules in this rule set. items: $ref: '#/components/schemas/cash-management-bank-txn-rule-map' audit: readOnly: true $ref: '#/components/schemas/audit' cash-management-bank-txn-ruleRequiredProperties: type: object required: - ruleId - name - ruleType - filterAttributes cash-management-bank-txn-rule-filter: description: Filter attributes used in bank transaction rules. type: object properties: key: type: string description: System assigned key for the filter attribute record. readOnly: true example: '3' id: type: string description: System-assigned ID for the filter attribute. readOnly: true example: '3' href: type: string readOnly: true example: /objects/cash-management/bank-txn-rule-filter/3 dataSource: type: string description: >- Attribute data source. This indicates if the filter attribute should be applied on bank transaction or Intacct system transaction. enum: - intacctTransaction - bankTransaction example: intacctTransaction intacctTxnAttribute: type: string description: Intacct/system transaction attribute enum: - null - transactionType - documentNumber - documentDate - transactionAmount - baseAmount - transactionCurrency - baseCurrency - postingDate - description example: postingDate nullable: true default: null bankTxnAttribute: type: string description: Bank transaction attribute enum: - null - transactionType - documentNumber - documentType - amount - currency - feedType - postingDate - description example: transactionType nullable: true default: null operator: type: string description: Operator to use for the txn attribute, to filter txn. enum: - equals - contains - within - notContains - beginsWith - endsWith - greaterThan - lessThan example: equals value: type: string description: Value to use with operator for the txn attribute, to filter txn. maxLength: 200 example: debit order: type: integer description: Order maxLength: 2 example: 2 audit: readOnly: true $ref: '#/components/schemas/audit' bankTransactionRule: type: object readOnly: true properties: id: type: string readOnly: true example: '1' key: type: string readOnly: true example: '1' href: type: string readOnly: true example: /objects/cash-management/bank-txn-rule/1 cash-management-bank-txn-rule-group: description: Grouping attributes used in bank transaction rules. type: object properties: key: type: string description: System assigned key for the group attribute record.. readOnly: true example: '1' id: type: string description: System assigned ID for the group attribute. readOnly: true example: '1' href: type: string readOnly: true example: /objects/cash-management/bank-txn-rule-group/1 dataSource: type: string description: >- Attribute data source. This indicates if this group attribute should be applied on bank transaction or Intacct system transaction. enum: - intacctTransaction - bankTransaction example: intacctTransaction intacctTxnAttribute: type: string description: >- Intacct/system transaction attribute. This is required if datSource is intacctTransaction. enum: - null - documentNumber - postingDate example: documentNumber nullable: true default: null bankTxnAttribute: type: string description: >- Bank transaction attribute. This is required if datSource is bankTransaction. enum: - null - documentNumber - postingDate example: postingDate nullable: true default: null order: type: integer description: Order maxLength: 2 example: 1 audit: readOnly: true $ref: '#/components/schemas/audit' bankTransactionRule: type: object readOnly: true properties: id: type: string readOnly: true example: '10' key: type: string readOnly: true example: '10' href: type: string readOnly: true example: /objects/cash-management/bank-txn-rule/10 cash-management-bank-txn-rule-match: type: object description: >- Matching rules determine how to automatically match transactions from a bank feed or import file for reconciliation. properties: key: type: string description: System assigned key for the match attribute. readOnly: true example: '1' id: type: string description: System assigned ID for the match attribute. readOnly: true example: '1' intacctTxnAttribute: type: string description: Intacct/system transaction field to match. example: postingDate enum: - documentNumber - postingDate - description - amount bankTxnAttribute: type: string description: Bank transaction field to match. example: documentNumber enum: - documentNumber - postingDate - description - amount - documentNumberLeadingZerosRemoved operator: type: string description: Operator used to match attribute. example: equals enum: - equals - contains - within value: type: string description: Value to match example: DOC1000 order: type: integer description: Order of this match attribute in the matchching rule. example: 2 audit: $ref: '#/components/schemas/audit' bankTransactionRule: type: object readOnly: true properties: id: type: string readOnly: true example: '1' key: type: string readOnly: true example: '1' href: type: string readOnly: true example: /objects/cash-management/bank-txn-rule/1 cash-management-bank-txn-rule: type: object description: >- Bank transaction rules define whether to match or create Sage Intacct transactions when processing incoming bank transactions. properties: key: type: string description: System-assigned key for the bank transaction rule. readOnly: true example: '1' id: type: string description: Identifier for the bank transaction rule. readOnly: true example: '1' href: type: string description: URL for the bank transaction rule. readOnly: true example: /objects/cash-management/bank-txn-rule/1 ruleId: type: string description: ID of the rule that matched or created the transaction. example: match-by-amount-1 name: type: string description: Name of the rule that matched or created the transaction. example: match-by-amount description: type: string description: Description of the bank transaction. example: Rule for matching bank transactions by amount ruleType: type: string description: >- Type of rule. A `match` rule matches existing Sage Intacct transactions to incoming bank transactions. A `create` rule creates new Sage Intacct transactions and automatically matches them to incoming bank transactions. example: match enum: - match - create default: match location: type: object description: Location where the bank transaction rule was created. properties: key: type: string description: System-assigned key for the location. example: '122' id: type: string description: ID of the location. example: 1-Lyon href: type: string description: URL for the location. readOnly: true example: /objects/location/122 rulesetCount: type: integer description: Count of rule sets that this rule belongs to. readOnly: true example: 10 default: 0 filterAttributes: type: array minItems: 1 description: Filter attributes for the bank transaction rule. items: $ref: '#/components/schemas/cash-management-bank-txn-rule-filter' groupAttributes: type: array description: Group attributes for the bank transaction rule. items: $ref: '#/components/schemas/cash-management-bank-txn-rule-group' status: $ref: '#/components/schemas/status' matchRuleAttributes: type: array description: >- Matching condition attributes for a match rule. Required when ruletype is match. items: $ref: '#/components/schemas/cash-management-bank-txn-rule-match' createRuleObject: type: object description: >- Transaction template object needed to create transactions. Required when ruletype is create. properties: objectType: type: string description: Object type for a `create` rule. example: journalEntry enum: - null - cctransaction - journalEntry nullable: true default: null journalEntryTemplate: title: >- GL template to reference to create a journal entry for a `create` rule. type: object properties: id: type: string description: Identifier for the GL template. example: '12' key: type: string description: System-assigned key for the GL template. example: '12' href: type: string description: URL for the GL template. readOnly: true example: /objects/cash-management/journal-entry-template/12 creditCardTxnTemplate: title: >- CC txn template to reference to create a CC txn for a `create` rule. type: object properties: id: type: string description: Identifier for the CC txn template. example: '5' key: type: string description: System-assigned key for the CC txn template. example: '5' href: type: string description: URL for the CC txn template. readOnly: true example: /objects/cash-management/credit-card-txn-template/5 audit: readOnly: true $ref: '#/components/schemas/audit' cash-management-deposited-fund: type: object description: Transaction record for deposited fund properties: key: type: string description: System-assigned key for the deposited-fund. readOnly: true example: '23' id: type: string description: Deposited funds ID. readOnly: true example: '23' href: type: string description: Endpoint for the deposited-fund. readOnly: true example: /objects/cash-management/deposited-fund/23 customer: type: object description: Customer associated with the deposit. readOnly: true properties: key: type: string description: System-assigned key for the customer. readOnly: true example: '23' id: type: string description: Identifier for the customer. readOnly: true maxLength: 21 example: Cust-1 name: type: string description: Name of the customer. readOnly: true example: Peter Hansen href: type: string description: URL for the customer. example: /objects/accounts-receivable/customer/23 readOnly: true payee: type: string description: Name of the payee. readOnly: true example: Alter Windows Inc totalEntered: type: string format: decimal-precision-2 description: Total base amount readOnly: true example: '100.99' txnTotalEntered: type: string format: decimal-precision-2 description: Total transaction amount readOnly: true example: '100.99' currency: type: string description: Transaction currency. readOnly: true example: USD paymentMethod: type: string description: Payment method for the transaction. readOnly: true example: cash enum: - check - chargeCard - onlineChargeCard - recordTransfer - cash documentNumber: type: string description: Transaction number. readOnly: true example: Check 0019 deposit: type: object description: Header level details for the deposit's line entries. readOnly: true properties: key: type: string description: System-assigned key for the deposit. readOnly: true example: '10' id: type: string description: ID for the deposit. readOnly: true example: '10' href: type: string readOnly: true example: /objects/cash-management/deposit/10 audit: readOnly: true $ref: '#/components/schemas/audit' cash-management-undeposited-fund: type: object description: Transaction record for undeposited fund properties: key: type: string description: System-assigned key for the undeposited fund. readOnly: true example: '23' id: type: string description: Undeposited funds ID. readOnly: true example: '23' href: type: string description: Endpoint for the undeposited fund. readOnly: true example: /objects/cash-management/undeposited-fund/23 customer: type: object description: Customer associated with the deposit. readOnly: true properties: key: type: string description: System-assigned key for the customer. readOnly: true example: '23' id: type: string description: Identifier for the customer. readOnly: true maxLength: 21 example: Cust-1 name: type: string description: Name of the customer. readOnly: true example: Peter Hansen href: type: string description: URL for the customer. example: /objects/accounts-receivable/customer/23 readOnly: true payee: type: string description: Name of the payee. readOnly: true example: Alter Windows totalEntered: type: string format: decimal-precision-2 description: Total base amount readOnly: true example: '100.99' txnTotalEntered: type: string format: decimal-precision-2 description: Total transaction amount readOnly: true example: '100.99' currency: type: string description: Transaction currency. readOnly: true example: USD paymentMethod: type: string description: Payment method for the transaction. readOnly: true example: cash enum: - check - chargeCard - onlineChargeCard - recordTransfer - cash documentNumber: type: string description: Transaction number. readOnly: true example: Check 0019 audit: readOnly: true $ref: '#/components/schemas/audit' company-config-attachmentRequiredProperties: type: object required: - id company-config-file: type: object description: A file in an attachment. properties: key: type: string description: System-assigned unique key for the file. example: '962' readOnly: true id: type: string description: Unique ID for the file. Same as `key` for this object. example: '962' readOnly: true href: type: string description: Endpoint for the file. example: /objects/company-config/file/962 readOnly: true data: type: string description: Attached file data, Base64 encoded. format: base64zip example: Y2V2YSwgYWx0Y2V2YQ0Kc2kgaW5jYSBjZXZh size: type: integer description: Size of the attachment in bytes. example: 27449 name: type: string description: File name with extension example: 02-28-2022-invoice.txt attachment: description: Attachment object that this file belongs to. type: object properties: id: type: string description: Unique ID of the attachment. example: 2022 February invoices key: type: string description: Unique key of the attachment. example: '123' href: type: string description: Endpoint for the attachment. example: /objects/company-config/attachment/1 readOnly: true company-config-attachment: type: object description: Container to hold one or more files. properties: key: type: string description: System-assigned unique key for the attachment. readOnly: true example: '123' id: type: string description: Unique ID for the attachment container. example: 2022 Taxes name: type: string description: Brief name for the attachment container. example: 2022 tax forms href: type: string description: Endpoint for the attachment container. readOnly: true example: /objects/company-config/attachment/123 folder: type: object description: Folder that this attachment is in. properties: key: type: string description: Unique key of the folder. example: '4' id: type: string description: Unique name of the folder. example: SupDocFolder1 href: type: string description: Endpoint for the folder. readOnly: true example: /objects/company-config/folder/4 description: type: string description: Description of the attachment container. example: February invoices entity: type: object properties: key: type: string example: '30' id: type: string example: Seattle name: type: string readOnly: true example: Seattle href: type: string description: URL for the entity. readOnly: true example: /objects/company-config/entity/30 files: type: array description: Files contained in the attachment. items: $ref: '#/components/schemas/company-config-file' audit: type: object properties: createdDate: description: Date of the submission type: string format: date example: '2022-04-20' readOnly: true modifiedDate: description: Date of the modification type: string format: date example: '2022-04-20' readOnly: true createdBy: description: User who created this type: string example: '1' readOnly: true modifiedBy: description: User who modified this type: string example: User2 readOnly: true company-config-folderRequiredProperties: type: object required: - id company-config-folder: type: object description: Folder for holding one or more attachments. properties: key: type: string description: >- System-assigned unique key for the folder. Used to identify the folder in URLs or JSON bodies for all operations on the folder. readOnly: true example: '88' id: type: string description: >- Unique name for the folder. Cannot be changed after the folder is created. example: 2022 Tax forms description: type: string description: Description of the folder example: 2022 tax forms parent: type: object description: Parent folder, for folder hierarchies. properties: key: type: string description: Unique key of the parent folder. example: '3' id: type: string description: Name of the parent folder. example: fld3 href: type: string description: Endpoint for the parent folder. readOnly: true example: /objects/company-config/folder/3 entity: type: object properties: key: type: string example: '30' id: type: string example: Seattle name: type: string readOnly: true example: Seattle href: type: string description: URL endpoint for the entity. readOnly: true example: /objects/company-config/entity/30 href: type: string description: Endpoint for the folder. readOnly: true example: /objects/company-config/folder/1 status: $ref: '#/components/schemas/status' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: description: Date-time of the submission type: string format: date-time example: '2022-04-20T16:20:00Z' readOnly: true modifiedDateTime: description: Date-time of the modification type: string format: date-time example: '2022-04-20T17:40:00Z' readOnly: true modifiedBy: description: User who modified this type: string example: User2 readOnly: true company-config-classRequiredProperties: type: object required: - id - name company-config-class: type: object description: >- Class is a customizable dimension that can be defined in a company and set on transactions to expand report functionality and insight. properties: key: description: >- System-assigned unique key for the class. Used to identify the class in URLs or JSON bodies for all operations on the class. type: string readOnly: true example: '42' id: description: Unique ID for the class. type: string example: 1-Goods href: description: URL endpoint for this class. type: string readOnly: true example: /objects/company-config/class/21 name: description: Name of this class. type: string example: Goods description: description: Description of the class. type: string example: Goods available for donations status: $ref: '#/components/schemas/dimension-status' example: active locationKey: type: string description: >- System-assigned unique key for the entity. Used to identify the entity in URLs or JSON bodies for all operations involving the entity. readOnly: true example: '3345' parent: type: object description: Parent class, for class hierarchies. properties: id: description: Parent class ID. type: string example: 23-Donations key: description: Parent class key. type: string example: '4' href: description: URL endpoint for the parent class. type: string readOnly: true example: /objects/company-config/class/3 name: description: Name of parent class. type: string readOnly: true example: Donations audit: $ref: '#/components/schemas/audit' company-config-contactRequiredProperties: type: object required: - id - printAs company-config-contact: type: object description: >- A contact hold all the information needed to contact an individual or business, including name, email address, phone number, mailing address, and more. properties: key: type: string description: System-assigned unique key for the contact. readOnly: true example: '21' id: type: string description: Unique identifier for the contact. example: rkincaid href: type: string readOnly: true description: URL endpoint for the contact. example: /objects/company-config/contact/21 lastName: type: string description: Last name example: Kincaid firstName: type: string description: First name example: Reuben middleName: type: string description: Middle name or initial example: X prefix: type: string description: Prefix, such as Mr., Mrs., or Ms. example: Mr. email1: type: string description: Primary email address example: reuben@mycompany.com email2: type: string description: Secondary email address example: robert@mycompany.com phone1: type: string description: Primary phone number example: '4151231234' phone2: type: string description: Secondary phone number example: '4158661823' mobile: type: string description: Mobile phone number example: '4159879876' pager: type: string description: Pager number example: '4151112222' fax: type: string description: Fax number example: '4152221111' URL1: type: string description: Web page address for this contact. example: https://mycompany.com URL2: type: string description: Secondary web page address. example: https://whitehouse.gov companyName: type: string description: Name of the company associated with this contact. example: AlcoSoft Inc printAs: type: string description: >- The contact name as you want it to appear on bills, invoices, AR statements, advances, adjustments, checks, expense reports, expense reimbursements, and 1099s. example: Reuben Kincaid showInContactList: type: boolean description: Set to `true` to display the contact in the contact list. default: true example: true discount: type: string description: >- Default discount percentage to be applied to order entry transactions involving this contact. example: '33' status: $ref: '#/components/schemas/status' mailingAddress: type: object description: The mailing address of the contact. properties: addressLine1: type: string description: The first address line for shipping, billing, etc. example: 300 Park Avenue addressLine2: type: string description: The second address line for shipping, billing, etc. example: Suite 1400 addressLine3: type: string description: >- The third address line for shipping, billing, etc. which provides additional geographical information. example: Western industrial area city: type: string description: City example: San Jose state: type: string description: State example: California postCode: type: string description: Zip or Postal Code example: '95110' country: type: string description: Country example: unitedStates isoCountryCode: type: string description: >- ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided. example: US priceList: type: object description: >- Default price list used in order entry when this contact places orders. Read [the notes in the Help Center](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Price_lists/assign-OE-price-list-to-objects.htm#Assignapricelisttoacontact) for requirements and additional information. properties: key: type: string description: Price list key example: '7' id: type: string description: Price list ID example: Custom-Pricelist href: type: string description: URL for the price list. readOnly: true example: /objects/order-entry/price-list/7 priceSchedule: type: object description: Price schedule used in order entry when this contact places orders. properties: key: type: string description: Price schedule key example: '7' id: type: string description: Price schedule ID example: Discount-Premium href: type: string description: URL for the price schedule. readOnly: true example: /objects/order-entry/price-schedule/7 tax: type: object description: >- Tax settings needed for Intacct to calculate taxes on transactions for this contact. properties: isTaxable: type: boolean description: Set to `true` to enable tax calculation. default: true example: true taxId: type: string description: State tax ID or VAT registration number for this contact. example: US2333 group: type: object description: The contact tax group to be used with this contact. properties: key: type: string description: Contact tax group key example: '7' id: type: string description: Contact tax group ID example: Taxes-for-residents href: type: string description: URL endpoint of the contact tax group. readOnly: true example: /objects/company-config/contact-tax-group/7 company-config-departmentRequiredProperties: type: object required: - id - name company-config-department: type: object description: Information about a department. properties: key: type: string description: System-assigned unique key for the department. example: '28' readOnly: true id: type: string description: Unique identifier for the department. nullable: false example: SW name: type: string description: Department name nullable: false example: Software Dev number: type: string description: Department number example: '10' reportTitle: type: string description: Department title displayed in reports example: Software Engineering nullable: true default: null parent: type: object description: Parent department, for department hierarchies. properties: key: type: string description: Parent department key example: '7' nullable: true default: null id: type: string example: Dev description: Parent department ID name: type: string description: Parent department Name example: Development readOnly: true href: type: string example: /objects/company-config/department/7 description: Parent department URL endpoint readOnly: true readOnly: true supervisor: type: object description: >- A reference to the employee object of the supervisor for the department. Used for routing purchase approvals. properties: key: type: string example: '5' description: Supervisor key nullable: true default: null id: type: string example: EMP-0192 description: Supervisor ID name: type: string description: Supervisor name example: rjmiller readOnly: true href: type: string example: /objects/company-config/employee/5 description: URL endpoint of the supervisor employee. readOnly: true readOnly: true status: $ref: '#/components/schemas/dimension-status' audit: $ref: '#/components/schemas/audit' href: type: string example: /objects/company-config/department/28 description: URL endpoint for the department. readOnly: true company-config-entityRequiredProperties: type: object required: - id - name - federalId month: type: string enum: - null - january - february - march - april - may - june - july - august - september - october - november - december example: may nullable: true weekdays: type: string enum: - null - sunday - monday - tuesday - wednesday - thursday - friday - saturday example: monday nullable: true country: type: string enum: - null - unitedStates - afghanistan - alandIslands - albania - algeria - americanSamoa - andorra - angola - anguilla - antarctica - antiguaAndBarbuda - argentina - armenia - aruba - australia - austria - azerbaijan - bahamas - bahrain - bangladesh - barbados - belarus - belgium - belize - benin - bermuda - bhutan - bolivia - bonaire,SintEustatiusAndSaba - bosniaAndHerzegovina - botswana - bouvetIsland - brazil - britishIndianOceanTerritory - bruneiDarussalam - bulgaria - burkinaFaso - burundi - cambodia - cameroon - canada - capeVerde - caymanIslands - centralAfricanRepublic - chad - chile - china - christmasIsland - cocos(Keeling)Islands - colombia - comoros - congo - congo,DemocraticRepublic - cookIslands - costaRica - côteD'Ivoire - croatia - cuba - curaçao - cyprus - czechRepublic - denmark - djibouti - dominica - dominicanRepublic - ecuador - egypt - elSalvador - equatorialGuinea - eritrea - estonia - eswatini - ethiopia - falklandIslands(Malvinas) - faroeIslands - fiji - finland - france - frenchGuiana - frenchPolynesia - frenchSouthernTerritories - gabon - gambia - georgia - germany - ghana - gibraltar - greece - greenland - grenada - guadeloupe - guam - guatemala - guernsey - guinea - guineaBissau - guyana - haiti - heardIs.&McdonaldIslands - honduras - hongKong - hungary - iceland - india - indonesia - iran,IslamicRepublicOf - iraq - ireland - isleOfMan - israel - italy - jamaica - japan - jersey - jordan - kazakhstan - kenya - kiribati - korea,RepublicOf - korea,Demo.People'sRep. - kosovo - kuwait - kyrgyzstan - lao - latvia - lebanon - lesotho - liberia - libyanArabJamahiriya - liechtenstein - lithuania - luxembourg - macao - macedonia - madagascar - malawi - malaysia - maldives - mali - malta - marshallIslands - martinique - mauritania - mauritius - mayotte - mexico - micronesia - moldova,RepublicOf - monaco - mongolia - montenegro - montserrat - morocco - mozambique - myanmar - namibia - nauru - nepal - netherlands - netherlandsAntilles - newCaledonia - newZealand - nicaragua - niger - nigeria - niue - norfolkIsland - northernMarianaIslands - norway - oman - pakistan - palau - palestinianTerritory,Occupied - panama - papuaNewGuinea - paraguay - peru - philippines - pitcairn - poland - portugal - puertoRico - qatar - reunion - romania - russianFederation - rwanda - saintBarthelemy - saintHelena - saintKittsAndNevis - saintLucia - saintMartin - saintPierreAndMiquelon - saintVincentAndTheGrenadines - samoa - sanMarino - saoTomeAndPrincipe - saudiArabia - senegal - serbia - seychelles - sierraLeone - singapore - sintMaarten - slovakia - slovenia - solomonIslands - somalia - southAfrica - s.Georgia&S.SandwichIs. - spain - sriLanka - sudan - southSudan - suriname - svalbardAndJanMayen - sweden - switzerland - syrianArabRepublic - taiwan - tajikistan - tanzania,UnitedRepublicOf - thailand - timorLeste - togo - tokelau - tonga - trinidadAndTobago - tunisia - turkey - turkmenistan - turksAndCaicosIslands - tuvalu - uganda - ukraine - unitedArabEmirates - unitedKingdom - uSMinorOutlyingIslands - uruguay - uzbekistan - vanuatu - vaticanCityState - venezuela - vietnam - virginIslands,British - virginIslands,U.S. - wallisAndFutuna - westernSahara - yemen - zambia - zimbabwe example: france nullable: true company-config-entity: type: object description: Entity configuration. properties: key: type: string description: System-assigned unique key for the entity. readOnly: true example: '2' id: type: string description: >- Unique identifier of the entity. 20 characters max. The ID cannot be changed after the entity has been created. example: Lyon href: type: string description: URL endpoint for the entity. readOnly: true example: /objects/company-config/entity/2 name: type: string description: Name of the entity. example: California startDate: type: string format: date description: The date when the entity became operational. nullable: true example: '2022-02-02' endDate: type: string format: date description: The date when the entity was taken out of operation. nullable: true example: '2023-03-03' federalId: type: string description: >- The federal tax ID for the entity. This value is required but is only used if the company is configured to issue a separate 1099 for each US entity. nullable: true example: '123456789' firstFiscalMonth: type: string description: First fiscal month nullable: true allOf: - $ref: '#/components/schemas/month' default: null firstTaxMonth: type: string description: First tax month nullable: true allOf: - $ref: '#/components/schemas/month' default: null weekStart: type: string description: >- The first day of each week. This enables the system to provide accurate data for reports that begin on the first day of a week. nullable: true allOf: - $ref: '#/components/schemas/weekdays' default: null contacts: type: object description: Contact information for the entity. properties: primary: type: object description: >- Primary contact information. This could be for the entity itself and not for an individual. allOf: - $ref: '#/components/schemas/contact-ref' - type: object shipTo: type: object description: >- Contact information to use for shipping, if the entity uses a different address for receiving goods and services. allOf: - $ref: '#/components/schemas/contact-ref' - type: object texts: type: object description: Texts used in invoices and reports. properties: message: type: string description: Message text nullable: true example: >- Superior financial Applications. Real-time business visibility. Open, on-demand platform. marketing: type: string description: Marketing text nullable: true example: Intacct. A Better Way to Run Your Business footnote: type: string description: >- Footnote text that will appear on reports and invoices that are printed for the entity. nullable: true example: All sales final. reportPrintAs: type: string description: >- The name of the entity as it will appear on reports and invoices that are printed for the entity. example: My Company LLC customTitle: type: string description: >- Entity information displayed in reports, in addition to the entity name. For example, an entity title might include the address and manager name. nullable: true example: San Jose, California isRoot: type: boolean description: >- Used in Cash Management (Checking Account) to indicate whether this entity is a working entity. default: false readOnly: true enum: - true - false example: false businessDays: type: array description: Work days in each week. example: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY default: [] items: type: string weekends: type: array description: Weekend days. example: - SATURDAY - SUNDAY default: [] items: type: string taxId: type: string description: The state or territory tax ID, or VAT ID. nullable: true example: '192354308' defaultCountryForAddresses: type: string description: Default country for addresses allOf: - $ref: '#/components/schemas/country' default: unitedStates businessId: type: string description: >- A company's Business ID (SIRET) is a 14-digit number that starts with the SIREN (a 9-digit number that identifies the company itself) followed by 5 digits that identifies the company's physical location or branch. nullable: true example: 453 983 245 12345 openBooksStartDate: type: string format: date description: Open books from nullable: true example: '2021-01-01' operatingCountry: type: string description: The country in which the entity operates. nullable: true allOf: - $ref: '#/components/schemas/country' default: null legalContact: type: object description: >- Legal contact to be used on 1099 form, 1096 form, and taxable payments annual report (TPAR). properties: enableOnTaxForms: type: boolean description: >- Set to `true` to include the legal name and address on forms 1099 and 1096 for this entity. example: false default: false enableOnTPAR: type: boolean description: >- Set to `true` to include the legal name and address on taxable payments annual report (TPAR) for Australian companies and entities. example: false default: false name: type: string description: >- Legal name, to be printed on 1099 form, 1096 form and taxable payments annual report (TPAR). nullable: true example: Expert Sage Intacct LTD address: type: object description: >- Legal address to be used on 1099 form, 1096 form and taxable payments annual report (TPAR). properties: address1: type: string description: Legal address line 1 nullable: true example: 300 Park Avenue address2: type: string description: Legal address line 2 nullable: true example: Suite 1400 address3: type: string description: Legal address line 3 nullable: true example: Western industrial area city: type: string description: Legal city nullable: true example: San Jose state: type: string description: Legal state or territory nullable: true example: California zipCode: type: string description: Legal ZIP or postal code nullable: true example: '95110' country: type: string description: Legal country nullable: true example: United States countryCode: type: string description: Legal country code nullable: true allOf: - $ref: '#/components/schemas/country-code' default: null tpar: type: object description: Taxable payments annual report (TPAR) form elements. properties: contact: type: object description: Legal contact for taxable payments annual report (TPAR). properties: name: type: string description: Legal contact name. nullable: true example: John Doe phone: type: string description: Legal contact phone. nullable: true example: '1022223333' fax: type: string description: >- Legal contact fax on taxable payments annual report (TPAR). nullable: true example: '1009288888' email: type: string description: >- Legal contact email on taxable payments annual report (TPAR). nullable: true example: contact@example.com branchNumber: type: string description: >- Legal branch number on taxable payments annual report (TPAR). nullable: true example: '001' isPartialExempt: type: boolean description: >- Enable partial VAT exemption. When set to `true`, users can enter bills with items that are eligible for partial exemption in agreement with the HMRC. Requires that tax solution is United Kingdom - VAT. example: true default: false isDefaultPartialExempt: type: boolean description: >- Set to `true` to mark items as partial exempt by default on bills and invoices for Accounts Payable and Purchasing with the following tax solutions - Australia GST (RITC), Canadian Sales Tax (ITC), UK VAT. example: true default: false accountingType: type: string description: Accounting type example: entity nullable: true enum: - null - entity - fund default: entity statutoryReportingPeriodDate: type: string format: date description: >- Max lock date for the given entity, used for GL Setup Approval Configuration. nullable: true example: '2021-01-01' customer: type: object description: Customer associated with the entity. properties: key: type: string description: Unique key of the associated customer. nullable: true example: '15' href: type: string description: URL endpoint for the customer. readOnly: true nullable: true example: /objects/accounts-receivable/customer/23 id: type: string description: Unique identifier for the customer. example: C-00003 name: type: string description: Customer name. readOnly: true nullable: true example: Logic Solutions vendor: type: object description: Vendor associated with the entity. properties: key: type: string description: Unique key of the vendor. example: '15' href: type: string description: URL endpoint for the vendor. readOnly: true example: /objects/accounts-payable/vendor/15 id: type: string description: Vendor ID. example: V-00014 name: type: string description: Vendor name readOnly: true nullable: true example: Pac bell unrecoverableTaxAccount: type: object description: Unrecoverable tax account for this entity. properties: key: type: string description: Unrecoverable tax account key nullable: true example: '23' id: type: string description: Unrecoverable tax account ID nullable: true example: '123.45' href: type: string description: URL endpoint for the unrecoverable tax account. readOnly: true example: /objects/general-ledger/account/23 enableInterEntityRelationships: type: boolean description: >- Set to `true` to enable different accounts based on the target entity. default: false example: true interEntityPayableGLAccount: type: object description: >- Inter-entity payable account that this entity is associated with. Only applicable if `enableInterEntityRelationships` = `true`. properties: key: type: string description: >- System-assigned unique key of the account for payable inter-entity transactions. nullable: true example: '89' id: type: string description: Inter-entity payable account ID. nullable: true example: '555.99' accountNumber: type: string description: Inter-entity payable account number. readOnly: true nullable: true example: '123436' href: type: string description: URL endpoint for the account. readOnly: true example: /objects/general-ledger/account/89 interEntityReceivableGLAccount: type: object description: >- Inter-entity receivable account that this entity is associated with. Only applicable if `enableInterEntityRelationships` = `true`. properties: key: type: string description: >- System-assigned unique key of the account for receivable inter-entity transactions. nullable: true example: '876' id: type: string description: Inter-entity receivable account ID. nullable: true example: '555.98' accountNumber: type: string description: Inter-entity receivable account number. readOnly: true nullable: true example: '123436' href: type: string description: URL endpoint for the account. readOnly: true example: /objects/general-ledger/account/876 manager: type: object description: >- The [employee](/openapi/co/company-config-employee/tag/Employees) who manages the entity. properties: href: type: string description: URL endpoint for the manager employee. readOnly: true example: /objects/company-config/employee/81 id: type: string description: Manager employee ID. example: jsmith key: type: string description: System-assigned unique key of the manager employee. example: '81' name: type: string description: Name of the manager. readOnly: true nullable: true example: John Smith email1: type: string description: Manager's primary email address. readOnly: true nullable: true example: supervisor1@example.com email2: type: string description: Manager's secondary email address. readOnly: true nullable: true example: supervisor2@example.com taxSolution: type: object description: >- The tax solution to be used by this entity. Only for companies subscribed to the Taxes application. properties: key: type: string description: Tax solution example: '23' href: type: string description: URL endpoint for the tax solution. readOnly: true example: /objects/tax/tax-solution/23 id: type: string description: Tax solution example: Australia - GST taxMethod: type: string description: Tax solution method readOnly: true nullable: true example: Advanced tax status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' company-config-locationRequiredProperties: type: object required: - id - name company-config-location: type: object description: >- Location is a dimension that is used to represent the geographic locations of offices or facilities. It can also be used for divisions in a company, if that is more significant than geographic locations. Once defined, locations can be set on transactions, and that information can be used to provide new insights in reports. properties: key: type: string description: >- System-assigned unique key for the location. Used to identify the location in URLs or JSON bodies for all operations on the location. readOnly: true example: 3345 id: type: string description: Unique identifier for the location. example: 1-Lyon href: type: string readOnly: true description: URL endpoint for this location. example: /objects/company-config/location/21 name: type: string description: Name of the location. example: Lyon-France status: $ref: '#/components/schemas/dimension-status' taxId: type: string description: State tax ID or VAT registration number. example: US4321112 startDate: type: string description: Start date of operation at this location. format: date example: '2021-01-01' endDate: type: string description: End date of operation at this location. format: date example: '2022-04-01' contacts: type: object description: The list of contacts for the location. properties: primary: type: object description: >- The primary location contact specifies the company name, address, and other details as they should appear on invoices, bills, and other forms. allOf: - $ref: '#/components/schemas/contact-ref' - type: object shipTo: type: object description: >- The address for receiving goods and services, if different from the primary contact address. allOf: - $ref: '#/components/schemas/contact-ref' - type: object locationReportingTitle: type: string description: >- Location information displayed in reports, in addition to the location name. For example, a location title might include the address and manager name. parent: type: object description: Parent location, for location hierarchies. properties: key: description: Parent location key. type: string example: 65 id: description: Parent location ID. type: string example: 1-France href: description: URL endpoint of parent location. type: string readOnly: true example: /objects/company-config/location/65 name: description: Name of the parent location. type: string readOnly: true example: California manager: type: object description: The employee that manages the location. properties: key: description: Manager's employee key. type: string example: 81 id: description: ID of the manager employee. type: string example: anne.jason href: description: URL endpoint of the manager employee. type: string readOnly: true example: /objects/company-config/employee/81 name: description: Name of the manager. type: string readOnly: true example: Donations audit: $ref: '#/components/schemas/audit' company-config-document-sequenceRequiredProperties: type: object required: - id company-config-document-sequence-rollover: type: object description: > The rollover configuration holds the next number or alpha values used to generate sequences for the fiscal years. When rollover is enabled for a document sequence then a restart of the document sequence is initiated for each fiscal year. If the configuration for a fiscal year is missing then it is automatically generated by the system when the first sequence is generated. When the system generates a configuration the next number or alpha values are taken over from the base start values. properties: key: type: string description: System-assigned key for the fiscal year rollover configuration. readOnly: true example: '100' id: type: string description: Fiscal year rollover configuration ID. readOnly: true example: '100' href: type: string description: Endpoint for the fiscal year rollover configuration. readOnly: true example: /objects/company-config/document-sequence-rollover/100 documentSequence: type: object readOnly: true properties: key: type: string description: System-assigned key for the document sequence. readOnly: true example: '107' id: type: string description: Identifier for the document sequence. readOnly: true example: BOA_ACH_BatchNo href: type: string description: URL for the document sequence. readOnly: true example: /objects/company-config/document-sequence/107 fiscalYear: type: integer description: Fiscal year example: 2024 nextNumber: type: integer description: >- Next number used to generate sequences for the fiscal year when the sequence type is `numeric` example: 1 nextSequence: type: string description: >- Next sequence used to generate sequences for the fiscal year when the sequence type is `alpha` example: a audit: $ref: '#/components/schemas/audit' company-config-document-sequence: type: object description: Document sequencing properties: key: type: string description: Document sequence Key readOnly: true example: '61' id: type: string description: Document sequence ID example: Vendors printTitle: type: string description: Print title example: Vendors type: type: string description: >- Numeric or alpha sequence. Alpha sequences are currently only available for use with Cash Management, or French companies. enum: - numeric - alpha example: numeric default: numeric fixedLength: type: string description: >- Fixed length, up to 16 characters (numeric sequence will be padded with zeros and alpha sequence will be padded with a's) example: '16' fixedPrefix: type: string description: Fixed prefix example: INV prefixSeparator: type: string description: Prefix separator example: '-' fixedSuffix: type: string description: Fixed suffix example: COMPANY suffixSeparator: type: string description: Suffix separator example: '-' startingNumber: type: integer description: Starting number example: 1 endingNumber: type: integer description: Ending number example: 100 nextNumber: type: integer description: Next number example: 1 startingSequence: type: string description: Starting sequence example: a endingSequence: type: string description: Ending sequence example: zzz nextSequence: type: string description: Next sequence example: a whenModified: type: string format: date-time description: When updated example: '2014-01-08T11:28:12Z' rollover: type: object description: >- Use the roollover configuration to generate IDs for documents meant to take effect in a specific fiscal year. properties: isEnabled: type: boolean description: > Set to `true` in order to enable the sequence rollover by fiscal years. When rollover is enabled for a document sequence then a restart of the document sequence is initiated for each fiscal year. Use the `fiscalYears` to configure the next number or alpha values used to generate sequences for the fiscal years. If the configuration for a fiscal year is missing then it is automatically generated by the system when the first sequence is generated. When the system generates a configuration the next number or alpha values are taken over from the base start values. example: false default: false enabledDate: type: string format: date description: >- Read only value indicating the date when the rollover configuration was enabled for the first time. example: '2021-01-23' fiscalYearAffixPosition: type: string description: > Configures the option that the fiscal year is appended to the document sequence generated by the function service for that fiscal year. ** Valid values ** - `none` Do not append the fiscal year nor the rollover separator to the document sequence. - `prefix` Append the fiscal year togetwher with the rollover prefix separator as a prefix to the document sequence. - `suffix` Append the fiscal year togetwher with the rollover suffix separator as a suffix to the document sequence. example: prefix enum: - none - prefix - suffix default: none separator: type: string description: >- Rollover separator used when the rollover affix mode is set to `prefix` or `suffix` example: '-' fiscalYears: type: array description: >- Fiscal years rollover configuration holds the next number or alpha values used to generate sequences for the fiscal years. items: $ref: '#/components/schemas/company-config-document-sequence-rollover' status: $ref: '#/components/schemas/status' href: type: string readOnly: true description: URL endpoint of the document-sequence example: /objects/company-config/document-sequence/61 audit: $ref: '#/components/schemas/audit' company-config-email-templateRequiredProperties: type: object properties: email: required: - replyTo required: - name - subject - body company-config-email-template: type: object description: >- Listing of the templates for sending out any electronic order entry transaction with the person who created it. (Legacy) properties: key: type: string description: Email Template Key readOnly: true example: '23' id: type: string description: Email Template ID readOnly: true example: '23' href: type: string description: URL of the email-template. readOnly: true example: /objects/company-config/email-template/23 status: $ref: '#/components/schemas/dimension-status' name: type: string description: name for the email template. example: New Email Template description: type: string description: Description example: Test for New Email Template email: type: object properties: replyTo: type: string description: >- Enter an email address you want the recipient to reply to. This corresponds to the From email address the user sees in the Print/Email dialog box when they send an email from a transaction. example: someEmail@co.com to: type: string description: >- To The recipients of the email. You can enter one or more merge fields in each field. example: someEmail@co.com cc: type: string description: >- Carbon Copy the recipients of the email. You can enter one or more merge fields in each field. example: someEmail@co.com bcc: type: string description: >- Blind Carbon Copy the recipients of the email. You can enter one or more merge fields in each field. example: someEmail@co.com subject: type: string description: >- Subject Enter a combination of text and merge fields as desired to create an informative subject line. This field is required example: Testing New Email Template body: type: string description: >- Message Enter a combination of text, merge fields, and HTML markup as desired to create and customize your message. This field is required. example: test message for all to see logo: type: object properties: isLogoIncluded: type: boolean description: >- Include logo Select this checkbox to include the logo image file identified on the Company Information page in the email template. default: false example: true verticalPosition: type: string enum: - top - bottom description: >- Vertical logo position Select whether the logo should appear at the top or bottom of the email. default: bottom example: bottom horizontalPosition: type: string enum: - left - right description: >- Horizontal logo position Select whether the logo should appear on the left or right side of the email. default: left example: left includeTxnAttachments: type: boolean description: >- Select this checkbox to include documents attached to the transaction, such as receipts, in the email you send from a transaction. Attachments are emailed in the format in which they were attached to the transaction. For example, if you attached a TXT file, the file is sent as a TXT file. default: false example: true includeProjectInvoiceTxnAttachments: type: boolean description: >- Select this checkbox to include all source document attachments linked to a project invoice when emailing the invoice. Attachments are emailed in the format in which they were attached to the transaction. For example, if you attached a TXT file, the file is sent as a TXT file. default: false example: true templateType: type: string enum: - arInvoice - arStatement - Contract - orderEntryTxn - purchasingTxn description: Application default: arInvoice example: arInvoice useSendersPreferredDateFormat: type: boolean description: Display dates in the user preference setting default: false example: true audit: $ref: '#/components/schemas/audit' company-config-userRequiredProperties: type: object properties: contact: required: - lastName - firstName - email1 required: - id - userName - userType permission-access-rights: type: string enum: - ach - achSetup - add - addExpense - apiProxy - authorize - close - config - confirm - delete - deleteExpense - edit - editExpense - enable - export - final - financial - group - ignore - impersonate - level1 - level2 - level3 - level4 - level5 - level6 - list - listExpenses - manualMatch - mapAccount - modify - offsetAccount - open - overrideException - permission - post - print - readonly - readonlyExpense - reclass - reclassExpense - reconcile - refresh - release - reopen - report - resend - reversalEdit - reverseExpense - reverse - run - statutoryReportingPeriod - submit - subscribe - unmask - view - viewAll - void example: edit company-config-user: description: User information type: object properties: key: description: >- System-assigned unique key for the user. Used to identify the user in URLs or JSON bodies for all operations on the user. type: string example: '29' readOnly: true id: description: User login ID type: string example: john.doe userName: description: User name type: string example: John Doe adminPrivileges: description: > User admin privileges. Setting to `full` or `limited` requires that the `userType` is `business`. * `off` - No admin privileges * `full` - Complete administration privileges including the ability to create other full administrators and use Platform Services features. * `limited` - All administration privileges, except for the previously mentioned items. type: string enum: - 'off' - limited - full example: 'off' userType: description: > [User type](https://www.intacct.com/ia/docs/en_US/help_action/Administration/Users/user-types.htm) type: string enum: - business - employee - viewOnly - dashboard - projectManager - paymentApprover - platform - crm - warehouse example: employee status: type: string description: User status. enum: - active - inactive - lockedOut default: active example: active webServices: type: object description: Web Services / API properties properties: isEnabled: description: Set to `true` to allow the user to use web services (API). type: boolean default: true example: true isRestricted: description: >- Set to `true` to restrict the user to Web Services only. That is, the user cannot log in to the Sage Intacct. type: boolean default: false example: true password: type: object description: Password properties properties: neverExpires: type: boolean description: Set to `true` to prevent the user's password from expiring. example: true requiresReset: type: boolean description: Set to `true` to trigger the password reset flow for the user. example: false sso: type: object description: SSO settings properties: isSSOEnabled: type: boolean description: Set to `true` to enable single sign-on for the user. example: true default: false federatedSSOId: type: string description: Federated SSO user ID. example: john.doe entityAccess: type: object description: Entity level restrictions properties: allowUnrestrictedAccess: description: >- Set to `true` to allow the user to access all entities in the company. type: boolean default: true example: true allowToplevelAccess: description: >- Set to `true` to enable access to the top-level. It's a best practice to enable access to the top level for all users who are restricted to a single entity in a multi-entity shared company. type: boolean default: false example: false contact: description: User contact information allOf: - $ref: '#/components/schemas/contact-ref' - type: object type: object trustedDevices: type: string description: >- Allow trusted devices. The user can specify whether to use the company setting or have it enforced. enum: - companyDefault - always - never default: companyDefault example: always isChatterDisabled: type: boolean description: >- Set to `true` to prevent this user from accessing the Intacct Collaborate feature. default: false example: false hideOtherDepartmentTransactions: type: boolean description: >- Set to `true` to hide transactions that do not belong to the departments listed in the `departments` array. default: false example: false locations: type: array description: >- Locations that the user is allowed to view and work with. Leave empty to allow the user to work with all locations. items: type: object properties: key: type: string description: Location key example: '42' id: type: string description: Location ID example: PNW href: type: string description: Endpoint URL for the location. readOnly: true example: /objects/company-config/location/21 departments: type: array description: >- Departments that the user is allowed to view and work with. Leave empty to allow the user to work with all departments. items: type: object properties: key: type: string description: Department key example: '79' id: type: string description: Department ID example: Sales href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/7 territories: type: array description: List of territories that the user is assigned to. items: type: object properties: key: type: string description: Territory key example: '9' id: type: string description: Territory ID example: T1 href: type: string description: Territory URL endpoint readOnly: true example: /objects/accounts-receivable/territory/9 roles: type: array description: List of roles assigned to the user. items: type: object properties: key: type: string description: Unique key for the role example: '7' id: type: string description: Role ID example: Employee href: type: string readOnly: true example: /objects/company-config/role/7 permissionAssignments: type: array items: type: object properties: permission: type: object properties: key: type: string description: Permission key example: '404' id: type: string description: Permission id example: '404' href: type: string readOnly: true example: /objects/company-config/permission/404 accessRights: type: array description: Permission access rights example: - list - readonly - add - modify - delete items: $ref: '#/components/schemas/permission-access-rights' audit: $ref: '#/components/schemas/audit' href: type: string readOnly: true description: URL endpoint for user. example: /objects/company-config/user/21 company-config-roleRequiredProperties: type: object required: - id module: type: string description: Permission module readOnly: true enum: - accountsPayable - accountsReceivable - administration - advancedAuditTrail - aiMachineLearning - avalaraTax - budgets - cashManagement - company - console - consolidation - construction - constructionPayroll - contracts - customizationServices - dataDeliveryService - dataImport - digitalBoardBook - digitalNetworkSync - dimensionSync - dynamicAllocations - externalServicesProvider - fixedAssets - generalLedger - globalTransactionSecurity - intacctCollaborate - intacctSalesforceIntegration - intacctSalesforceIntegrationV2 - interactiveCustomReportWriter - interactiveVisualExplorer - inventoryControl - managementConsole - managementConsoleConsolidation - msTeamsIntegration - multiEntity - myAccounting - myClients - myPractice - orderEntry - outboundPaymentServices - outsourcedPaymentServices - paymentServices - projects - purchasing - quickbooksMigration - realEstate - revenueManagement - saasMetrics - sageCloudServices - sageIntacctBudgetingAndPlanningConnector - sagePeople - siCollaboration - siFundRaising - smartTransaction - spendManagement - taxExport - taxes - timeAndExpenses - vendorCompliance - webServices - wellsFargoPaymentManager example: accountsPayable permission-name: type: string description: Permission name readOnly: true enum: - 1099Reports - aatrix - accessLog - accountAllocationDefinitions - accountAllocationGroups - accountGroups - accountMappingStatus - accountTitleByEntity - accountingEntriesFile - accountingPeriods - accounts - accumulationTypes - achBankConfigurations - achFileGenerator - achPaymentFile - addToCheckRun - adjustAccount - adjustedAvailableCash - adjustmentJournals - adjustingJournalEntries - adjustments - aisle - analysisAndReporting - apAccountLabels - apAdvances - apBillsApprovalLevels - apLedger - apOpenItemsRevaluationReport - apReleaseRetainage - apTerms - applicationAdministration - applicationSetup - applicationSubscriptions - applyPenalties - approveBills - approveExpenses - approveJournalEntries - approvePayments - approvePurchaseTransaction - approveReimbursements - approveTimesheets - approveVendors - arAccountLabelTaxGroups - arAccountLabels - arLedger - arOpenItemsRevaluationReport - arReleaseRetainage - arTerms - archive - assignmentCategories - assignmentConstraints - assignmentDependents - assignmentStatus - assignments - assuranceDocuments - attachmentFolders - attachments - auditLog - automatedTransactions - bankAccounts - bankCheckRegister - bankFeeds - bankFile - bankFileGenerator - bankInterestAndCharges - bankTransactionAssignmentRules - bankTransactionRuleSets - bankTransactionRules - bankTransactions - billBackTemplates - billingTemplate - bills - bin - binFace - binSize - books - budgets - buildAndDisassembleKits - bulkActionRuns - caDe542Report - calculationMethods - cancelService - cashAnalysis - cashBalances - changeRequestStatus - changeRequestTypes - changeRequests - chargeCardAccounts - chargeCardRegister - chargeCardTransactions - chargePayoffs - checkReconciliation - checkRegister - checkRun - checkRunDetail - checkingAccounts - checklistCategories - checklistItem - checklistOptions - checklistStatus - checklists - checks - class - classGroups - clearCompanyData - clients - cloudStorage - cmRevaluationReport - companyInformationMyPractice - companySetupChecklist - compensationTables - complianceRecords - complianceSetup - consolidateStructure - consolidateSubsidiaryData - constructionReporting - contactTaxGroup - contacts - contract - contractBillingTemplate - contractComplianceChecklist - contractComplianceTaskItem - contractExpenseTemplate - contractGroups - contractMEAPriceList - contractPriceList - contractRevenueTemplate - contractTypes - contributions - costCodeOverrides - costTypeGroups - costTypes - costingChanges - coverLetters - creditCardChargesAndOtherFees - customApplicationsWithUserDefinedDimensions - customReports - customerAgingReportsGraphs - customerBacklog - customerBankAccounts - customerCardAccounts - customerGLGroups - customerGroups - customerListReport - customerReconciliation - customerTypes - customers - cycleCounts - dashboard - dataDeliveryService - deferredRevenueDetails - deferredRevenueForecast - deferredRevenueForecastGraph - deferredRevenueRevaluationReport - departmentActivityReport - departmentGroups - departmentMappingStatus - departments - deposits - depositsRegister - documentNumbering - drillDownToAllTransactionsFromReports - dunningLevels - earningTypes - emailDeliveryLog - emailTemplates - employeeAgingReportsGraphs - employeeGroups - employeeOutOfOffice - employeePositions - employeeRates - employeeTypes - employees - entities - entity - estimateTypes - evergreenTemplates - exchangeRate - exchangeRateTypes - executiveSummary - expenseAdjustments - expenseApprovalLevels - expenseLedger - expensePaymentTypes - expenseSummaries - expenseTypes - exportClientTaxData - extendedGeneralLedger - externalAuthorizations - fairValuePriceListEntry - fairValuePriceLists - financialInstitution - financials - form1099 - fulfillment - fundsTransfers - gaapAdjustingEntries - gaapAdjustmentJournals - ganttChart - generalLedger - generalLedgerRevaluationReport - generateAllocation - generateInvoices - generateLateCharges - generateReceipt - generateScheduledCharges - goBDDataExport - glAccountId - grantAdminRights - graphs - hourTypes - imports - initialOpenItems - interEntityAccountMapping - interactiveAccountGroups - interactiveCustomReports - interactiveDataVisualizationReports - interactiveReportAreas - interactiveReportsMasterConsumerRole - interEntityTransactions - inventoryAnalysis - inventoryControlSetup - inventoryCosting - inventoryCycles - inventoryFulfillment - inventoryJournal - inventoryRecurring - inventoryRegister - inventoryReorders - inventorySelfHelp - inventoryStatus - inventoryTotals - inventoryTransactionDefinitions - inventoryTransactions - inventoryValuation - invoicePolicies - invoices - itemActivity - itemGLGroups - itemGroups - itemProfitability - itemTaxGroups - items - jobs - journalActivityReport - journalEntries - journalEntryMappingLink - journals - kitAnalysis - laborClasses - laborShifts - laborUnions - landedCostAdjustment - landedCostsCategory - leases - linkSubsidiaries - loanTypes - loans - locationActivityReport - locationGroups - locationMappingStatus - locations - lotCategory - lotTracking - maintainInventoryValuation - manageBooks - manageContributions - managementFees - managePayments - managePlan - manageResourceSchedules - manageSchedules - manageSupplies - manageTimesheets - managersAndBrokers - manualPayment - meaAllocation - memorizedReportGroups - memorizedReports - messages - multiCurrencyProcessing - myExpenses - myTimesheets - notes - offlineJobQueue - opsbidBills - orderAnalysis - orderEntrySetup - orderEntryStatus - orderEntryTransactionDefinitions - orderEntryTransactions - otherReceipts - ownerDistribution - ownerInformation - ownershipStructure - partnerSyncEvents - payBills - payGroups - payInAdvance - paymentAccountInformation - paymentDefaults - paymentExchangeRateInformation - paymentManagerPayments - paymentRequests - payments - payrollReportCheck - payrollReportCheckSummary - payrollReportGrossPay - payrollReportPayModifier - payrollReportPtoActivity - payrollReportTax - payrollReportTaxSetup - payrollReportTimecard - payrollReportTimecardReport - pendingReimbursements - period - periodMappingStatus - physicalInventory - pickEngagements - pickList - pickingList - planStatement - poTransactionDefinitions - positionsAndSkills - postExpenseReports - postScheduledTransactions - postTemplates - postedAdvances - postedPayments - postedReimbursements - preparerSignoff - priceListEntry - priceLists - priceSchedules - printChecks - printEMailDocuments - printEMailDunningNotice - printEMailInvoices - printEMailStatements - printPaymentCopies - printedDocumentTemplates - priorPeriodCogsAdjustments - processContractSchedules - productLine - productLines - projectChangeOrders - projectContractRateTables - projectContractTypes - projectContracts - projectDetailReporting - projectEstimates - projectGroups - projectResources - projectStatus - projectTransactions - projectTypes - projects - properties - ptoAccrualSchedules - ptoTypes - purchasePriceVarianceInvoicePriceVariance - purchasingAnalysis - purchasingApprovalLevels - purchasingRecurring - purchasingSetup - purchasingTransaction - purchasingTransactions - quickCheckEntry - quickDeposits - receiptHistory - receiptsRegister - receiveAdvances - reclassificationReport - reconcileBank - reconcileCreditCard - recoveryTemplates - recurringAllocations - recurringBills - recurringInvoices - recurringJournalEntries - recurringSchedules - recurringStatisticalJournalEntries - recurringTransactionForecast - recurringTransactionStatus - recurringTransactions - releaseToPay - renewalTemplates - renewalsForecast - replenishInventory - replenishmentFluctuatingForecasts - reporting - reportingAccounts - reportingAccountsMappingReport - reportingPeriods - requestSupplies - restrictionRelease - revenueRecognitionCategory - revenueRecognitionSchedule - revenueRecognitionTemplate - reverseConversions - reviewNote - reviewerSignoff - row - ruleSetPerformanceLog - runConsolidations - saasChangeType - saasSchedule - saasScheduleEntry - salesAnalysis - salesRecurring - salesTaxReport - salesforceSyncJobs - salesforceSynchronizationReport - salesforceSynchronizationStatus - sandbox - savingsAccounts - selectToReimburse - sendgridEmailDeliveryLog - serialMask - serialTracking - serviceAuthorizations - sharedLimits - shipmentHistory - shippingMethods - smartEventJobs - spendInsight - staffTimesheets - standardCostTypes - standardTasks - statisticalAccountId - statisticalAccountMappingStatus - statisticalAccounts - statisticalAdjustingJournals - statisticalAdjustingJournalEntries - statisticalJournalEntries - statisticalJournals - subledgerAndScmCombinedObjects - subledgerDocument - subscriptionUsage - subsidiaryAccounts - subsidiaryDepartments - subsidiaryLocations - subsidiaryReportingPeriods - subsidiaryStatisticalAccounts - summaries - switchToConsole - switchToManagementConsole - switchToMyAccounting - systemPayModifiers - t5018ReportForCanada - taskGroups - taskResources - taskTypes - tasks - taxAdjustingEntries - taxAdjustmentJournals - taxAuthority - taxDetail - taxReciprocity - taxRecords - taxSchedule - taxScheduleMap - taxSolutions - taxSubmissions - taxablePaymentsAnnualReport - taxes - taxesLink - templates - tenants - tenantConfiguration - territories - territoryGroups - timePreferences - timeSources - timeTypes - timeCards - timesheetRules - trades - transactionAllocations - transactionCurrencies - transactionRule - transactionTemplates - trialBalance - triggerLogs - unions - units - unitsOfMeasure - usageAndMetrics - userDefinedBooks - userDefinedJournalEntries - userDefinedJournals - users - vendorAgingReportsGraphs - vendorException - vendorGLGroups - vendorGroups - vendorInsuranceReport - vendorReconciliation - vendorTypes - vendors - viewAllocationLog - viewMyClients - viewMyServiceAuthorizations - warehouseGroups - warehouseTransfer - wipManagement - warehouses - zone example: postedPayments company-config-role-permission-assignment: type: object description: List of permissions assigned to the roles for standard objects. properties: key: type: string description: System-assigned key for the role-permission-assignment. readOnly: true example: '177748' id: type: string readOnly: true description: Role permission assignment ID. Same as `key` for this object. example: '177748' href: type: string description: URL endpoint for the role permission assignment. readOnly: true example: /objects/company-config/role-permission-assignment/177748 role: type: object description: Role object readOnly: true properties: key: type: string description: Role key. readOnly: true example: '528' id: type: string description: Role id. readOnly: true example: '::SYS::Multi Entity Shared-ROLE-FOR - EMP4-US' href: type: string description: URL for the roles. readOnly: true example: /objects/roles/528 permission: type: object description: Permission object properties: key: type: string description: Permission key. example: '3295' id: type: string description: Permission id. example: '3295' module: $ref: '#/components/schemas/module' name: type: string allOf: - $ref: '#/components/schemas/permission-name' href: type: string description: URL for the permission. readOnly: true example: /objects/company-config/permission/3295 accessRights: type: array description: Permission access rights. example: - list - readonly - add - modify - delete items: $ref: '#/components/schemas/permission-access-rights' audit: $ref: '#/components/schemas/audit' company-config-role-user-map: type: object description: Map of roles assigned to users. properties: key: type: string description: System-assigned key for the role-user-map. readOnly: true example: '23' id: type: string description: Role users map ID. readOnly: true example: '23' href: type: string description: Endpoint for the role-user-map. readOnly: true example: /objects/company-config/role-user-map/23 role: type: object description: Role object readOnly: true properties: key: type: string description: Role key. readOnly: true example: '469' id: type: string description: Role name readOnly: true example: Admin role href: type: string description: Endpoint for the roles. readOnly: true example: /objects/company-config/role/469 user: type: object description: User object readOnly: true properties: key: type: string description: User key. readOnly: true example: '189' id: type: string description: User login ID. readOnly: true example: Admin href: type: string description: Endpoint for the user. readOnly: true example: /objects/company-config/user/189 audit: $ref: '#/components/schemas/audit' company-config-role-user-group-map: type: object description: Map of roles assigned to user groups. properties: key: type: string description: Role group key. readOnly: true example: '761' id: type: string description: Role group id. readOnly: true example: '761' href: type: string description: Endpoint for the role user group map. readOnly: true example: /objects/company-config/role-user-group-map/761 role: type: object description: Role object readOnly: true properties: key: type: string description: Role key. readOnly: true example: '805' id: type: string description: Role name. readOnly: true example: '::SYS::Multi Entity Shared-ROLE-FOR - Aaron' href: type: string description: Endpoint for the roles. readOnly: true example: /objects/company-config/role/805 userGroup: type: object description: User object readOnly: true properties: key: type: string description: User group key. readOnly: true example: '1' id: type: string description: User group name. readOnly: true example: Bypass group href: type: string description: Endpoint for the user group. readOnly: true example: /objects/company-config/user-group/1 audit: $ref: '#/components/schemas/audit' company-config-role: type: object description: List of roles. properties: key: type: string description: Role key readOnly: true example: '24' id: type: string description: Role Id example: Employee href: type: string description: URL for the role readOnly: true example: /objects/company-config/role/24 description: type: string description: Description example: Full employee permissions including approvals roleType: type: string description: Role type example: enterprise enum: - enterprise - eConsole - multiEntityDistributed - multiEntityShared default: enterprise applyTo: type: string description: Role is applicable to users with specified access method. example: loginAndSlideIn enum: - loginAndSlideIn - loginOnly - slideInOnly default: loginAndSlideIn rolePermissionAssignments: type: array description: List of permission assignments for a specific role items: $ref: '#/components/schemas/company-config-role-permission-assignment' roleUsers: type: array description: Map of roles assigned to users readOnly: true items: $ref: '#/components/schemas/company-config-role-user-map' roleGroups: type: array description: Map of roles assigned to user groups readOnly: true items: $ref: '#/components/schemas/company-config-role-user-group-map' audit: $ref: '#/components/schemas/audit' company-config-permission: type: object description: List of permissions. properties: key: type: string description: Permission key readOnly: true example: '24' id: type: string description: Permission Id readOnly: true example: '24' href: type: string readOnly: true example: /objects/company-config/permission/24 module: $ref: '#/components/schemas/module' name: $ref: '#/components/schemas/permission-name' permissionGroup: type: string description: The group a permission belongs to readOnly: true nullable: true enum: - null - activitiesAndLists - reports - objectIds example: activitiesAndLists allowedAccessRights: type: array description: Allowed access rights for this permission readOnly: true example: - list - readonly - void items: $ref: '#/components/schemas/permission-access-rights' construction-project-change-orderRequiredProperties: type: object required: - project - projectChangeOrderDate - item - priceEffectiveDate schedule-calendar: type: object properties: scheduledStartDate: type: string description: Scheduled start date format: date example: '2021-06-15' actualStartDate: type: string description: Actual start date format: date example: '2021-06-30' scheduledCompletionDate: type: string description: Scheduled completion date format: date example: 2022-11-15' revisedCompletionDate: type: string description: Revised completion date format: date example: '2021-12-15' substantialCompletionDate: type: string description: Substantial completion date format: date example: '2021-09-30' actualCompletionDate: type: string description: Actual completion date format: date example: '2021-12-15' noticeToProceedDate: type: string description: Notice to proceed date format: date example: '2021-05-30' responseDueDate: type: string description: Response due date format: date example: '2021-06-05' executedOnDate: type: string description: Executed on date format: date example: '2021-06-01' scheduleImpact: type: string description: Schedule Impact example: None 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' attachment-ref: type: object description: Supporting document ID. properties: key: type: string description: Attachment key example: '6' id: type: string description: Attachment id example: att-1 href: type: string description: URL of the attachment example: /objects/company-config/attachment/6 readOnly: true construction-project-change-order: type: object description: A project change order consolidates change requests for a project. properties: key: type: string description: System-assigned key of the project change order example: '5' readOnly: true id: type: string description: > Unique identifier of the project change order. You must specify a unique ID when creating a project change order unless document sequencing is configured, in which case the ID is auto-generated. example: PCO-BTI-1 href: type: string description: URL endpoint of the project change order example: /objects/construction/project-change-order/5 readOnly: true project: type: object description: Reference to a project that the change order should be applied to. properties: key: type: string description: Project key example: '1' id: type: string description: Project id example: DIM-BTI name: type: string description: Project name example: Dimensions - Berkeley Technology Inc readOnly: true href: type: string description: URL endpoint of the project example: /objects/projects/project/1 readOnly: true location: type: object description: Reference to a location specified in the project. readOnly: true properties: key: type: string description: Location key example: '1' readOnly: true id: type: integer description: Location ID example: SEA readOnly: true name: type: string description: Location name example: Seattle readOnly: true href: type: string description: URL endpoint of the location example: /objects/company-config/location/1 readOnly: true projectChangeOrderDate: type: string format: date description: Project change order date example: '2023-10-15' state: type: string description: Project change order state example: draft enum: - draft - posted default: draft changeRequestStatus: type: object description: Reference to a change request status properties: key: type: string example: '1' id: type: string example: Pending href: type: string description: URL endpoint of the change request status example: /objects/construction/change-request-status/1 readOnly: true description: type: string description: Description of the project change order. example: Change order 1 for NW Food Warehouse projectContract: type: object description: Reference to a project contract properties: key: type: string example: '1' id: type: string example: PJ-CONT-145 name: type: string readOnly: true example: Gymnasium href: type: string description: URL endpoint of the project contract example: /objects/construction/project-contract/1 readOnly: true projectContractLine: type: object description: >- Reference to a project contract line that is part of the project contract. properties: key: type: string example: '1' id: type: string example: MT-99-04 name: type: string readOnly: true example: Materials href: type: string description: URL endpoint of the project contract line example: /objects/construction/project-contract-line/1 readOnly: true priceEffectiveDate: type: string format: date description: Price effective date example: '2023-09-15' totalCost: type: string format: decimal-precision-2 description: Total cost example: '1575.25' readOnly: true totalPrice: type: string format: decimal-precision-2 description: Total price example: '2575.25' readOnly: true sendToContact: type: object description: Reference to a contact properties: key: type: string example: '4' id: type: string example: Chandler href: type: string description: URL endpoint of the contact example: /objects/company-config/contact/4 readOnly: true item: type: object description: Reference to an item properties: key: type: string example: '21' id: type: string example: Maintenance name: type: string readOnly: true example: Maintenance href: type: string description: URL endpoint of the contact example: /object/item/4 readOnly: true customer: type: object description: Reference to a customer properties: key: type: string description: Customer Key example: '14' readOnly: true id: type: string description: Customer ID example: BTI readOnly: true name: type: string description: Customer Name example: Berkeley Technologies Inc readOnly: true href: type: string description: URL endpoint of the customer example: /objects/accounts-receivable/customer/14 readOnly: true readOnly: true scope: type: string description: Scope example: Design inclusions: type: string description: Inclusions example: Original plan exclusions: type: string description: Exclusions example: Hardware accessories terms: type: string description: Terms example: Standard terms and conditions schedule: $ref: '#/components/schemas/schedule-calendar' internalReference: $ref: '#/components/schemas/internal-document-ref' externalReference: $ref: '#/components/schemas/external-document-ref' attachment: $ref: '#/components/schemas/attachment-ref' status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' construction-change-requestRequiredProperties: type: object required: - id - project - changeRequestDate workflow-type-default-none-ref: type: string description: Workflow type to use example: revision enum: - none - original - revision - forecast - approvedChange - pendingChange - other default: none construction-change-request-line: type: object description: Information about a change request line. properties: key: type: string description: System-assigned key for the change request line. readOnly: true example: '1' id: type: string description: >- Unique identifier for the change request line. Same as `key` for this object. readOnly: true example: '1' href: type: string description: URL endpoint of the change request line. example: /objects/construction/change-request-line/1 readOnly: true changeRequest: type: object description: Reference to the change request that this line belongs to. readOnly: true properties: key: type: string description: System-assigned key for the change request. readOnly: true example: '4' id: type: string description: Unique identifier for the change request. readOnly: true example: '003' href: type: string description: URL endpoint for the change request. readOnly: true example: /objects/construction/change-request/4 workflowType: $ref: '#/components/schemas/workflow-type-default-none-ref' dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Reference to the location of the project on the change request line. readOnly: true properties: key: type: string description: System-assigned key for the location. readOnly: true example: '1' id: type: string description: Unique identifier for the location. readOnly: true example: '1' name: type: string description: Name of the location. readOnly: true example: United States of America href: type: string description: URL of the location. readOnly: true example: /objects/company-config/location/1 department: type: object description: Reference to the department on the change request line. properties: key: type: string description: System-assigned key for the department. example: '3' id: type: string description: Unique identifier for the department. example: '3' name: type: string description: Name of the department. readOnly: true example: Engineering href: type: string description: URL of the department. example: /objects/company-config/department/3 readOnly: true numberOfProductionUnits: type: string description: >- Number of production units, which are units that track several inputs of cost (such as for material, labor, equipment). example: '1200' productionUnitDescription: type: string description: Description for the production unit derived from the task. readOnly: true example: linear feet siding quantity: type: string description: Quantity for the change request line. format: decimal-precision-2 example: '10.00' externalUOM: type: string description: External unit of measure. nullable: true example: each unitCost: type: string description: Unit cost for the change request line. format: decimal-precision-2 example: '50.00' cost: type: string description: Total cost for the change request line. format: decimal-precision-2 example: '250.00' unitPrice: type: string description: Unit price for the change request line. format: decimal-precision-2 example: '50.00' price: type: string description: Total price for the change request line. format: decimal-precision-2 example: '250.00' priceMarkupPercent: type: string description: Price markup percent for the change request line. format: decimal-precision-2 example: '5.00' priceMarkupAmount: type: string description: Price markup amount for the change request line. format: decimal-precision-2 example: '300.00' linePrice: type: string description: Line price for the change request line. format: decimal-precision-2 readOnly: true example: '750.00' projectChangeOrder: type: object description: Reference to the project change order. readOnly: true properties: key: type: string description: System-assigned key for the project change order. readOnly: true example: '4' id: type: string description: Unique identifier for the project change order. readOnly: true example: '003' href: type: string description: URL endpoint of the project change order. readOnly: true example: /objects/construction/project-change-order/4 memo: type: string description: Memo for the change request line. example: Awaiting approval projectEstimate: type: object description: Reference to the project estimate. readOnly: true properties: key: type: string description: System-assigned key for the project estimate. readOnly: true example: '1' id: type: string description: Unique identifier for the project estimate. readOnly: true example: BTI-01 href: type: string description: URL endpoint of the project estimate. readOnly: true example: /objects/construction/project-estimate/1 glAccount: type: object description: Reference to the General Ledger account. allOf: - $ref: '#/components/schemas/gl-account-ref' projectContract: type: object description: >- Reference to the project contract affected by this change request line. properties: key: type: string description: System-assigned key for the project contract. example: '1' id: type: string description: Unique identifier for the project contract. example: BTI-01 name: type: string description: Name of the project contract. readOnly: true example: Berkeley Technology Inc - Contract 01 href: type: string description: URL of the project contract. readOnly: true example: /objects/construction/project-contract/1 projectContractLine: type: object description: >- Reference to the specific project contract line that is affected by this change request line. properties: key: type: string description: System-assigned key for the project contract line. example: '4' id: type: string description: Unique identifier for the project contract line. example: Project-Contract-Line-04 name: type: string description: Name of the project contract line. readOnly: true example: Project contract line 04 href: type: string description: URL of the project contract line. readOnly: true example: /objects/construction/project-contract-line/4 audit: $ref: '#/components/schemas/audit' construction-change-request: type: object description: Information about each change request. properties: key: type: string description: System-assigned key for the change request. readOnly: true example: '12' id: type: string description: Unique identifier for the change request. maxLength: 40 example: CR-12 href: type: string description: URL endpoint of the change request. example: /objects/construction/change-request/12 readOnly: true project: type: object description: Reference to the project. properties: key: type: string description: System-assigned key for the project. example: '2' id: type: string description: Unique identifier for the project. example: NET-XML30-2 name: type: string description: User-specified name for the project. readOnly: true example: Talcomp training href: type: string description: URL for the project. readOnly: true example: /objects/projects/project/2 projectCustomer: type: object description: Reference to the project customer. readOnly: true properties: key: type: string description: System-assigned key for the customer. readOnly: true example: '13' id: type: string description: Unique identifier for the customer. readOnly: true example: CUST-13 name: type: string description: Name of the customer. readOnly: true example: Jack In the Box href: type: string description: URL endpoint of the customer. readOnly: true example: /objects/accounts-receivable/customer/13 changeRequestDate: type: string format: date description: Date of the change request. example: '2024-01-24' description: type: string description: Description of the change request. example: Change Request 12 maxLength: 1000 changeRequestStatus: type: object description: Reference to the change request status. properties: key: type: string description: System-assigned key for the change request status. example: '12' id: type: string description: Unique identifier for the change request status. example: CRStatus-12 workflowType: type: string allOf: - $ref: '#/components/schemas/workflow-type-default-none-ref' readOnly: true href: type: string description: URL endpoint of the change request status. readOnly: true example: /objects/construction/change-request-status/12 changeRequestType: type: object description: >- Reference to the change request type. This is useful for reporting purposes. properties: key: type: string description: System-assigned key for the change request type. example: '12' id: type: string description: Unique identifier for the change request type. example: CRType-12 href: type: string description: URL endpoint of the change request type. readOnly: true example: /objects/construction/change-request-type/12 changeRequestState: type: string description: >- State of the change request. Use 'draft' to save without posting, or 'posted' to allow posting to proceed as configured. enum: - draft - posted default: draft example: draft costEffectiveDate: type: string format: date description: >- Cost effective date of the change request. When posting change request lines to a project estimate, the estimate line `effectiveDate` field will be populated from this value. If the `costEffectiveDate` is null, the estimate line `effectiveDate` field will be populated from the `changeRequestDate`. example: '2022-01-24' priceEffectiveDate: type: string format: date description: Price effective date of the change request. example: '2022-01-24' totalCost: type: string format: decimal-precision-2 description: Total cost of the change request. readOnly: true example: '1500.50' totalPrice: type: string format: decimal-precision-2 description: Total price of the change request. readOnly: true example: '1975.50' projectChangeOrder: type: object description: >- Reference to the project change order to link to. This is only allowed if the `changeRequestState` is `posted`. properties: key: type: string description: System-assigned key for the project change order. example: '5' id: type: string description: Unique identifier for the project change order. example: PCO-BTI-1 href: type: string description: URL endpoint of the project change order. readOnly: true example: /objects/construction/project-change-order/5 projectContractLineSource: type: string description: > Project contract line source - where this change request integrates with project contracts. * `none` - projectContract and projectContractLine cannot be used. * `projectChangeOrder` - projectContract and projectContractLine are inherited from the projectChangeOrder. * `changeRequest` - projectContract and projectContractLine can be used on the change request and will be inherited by the change request lines. * `changeRequestLine` - projectContract and projectContractLine can be entered on change request lines. enum: - none - projectChangeOrder - changeRequest - changeRequestLine default: projectChangeOrder example: projectChangeOrder projectContract: type: object description: >- Reference to the project contract affected by this change request. Requires `projectContractLine`. properties: key: type: string description: System-assigned key for the project contract. example: '3' id: type: string description: Unique identifier for the project contract. example: Project-Contract-03 name: type: string description: Name of the project contract. readOnly: true example: Project contract 03 href: type: string description: URL endpoint of the project contract. readOnly: true example: /objects/construction/project-contract/3 projectContractLine: type: object description: >- Reference to the specific project contract line that is affected by this change request. Required if `projectContract` is provided. properties: key: type: string description: System-assigned key for the project contract line. example: '4' id: type: string description: Unique identifier for the project contract line. example: Project-Contract-Line-04 name: type: string description: Name of the project contract line. readOnly: true example: Project contract line 04 href: type: string description: URL endpoint of the project contract line. readOnly: true example: /objects/construction/project-contract-line/4 scope: type: string description: Details about the expected scope of work for the change request. nullable: true example: Design inclusions: type: string description: >- Details related to items that are explicitly included in the terms of this change request. nullable: true example: Original plan exclusions: type: string description: >- Details related to items that are explicitly excluded in the terms of this change request. nullable: true example: Hardware accessories terms: type: string description: Additional terms or performance obligations. nullable: true example: Standard terms and conditions schedule: $ref: '#/components/schemas/schedule-calendar' internalReference: $ref: '#/components/schemas/internal-document-ref' externalReference: $ref: '#/components/schemas/external-document-ref' location: type: object description: Reference to the location of the project on the change request. properties: key: type: string description: System-assigned key for the location. readOnly: true example: '1' id: type: string description: Unique identifier for the location. readOnly: true example: US name: type: string description: Name of the location. readOnly: true example: United States of America href: type: string description: URL endpoint of the location. readOnly: true example: /objects/company-config/location/1 readOnly: true changeRequestLines: type: array description: Change request lines. items: $ref: '#/components/schemas/construction-change-request-line' attachment: $ref: '#/components/schemas/attachment-ref' audit: $ref: '#/components/schemas/audit' construction-change-request-lineRequiredProperties: type: object required: - id construction-change-request-typeRequiredProperties: type: object required: - id construction-change-request-type: type: object description: >- Create change request types to categorize change request information for reporting purposes. properties: key: type: string description: System-assigned key for the change request type. readOnly: true example: '12' id: type: string description: Unique name or ID for the change request type. maxLength: 80 example: CRType-12 href: type: string description: URL endpoint of the change request type. example: /objects/construction/change-request-type/12 readOnly: true status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' construction-change-request-statusRequiredProperties: type: object required: - id - workflowType construction-change-request-status: type: object description: A user-defined statuses for change requests. properties: key: type: string description: System-assigned key for the change request status. readOnly: true example: '12' id: type: string description: Unique name or ID for the change request status. maxLength: 80 example: Revised href: type: string description: URL endpoint of the change request status. example: /objects/construction/change-request-status/12 readOnly: true workflowType: $ref: '#/components/schemas/workflow-type-default-none-ref' status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' construction-project-contractRequiredProperties: type: object required: - name - project - customer - contractDate project-location-ref: type: object properties: key: type: string description: Location key example: '1' readOnly: true id: type: string description: Project location id example: '1' readOnly: true name: type: string description: Project location name example: United States of America readOnly: true href: type: string description: URL of the location example: /objects/company-config/location/1 readOnly: true construction-project-contract: type: object properties: key: type: string description: System-assigned key of the project contract example: '12' readOnly: true id: type: string description: > Unique identifier of the project contract. You must specify a unique ID when creating a project contract unless document sequencing is configured, in which case the ID is auto-generated. example: CONTRACT-01 href: type: string description: URL endpoint of the project contract example: /objects/construction/project-contract/12 readOnly: true name: type: string description: Project contract name example: CONTRACT-01 - NW Food Warehouse project: type: object description: >- Reference to an active project that this contract is associated with. properties: key: type: string description: Project key example: '1' id: type: string description: Project id example: DIM - BTI name: type: string description: Project name example: Dimensions - Berkeley Technology Inc readOnly: true href: type: string description: URL endpoint of the project example: /objects/projects/project/1 readOnly: true location: $ref: '#/components/schemas/project-location-ref' customer: type: object description: Reference to a customer properties: key: type: string description: Customer Key example: '14' id: type: string description: Customer ID example: BTI name: type: string description: Customer Name example: Berkeley Technology Inc readOnly: true href: type: string description: URL endpoint of the customer example: /objects/accounts-receivable/customer/14 readOnly: true contractDate: type: string format: date description: Contract date example: '2023-10-15' description: type: string description: Description example: NW Food Warehouse - Entry lobby renovation projectContractType: type: object description: Reference to a project contract type properties: key: type: string description: Project contract type key example: '2' id: type: string description: Project contract type id example: COM href: type: string description: URL endpoint of the project contract type example: /objects/construction/project-contract-type/1 readOnly: true architect: type: object description: Reference to an architect contact properties: key: type: string description: Contact key example: '12' id: type: string description: Contact id example: Eberhardt href: type: string description: URL endpoint of the architect contact example: /objects/company-config/contact/12 readOnly: true isBillable: type: boolean description: Set to `true` if the project contract is billable. example: true default: false attachment: $ref: '#/components/schemas/attachment-ref' status: $ref: '#/components/schemas/status' summary: type: object description: Price fields readOnly: true properties: totalPrice: type: string format: decimal-precision-2 description: Total price example: '1050.85' readOnly: true originalPrice: type: string format: decimal-precision-2 description: Original price example: '850.00' readOnly: true revisionPrice: type: string format: decimal-precision-2 description: Revision price example: '1050.85' readOnly: true approvedChangePrice: type: string format: decimal-precision-2 description: Approved change price example: '900.00' readOnly: true pendingChangePrice: type: string format: decimal-precision-2 description: Pending change price example: '150.85' readOnly: true otherPrice: type: string format: decimal-precision-2 description: Other price example: '0.00' readOnly: true forecastPrice: type: string format: decimal-precision-2 description: Forecast price example: '0.00' readOnly: true billing: type: object description: Billing properties: billedPrice: type: string format: decimal-precision-2 description: Billed price example: '1500.00' readOnly: true totalBilledNetRetainage: type: string format: decimal-precision-2 description: Total billed net retainage example: '1000.00' readOnly: true percentBilled: type: string format: decimal-precision-2 description: Percentage billed example: '100.00' readOnly: true percentBilledNetRetainage: type: string format: decimal-precision-2 description: Percentage billed net retainage example: '67.00' readOnly: true totalRetainageHeld: type: string format: decimal-precision-2 description: Total retainage held example: '500.00' readOnly: true totalRetainageReleased: type: string format: decimal-precision-2 description: Total retainage released example: '250.00' readOnly: true retainageBalance: type: string format: decimal-precision-2 description: Retainage balance example: '250.00' readOnly: true balanceToBill: type: string format: decimal-precision-2 description: Balance to bill example: '500.00' readOnly: true balanceToBillNetRetainage: type: string format: decimal-precision-2 description: Balance to bill net retainage example: '250.00' readOnly: true totalPaymentsReceived: type: string format: decimal-precision-2 description: Total payments received example: '1000.00' readOnly: true netTotalBilled: type: string format: decimal-precision-2 description: Net total billed example: '1000.00' readOnly: true netTotalPaymentsReceived: type: string format: decimal-precision-2 description: Net total payments received example: '1000.00' readOnly: true subtotalBilledAsTax: type: string format: decimal-precision-2 description: Subtotal billed as tax example: '150.00' readOnly: true subtotalBilledAsDiscount: type: string format: decimal-precision-2 description: Subtotal billed as discount example: '100.00' readOnly: true subtotalBilledAsCharge: type: string format: decimal-precision-2 description: Subtotal billed as charge example: '0.00' readOnly: true lastApplicationNumber: type: string description: Last billing application number example: A-123 excludeFromWIPReporting: type: boolean description: Set to `true to exclude the contract from work in progress reports. example: true default: false scope: type: string description: Scope example: Design inclusions: type: string description: Inclusions example: Original plan exclusions: type: string description: Exclusions example: Hardware accessories terms: type: string description: Terms example: Standard terms and conditions schedule: $ref: '#/components/schemas/schedule-calendar' internalReference: $ref: '#/components/schemas/internal-document-ref' externalReference: $ref: '#/components/schemas/external-document-ref' audit: $ref: '#/components/schemas/audit' construction-project-contract-lineRequiredProperties: type: object required: - id construction-project-contract-line-entry: type: object properties: key: type: string description: System-assigned key of the project contract line entry example: '1' readOnly: true id: type: string description: >- Unique identifier of the project contract line entry. Same as `key` for this object. example: '1' readOnly: true href: type: string description: URL endpoint of the project contract line entry example: /objects/construction/project-contract-line-entry/1 readOnly: true projectContractLine: type: object description: Reference to the project contract line that owns this entry. properties: key: type: string description: Project contract line key readOnly: true example: '4' id: type: string description: Project contract line ID readOnly: true example: '003' href: type: string description: URL endpoint of the project contract line example: /objects/construction/project-contract-line/4 readOnly: true workflowType: type: string description: Workflow type to use example: revision enum: - original - revision - forecast - other default: original dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object properties: key: type: string description: Location key example: '1' id: type: string description: Location id example: '1' name: type: string description: Location name example: United States of America readOnly: true href: type: string description: URL endpoint of the location example: /objects/company-config/location/1 readOnly: true department: type: object properties: key: type: string description: Department key example: '3' id: type: string description: Department id example: '3' name: type: string description: Department name example: Engineering readOnly: true href: type: string description: URL endpoint of the department example: /objects/company-config/department/3 readOnly: true quantity: type: string format: decimal-precision-2 description: Quantity example: '10.00' externalUOM: type: string description: External UOM example: each unitPrice: type: string format: decimal-precision-2 description: Unit price example: '50.00' price: type: string format: decimal-precision-2 description: Price example: '250.00' priceMarkupPercent: type: string format: decimal-precision-2 description: Price markup percent example: '5.00' priceMarkupAmount: type: string format: decimal-precision-2 description: Price markup amount example: '300.00' linePrice: type: string format: decimal-precision-2 description: Line price example: '750.00' memo: type: string description: Memo example: Awaiting approval priceEffectiveDate: type: string format: date description: Price effective date example: '2023-10-21' audit: $ref: '#/components/schemas/audit' construction-project-contract-line: type: object description: Line entry in a project contract. properties: key: type: string description: System-assigned key of the project contract line example: '2' readOnly: true id: type: string description: Unique identifier of the project contract line example: '2' href: type: string description: URL endpoint of the project contract line example: /objects/construction/project-contract-line/2 readOnly: true projectContract: type: object description: Reference to the project contract that this line belongs to. properties: key: type: string description: Project contract key example: '1' id: type: string description: Project contract ID example: BTI-01 name: type: string description: Project contract name example: Berkeley Technology Inc - Contract 01 readOnly: true href: type: string description: URL endpoint of the projectContract example: /objects/construction/project-contract/1 readOnly: true name: type: string description: Project contract line name example: 'BTI-01: line 2' parent: type: object description: >- For nesting lines, the parent project contract line of this project contract line. properties: key: type: string description: Parent project contract line key example: '1' id: type: string description: Parent project contract line id example: PJ-CO-145 name: type: string description: Parent project contract line name example: 'BTI-01: line 1' readOnly: true href: type: string description: URL endpoint of the parent project contract line example: /objects/construction/project-contract-line/1 readOnly: true description: type: string description: Description of the project contract line. example: Additional services contractLineDate: type: string format: date description: Project contract line date example: '2021-10-06' glAccount: $ref: '#/components/schemas/gl-account-ref' retainagePercentage: type: string format: decimal-precision-2 description: Retainage percentage example: '10.00' isBillable: type: boolean description: Set to `true if contract line is billable. example: true default: false billing: type: object properties: billedPrice: type: string format: decimal-precision-2 description: Billed price example: '1500.00' readOnly: true previouslyAppliedPrice: type: string format: decimal-precision-2 description: Previously applied price, to date example: '500.00' readOnly: true externalReferenceNumber: type: string description: External reference number example: REF-01 billedNetRetainage: type: string format: decimal-precision-2 description: Billed net retainage example: '500.00' readOnly: true percentBilled: type: string format: decimal-precision-2 description: Percentage billed example: '50.00' readOnly: true percentBilledNetRetainage: type: string format: decimal-precision-2 description: Percentage billed net retainage example: '5.00' readOnly: true retainageHeld: type: string format: decimal-precision-2 description: Retainage held example: '250.00' readOnly: true retainageReleased: type: string format: decimal-precision-2 description: Retainage released example: '250.00' readOnly: true retainageBalance: type: string format: decimal-precision-2 description: Retainage balance example: '250.00' readOnly: true paymentsReceived: type: string format: decimal-precision-2 description: Payments received example: '1250.00' readOnly: true billingSetup: type: object properties: billingType: type: string description: Billing type to use in project contract line. example: timeAndMaterial enum: - progressBill - timeAndMaterial default: progressBill maximumBilling: type: string description: Maximum billing to use in project contract line. example: specifiedAmount enum: - totalPrice - specifiedAmount - noMaximum default: totalPrice maximumBillingAmount: type: string format: decimal-precision-2 description: Maximum billing amount example: '10000.00' summarizeBill: type: boolean description: Summarize to a single entry example: true default: false summary: type: object description: Pricing for the project contract line. properties: originalPrice: type: string description: Original price format: decimal-precision-2 example: '500.00' revisionPrice: type: string description: Revision price format: decimal-precision-2 example: '650.00' forecastPrice: type: string description: Forecast price format: decimal-precision-2 example: '750.00' approvedChangePrice: type: string description: Approved change price format: decimal-precision-2 example: '650.00' pendingChangePrice: type: string description: Pending change price format: decimal-precision-2 example: '100.00' otherPrice: type: string description: Other price format: decimal-precision-2 example: '90.50' totalPrice: type: string description: Total price format: decimal-precision-2 example: '1048.50' dimensions: type: object description: Dimensions set for this project contract line. allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: $ref: '#/components/schemas/project-location-ref' customer: type: object properties: key: type: string description: Customer key example: '14' id: type: string description: Customer id example: BTI name: type: string description: Customer name example: Berkeley Technology Inc readOnly: true href: type: string description: URL endpoint of the customer example: /objects/accounts-receivable/customer/14 readOnly: true department: type: object properties: key: type: string description: Department key example: '3' id: type: string description: Department id example: '3' name: type: string description: Department name example: Engineering readOnly: true href: type: string description: URL endpoint of the department example: /objects/company-config/department/3 readOnly: true excludeFromGLBudget: type: boolean description: Set to `true` to exclude this line from the from GL budget. example: true default: false scope: type: string description: Scope example: Design inclusions: type: string description: Inclusions example: Original plan exclusions: type: string description: Exclusions example: Hardware accessories terms: type: string description: Terms example: Standard terms and conditions schedule: $ref: '#/components/schemas/schedule-calendar' internalReference: $ref: '#/components/schemas/internal-document-ref' externalReference: $ref: '#/components/schemas/external-document-ref' rateTables: type: object properties: default: type: object description: Default rate table for billing this project contract line. properties: key: type: string description: Rate table key example: '1' id: type: string description: Rate table ID example: RT-DEFAULT href: type: string description: URL endpoint of the rate table example: /objects/construction/rate-table/1 readOnly: true timesheet: type: object description: Rate table to use for timesheets recorded on the line. properties: key: type: string description: Rate table key example: '2' id: type: string description: Rate table ID example: RT-TIMESHEET href: type: string description: URL endpoint of the rate table example: /objects/construction/rate-table/2 readOnly: true purchasing: type: object description: Rate table for contract purchases recorded on this line. properties: key: type: string description: Rate table key example: '3' id: type: string description: Rate table ID example: RT-PURCHASING href: type: string description: URL endpoint of the rate table example: /objects/construction/rate-table/3 readOnly: true ap: type: object description: >- Rate table for accounts payable transactions on this contract line. properties: key: type: string description: Accounts Payable rate table key example: '4' id: type: string description: Rate table ID example: RT-AP href: type: string description: URL endpoint of the rate table example: /objects/construction/rate-table/4 readOnly: true gl: type: object description: >- Rate table for general ledger transactions on this contract line. properties: key: type: string description: Rate table key example: '5' id: type: string description: Rate table ID example: RT-GL href: type: string description: URL endpoint of the rate table example: /objects/construction/rate-table/5 readOnly: true creditCard: type: object description: Rate table for credit card transactions on this contract line. properties: key: type: string description: Rate table key example: '6' id: type: string description: Credit Card rate table ID example: RT-CREDITCARD href: type: string description: URL endpoint of the rate table example: /objects/construction/rate-table/6 readOnly: true employeeExpense: type: object description: Rate table for employee expenses on this contract line. properties: key: type: string description: Rate table key example: '7' id: type: string description: Rate table ID example: RT-EMPEXPENSE href: type: string description: URL endpoint of the rate table example: /objects/construction/rate-table/7 readOnly: true projectContractLineEntries: type: array items: $ref: '#/components/schemas/construction-project-contract-line-entry' changeRequestEntries: type: array description: Change requests applied to this contract line. items: $ref: '#/components/schemas/construction-change-request-line' attachment: $ref: '#/components/schemas/attachment-ref' status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' construction-project-contract-typeRequiredProperties: type: object required: - id construction-project-contract-type: type: object properties: key: type: string description: Key of the project contract type example: '2' readOnly: true id: type: string description: Unique identifier of the project contract type example: COM name: type: string description: Project contract type name example: Commercial href: type: string description: URL endpoint of the project contract type example: /objects/construction/project-contract-type/2 readOnly: true status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' construction-project-estimateRequiredProperties: type: object required: - id - project workflow-type-ref: type: string description: Workflow type to use example: revision enum: - original - revision - forecast - approvedChange - pendingChange - other default: original construction-project-estimate-line: type: object description: >- Project estimate line is an amount that can be tied to cost types (categories in the work breakdown structure), tasks, items, or other aspects of your project. properties: key: type: string description: System-assigned project estimate line key. readOnly: true example: '198' id: type: string description: >- Unique identifier for the project estimate line. Same as `key` for this object. readOnly: true example: '198' href: type: string description: Endpoint for the project estimate line. readOnly: true example: /objects/construction/project-estimate-line/1 amount: type: string format: decimal-precision-2 description: Amount for the project estimate line. example: '2000.00' quantity: type: string description: Quantity for the project estimate line. example: '10' unitCost: type: string format: decimal-precision-2 description: Unit rate for the project estimate line. example: '1000.00' currency: type: string description: Currency for the project estimate line. readOnly: true example: USD memo: type: string description: Memo for the project estimate line. Use 2000 or fewer characters. example: service charges lineNumber: type: integer description: System-assigned line number for the line. readOnly: true example: 1 externalUOM: type: string description: External unit of measure. example: Piece workflowType: $ref: '#/components/schemas/workflow-type-ref' isPosted: type: boolean description: >- Set to `true` to post this line to the budget specified in the project estimate. Set to `false` to unpost and deletes any existing GL budget lines for this estimate line. default: false example: false effectiveDate: type: string description: >- Date that the transaction line comes into effect from a GL budget or reporting perspective. format: date example: '2023-06-23' numberOfProductionUnits: type: integer description: >- Number of production units, which are units that track several inputs of cost (such as for material, labor, equipment). example: 200 productionUnitDescription: type: string description: Description for the production unit derived from the task. readOnly: true example: days projectEstimate: type: object readOnly: true description: Reference to the project estimate. properties: key: type: string description: System-assigned project estimate record number (key). readOnly: true example: '1' id: type: string description: Unique identifier for the project estimate. readOnly: true example: Original href: type: string description: URL for the project estimate. readOnly: true example: /objects/construction/project-estimate/15 glAccount: $ref: '#/components/schemas/gl-account-ref' changeRequest: type: object readOnly: true description: Reference to the change request that owns the `changeRequestLine`. properties: key: type: string description: System-assigned unique key of the change request. readOnly: true example: '14' id: type: string description: Unique identifier of the change request. readOnly: true example: CR-TM-02 href: type: string description: URL endpoint of the change request. readOnly: true example: /objects/construction/change-request/14 changeRequestLine: type: object description: >- Reference to the change request line that is reflected in this project estimate line. readOnly: true properties: key: type: string description: System-assigned key of the change request line. readOnly: true example: '19' id: type: string description: Identifier for the change request line. readOnly: true example: '19' href: type: string description: URL endpoint for the change request line. readOnly: true example: /objects/construction/change-request-line/19 dimensions: type: object description: Dimensions active on this project estimate line. allOf: - $ref: '#/components/schemas/dimension-ref' - properties: department: type: object description: Reference to the department. properties: key: type: string description: Department key. example: '1' id: type: string description: Unique identifier for the department. example: Dept 11 name: type: string description: User-specified name for the department. readOnly: true example: Engineering location: type: object allOf: - $ref: '#/components/schemas/location-ref' - properties: id: type: string description: Unique identifier for the Location. example: '1' audit: $ref: '#/components/schemas/audit' construction-project-estimate: type: object description: >- A project estimate lets you compare estimated costs for a project against the actual amounts posted. properties: key: type: string description: >- System-assigned unique key for the project estimate. Used to identify the estimate in URLs or JSON bodies for all operations. readOnly: true example: '427' id: type: string description: > Unique identifier of the project estimate. You must specify a unique ID when creating a project estimate unless document sequencing is configured, in which case the ID is auto-generated. example: BTI-Estimate-01 href: type: string description: Endpoint for the project estimate. readOnly: true example: /objects/construction/project-estimate/1 description: type: string description: Description of the project estimate. example: Estimation for BTI postTo: type: string description: > Posting period for the project estimate. * `firstPeriod` - Post the amounts to the period in which the project begin date falls. * `estimateDate` - Post estimate entries to the period that corresponds with the project `estimateDate`. You can change this date, but you can't enter a date before the project begin date. * `effectiveDate` - Post each estimate line entry to the effective date for that line. Each line might post to different periods due to different effective dates. If you choose this option, enter an effective date for each entry line. Multiple estimate line entries for the same GL account, dimension, and budget period are summarized and posted as a single line to the same budget period. * `allPeriods` - Spread the amounts equally across periods between the project begin and end date. example: firstPeriod enum: - firstPeriod - estimateDate - effectiveDate - allPeriods default: firstPeriod totalEstimateAmount: type: string format: decimal-precision-2 description: Total amount of the estimate. readOnly: true example: '10000.00' status: type: string description: > The project estimate status. * `active` - For current estimates. * `inactive` - For historical estimates, such as an original customer bid. * `finalized` - Lock the estimate from further changes. You can change a finalized estimate to active status at any time. example: active enum: - active - inactive - finalized default: active isPrimary: type: boolean description: >- Specifies whether the estimate is primary for the project. During create, the first estimate for a project is set to primary. This value can be changed in an update. example: false default: false isPosted: type: boolean description: >- Specifies whether the estimate is posted to GL budgets. In an update, if this is set to false, then any existing GL budgets for that project estimate will be deleted. example: false default: false estimateDate: type: string format: date description: Date of the project estimate, which must be in a budgetable period. example: '2022-06-23' currency: type: string description: Currency derived from the Project. readOnly: true example: USD budget: type: object description: >- Reference to the budget that the estimate will be posted to. The budget must have `postProjectEstimates` set to `true`. properties: key: type: string description: System-assigned unique key for the budget. example: '10' id: type: string description: Budget identifier. example: Root PJ Estimates href: type: string description: URL endpoint for the budget. example: /objects/general-ledger/budget/10 readOnly: true project: type: object description: Reference to the project that this estimate is for. properties: key: type: string description: System-assigned key of the project. nullable: false example: '27' id: type: string description: Unique identifier for the project. example: BPN-PRJ-01 name: type: string description: Name for the project. readOnly: true example: BPN-PRJ-01 beginDate: type: string format: date description: Date on which the project is scheduled to begin. readOnly: true example: '2023-06-23' endDate: type: string format: date description: Date on which the project is scheduled to end. readOnly: true example: '2023-09-23' href: type: string description: URL for the project. example: /objects/projects/project/27 readOnly: true projectEstimateType: type: object description: Reference to the project estimate type. properties: key: type: string description: System-assigned key of the project estimate type. example: '15' id: type: string description: Unique identifier of the project estimate type. example: Original workflowTypes: type: array description: >- Selected estimate line workflow types for the project estimate type. readOnly: true example: - original items: type: string nullable: true enum: - null - original - revision - forecast - approvedChange - pendingChange - other href: type: string description: URL endpoint for the project estimate type. example: /objects/construction/project-estimate-type/15 readOnly: true location: type: object description: Reference to the project location. properties: key: type: string description: System-assigned location key. readOnly: true example: '3' id: type: string description: Unique identifier for the location. readOnly: true example: SEA name: type: string description: User-specified name for the location. readOnly: true example: Seattle href: type: string description: URL endpoint for the location. example: /objects/company-config/location/3 readOnly: true readOnly: true parentProject: type: object readOnly: true description: Reference to the parent project. properties: key: type: string description: System-assigned key for the parent project. readOnly: true example: '105' id: type: string description: Unique identifier for the parent project. readOnly: true example: BPN-PRJ-01 name: type: string description: Name of the parent project. readOnly: true example: Gymnasium remodel href: type: string description: URL endpoint for the parent project. example: /objects/projects/project/105 readOnly: true customer: type: object readOnly: true description: Reference to the project customer. properties: key: type: string description: System-assigned key for the customer. readOnly: true example: '2' id: type: string description: Unique identifier for the customer. readOnly: true example: BPN-CUST-01 name: type: string description: User-specified name for the customer. readOnly: true example: City Schools href: type: string description: URL for the Customer. example: /objects/accounts-receivable/customer/15 readOnly: true projectEstimateLines: type: array description: Array of project estimate lines. items: $ref: '#/components/schemas/construction-project-estimate-line' attachment: $ref: '#/components/schemas/attachment-ref' audit: $ref: '#/components/schemas/audit' construction-project-estimate-typeRequiredProperties: type: object required: - id construction-project-estimate-type: type: object description: >- Project Estimate Type is a user defined list for categorizing project estimates for reporting purposes and for filtering which project estimate entries post to the general ledger. properties: key: type: string description: System-assigned unique key for the project estimate type. example: '1' readOnly: true id: type: string description: Unique identifier for the project estimate type. example: Original href: type: string description: Endpoint for the project estimate type. readOnly: true example: /objects/construction/project-estimate-type/1 workflowTypes: type: array description: Array of workflow types for the project estimate type. example: - original items: type: string nullable: true enum: - null - original - revision - forecast - approvedChange - pendingChange - other estimateCategory: type: string description: Category of the project estimate type. nullable: true example: originalEstimate default: null enum: - null - currentEstimate - originalEstimate - currentForecastAtCompletion - historicalForecastAtCompletion - futureForecastAtCompletion - currentForecastToCompletion - historicalForecastToCompletion - futureForecastToCompletion status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' construction-standard-cost-typeRequiredProperties: type: object required: - id - name item-ref: type: object properties: key: type: string description: Item key example: '319' id: type: string description: Item ID example: Overhead name: type: string description: Item name example: Overhead readOnly: true href: type: string description: URL of the item readOnly: true example: /objects/inventory-control/item/319 construction-standard-cost-type: type: object description: Standard cost type properties: key: type: string description: System-assigned unique key for the standard cost type. example: '3' readOnly: true id: type: string description: >- Unique identifier of the standard cost type. Used by the system to create the IDs of any cost types created from this standard cost type. 12 characters or less. example: EQ-Owned href: type: string description: URL endpoint of the standard cost type. example: /objects/construction/standard-cost-type/3 readOnly: true name: type: string description: Name of the standard cost type. example: EQ Owned description: type: string description: Description of the standard cost type. example: EQ Owned costUnitDescription: type: string description: >- Describes the unit of measure used by this cost type. For example, for a labor cost type the cost unit represents an hour of labor. For a materials cost type, the cost unit could be tons or feet or similar. example: each nullable: true status: $ref: '#/components/schemas/status' glAccount: type: object description: General ledger account associated with this cost type. properties: key: type: string description: GL Account Key. example: '256' id: type: string description: GL Account ID. example: '6252' href: type: string readOnly: true example: /objects/gl-account/256 accumulationType: type: object description: Accumulation type associated with this cost type. properties: key: type: string description: System-assigned key of the accumulation type. example: '1' id: type: string description: ID of the accumulation type. example: Equipment href: type: string example: /objects/construction/accumulation-type/1 description: URL endpoint of the accumulation type. readOnly: true parent: type: object description: >- Reference to a parent standard cost type to group standard cost types in the catalog. properties: key: type: string example: '2' id: type: string example: EQ name: type: string example: Equipment readOnly: true href: type: string example: /objects/construction/standard-cost-type/2 description: URL of the parent standard cost type readOnly: true item: $ref: '#/components/schemas/item-ref' audit: $ref: '#/components/schemas/audit' construction-cost-typeRequiredProperties: type: object required: - name - project - glAccount - item accumulation-type-ref: type: object properties: key: type: string description: Accumulation type key example: '2' id: type: string description: Accumulation type id example: Direct cost href: type: string readOnly: true example: /objects/construction/accumulation-type/2 construction-cost-type: type: object description: >- Cost type is a standard dimension used to capture and categorize project cost details in construction projects. properties: key: type: string description: System-assigned unique key for the cost type. readOnly: true example: '99' id: type: string description: >- Cost type ID. Created automatically from `id` of the `standardCostType`. readOnly: true example: EQ href: type: string description: URL endpoint of the cost type. example: /objects/construction/cost-type/2 readOnly: true name: type: string description: Name of the cost type. Does not have to be unique. example: Equipment description: type: string description: Cost type description. example: Equipment project: type: object description: Project that will use this cost type. properties: key: type: string description: Project record number. example: '109' id: type: string description: Project ID. example: 22-001 name: type: string description: Project name. readOnly: true example: Wallula Heights Conference Center href: type: string description: URL endpoint of the project. readOnly: true example: /objects/projects/project/109 task: type: object description: Task that will use this cost type. properties: key: type: string description: Task record number. example: '1410' id: type: string description: Task ID. example: 3-450 name: type: string description: Task name. readOnly: true example: Architectural Precast href: type: string description: URL endpoint of the task. readOnly: true example: /objects/projects/task/1410 accumulationType: $ref: '#/components/schemas/accumulation-type-ref' costUnitDescription: type: string description: >- Describes the unit of measure used by this cost type. For example, for a labor cost type the cost unit represents an hour of labor. For a materials cost type, the cost unit could be tons or feet or similar. example: each nullable: true glAccount: description: General ledger account associated with this cost type. allOf: - $ref: '#/components/schemas/gl-account-ref' parent: type: object description: Reference to a parent cost type to create cost type hierarchies. properties: key: type: string description: Unique identifier of the parent cost type. example: '1' id: type: string description: ID of the parent cost type. example: EQ-GRP name: type: string description: Parent cost type name. readOnly: true example: Equipment Group href: type: string description: URL endpoint of the parent cost type. readOnly: true example: /objects/construction/cost-type/1 item: description: Item associated with this cost type. allOf: - $ref: '#/components/schemas/item-ref' planned: type: object description: Cost type planned dates. properties: startDate: type: string description: Planned begin date. format: date example: '2023-01-04' endDate: type: string format: date description: Planned end date. example: '2023-02-24' actual: type: object description: Cost type actual dates. properties: startDate: type: string format: date description: Actual begin date. example: '2023-01-06' endDate: type: string format: date description: Actual end date. example: '2023-03-01' status: $ref: '#/components/schemas/status' root: type: object description: The root cost type that this cost type descends from. properties: key: type: string description: System-assigned unique ID of the root cost type. example: '13921' id: type: string description: ID of the root cost type. example: EQ name: type: string description: Root cost type name. readOnly: true example: Equipment href: type: string description: URL endpoint of the root cost type. readOnly: true example: /objects/construction/cost-type/13921 standardCostType: type: object description: The standard cost type that is the template for this cost type. properties: key: type: string description: Standard cost type record number. example: '1' id: type: string description: Standard cost type ID. example: EQ name: type: string description: Standard cost type name. readOnly: true example: Equipment href: type: string description: URL endpoint of the standard cost type. readOnly: true example: /objects/construction/cost-type/1 audit: $ref: '#/components/schemas/audit' construction-standard-taskRequiredProperties: type: object required: - id - name class-ref: type: object properties: id: type: string description: Class ID example: 1-Goods key: type: string description: Class Key example: '42' name: type: string description: Class Name readOnly: true example: Goods href: type: string readOnly: true example: /objects/company-config/class/42 construction-standard-task: description: Standard task type: object properties: key: type: string description: System-assigned key for the standard task. example: '2' readOnly: true id: type: string description: Unique identifier of the standard task. example: 1-010 href: type: string example: /objects/construction/standard-task/2 description: URL endpoint of the standard task. readOnly: true name: type: string description: Name of the standard task. example: Summary of Work description: type: string description: Description of the standard task. example: Summary of Work productionUnitDescription: type: string description: Production unit description of the standard task example: days status: $ref: '#/components/schemas/status' item: $ref: '#/components/schemas/item-ref' isBillable: type: boolean description: Set to `true` if this standard task is billable. example: true default: false isMilestone: type: boolean description: Standard task is a milestone. example: false default: false isUtilized: type: boolean description: >- Standard task is utilized. A utilized task indicates progress on a customer project or internal project. example: true default: false priority: type: number description: Priority example: '1' timeType: type: object description: Reference to a time type properties: key: type: string description: TimeType key example: '2' name: type: string description: TimeType name readOnly: true example: Hourly Salaries href: type: string example: /objects/projects/time-type/1 description: URL of the time type readOnly: true wbsCode: type: string description: Work breakdown structure code of the standard task example: '1' parent: type: object description: Reference to the parent standard task of this standard task properties: key: type: string example: '1' id: type: string example: 1-000 name: type: string example: GENERAL CONDITIONS readOnly: true href: type: string description: URL endpoint of parent standard task example: /objects/construction/standard-task/1 readOnly: true class: $ref: '#/components/schemas/class-ref' standardCostTypes: description: Array of standard cost types. type: array items: type: object properties: key: type: string example: '7' id: type: string example: LABOR href: type: string description: URL of the standard cost type example: /objects/construction/standard-cost-type/7 readOnly: true audit: $ref: '#/components/schemas/audit' construction-accumulation-type: type: object description: Accumulation Type properties: key: type: string description: System-assigned unique key for the accumulation type. readOnly: true example: '1' id: type: string description: Accumulation type ID. example: Direct cost href: type: string description: URL endpoint of the accumulation type. example: /objects/construction/accumulation-type/1 readOnly: true costCategory: type: string description: >- Standard construction project cost category to be used for this accumulation type. example: labor enum: - null - material - labor - equipment - subcontract - overhead - other nullable: true default: null status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' construction-employee-positionRequiredProperties: type: object required: - id - name construction-employee-position: type: object description: >- User-defined employee position that can be assigned to employees and used in timesheets. properties: key: type: string description: System-assigned unique key for the employee position. readOnly: true example: '11' id: type: string description: User-defined unique ID for the employee position. example: SV001 href: type: string description: URL of the employee position. example: /objects/construction/employee-position/11 readOnly: true name: type: string description: User-defined unique name for the employee position. example: Supervisor-1 description: type: string description: Description for the employee position. example: First-level supervisor status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' construction-labor-classRequiredProperties: type: object required: - id construction-labor-class: type: object description: User-defined labor class that can be used in timesheets. properties: key: type: string description: System-assigned key for the labor class. readOnly: true example: '43' id: type: string description: ID for the labor class. example: LC001 href: type: string description: URL of the labor class. example: /objects/construction/labor-class/43 readOnly: true name: type: string description: Name for the labor class. example: LC Skilled description: type: string description: Description for the labor class. example: Skilled laborer status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' construction-labor-shiftRequiredProperties: type: object required: - id construction-labor-shift: type: object description: User-defined labor shift that can be used in timesheets. properties: key: type: string description: System-assigned key for the labor shift. readOnly: true example: '31' id: type: string description: ID for the labor shift. example: LS-AM href: type: string description: URL of the labor shift. example: /objects/construction/labor-shift/31 readOnly: true name: type: string description: Name for the labor shift. example: AM shift description: type: string description: Description for the labor shift. example: Morning shift (6am-2pm) status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' construction-labor-unionRequiredProperties: type: object required: - id construction-labor-union: type: object description: User-defined labor union that can be used in timesheets. properties: key: type: string description: System-assigned key for the labor union. readOnly: true example: '3' id: type: string description: ID for the labor union. example: BAC name: type: string description: Name for the labor union. example: International Union of Bricklayers and Allied Craftworkers href: type: string description: URL of the labor union. example: /objects/construction/labor-union/3 readOnly: true description: type: string description: Description for the labor union. example: >- BAC represents all skilled trowel trades workers, including bricklayers, tile setters, plasterers, cement masons, marble masons, restoration workers, and terrazzo and mosaic workers. status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' construction-rate-tableRequiredProperties: type: object required: - id - name rate-table-ref: type: object readOnly: true properties: key: type: string readOnly: true example: '145' id: type: string readOnly: true example: 2021-LV2 name: type: string readOnly: true example: 2021 Level 2 href: type: string readOnly: true example: /objects/construction/rate-table/145 standard-cost-type-ref: type: object properties: key: type: string description: Standard cost type key example: '33' readOnly: true id: type: string description: Standard cost type id example: LAB name: type: string description: Standard cost type name example: LABOR readOnly: true href: type: string description: URL of the standard cost type readOnly: true example: /objects/construction/standard-cost-type/33 standard-task-ref: type: object properties: key: type: string description: Standard task key example: '3' readOnly: true id: type: string description: Standard task id example: 1-000 name: type: string description: Standard task name example: GENERAL CONDITIONS readOnly: true href: type: string description: URL of the standard task readOnly: true example: /objects/construction/standard-task/3 construction-rate-table-timesheet-line: type: object description: Project contract rate table line for timesheets. properties: key: type: string description: System-assigned unique key for the rate table timesheet line. example: '12' readOnly: true id: type: string description: Rate table timesheet line ID. example: '12' readOnly: true rateTable: $ref: '#/components/schemas/rate-table-ref' href: type: string example: /objects/construction/rate-table-timesheet-line/12 readOnly: true lineNumber: type: integer description: Line number example: 1 description: type: string description: Description example: Aug Costing Kit maxLength: 1000 startDate: type: string format: date description: Start date example: '2021-08-03' markupPercent: type: string format: decimal-precision-3 description: Markup %. Defaults to 0%. example: '8.250' laborRate: type: string format: decimal-precision-3 description: Labor rate example: '115.500' accumulationType: $ref: '#/components/schemas/accumulation-type-ref' standardCostType: $ref: '#/components/schemas/standard-cost-type-ref' standardTask: $ref: '#/components/schemas/standard-task-ref' employeePosition: type: object properties: key: type: string description: Employee position key example: '2' id: type: string description: Employee position id example: COO name: type: string description: Employee position name example: Chief Executive Officer readOnly: true href: type: string example: /objects/construction/employee-position/2 readOnly: true laborClass: type: object properties: key: type: string description: Labor class key example: '2' id: type: string description: Labor class id example: LC-2 name: type: string description: Labor class name example: Labor class 2 readOnly: true href: type: string example: /objects/construction/labor-class/2 readOnly: true laborShift: type: object properties: key: type: string description: Labor shift key example: '2' id: type: string description: Labor shift id example: LS-2 name: type: string description: Labor shift name example: Day shift readOnly: true href: type: string example: /objects/construction/labor-shift/2 readOnly: true laborUnion: type: object properties: key: type: string description: Labor union key example: '2' id: type: string description: Labor union id example: LU-2 name: type: string description: Labor union name example: Labor union 2 readOnly: true href: type: string example: /objects/construction/labor-union/2 readOnly: true timeType: type: object properties: key: type: string description: Time type key example: '1' id: type: string description: Time type id example: Salaries At Root name: type: string description: Time type name example: Salaries At Root readOnly: true href: type: string example: /objects/projects/time-type/1 readOnly: true dimensions: $ref: '#/components/schemas/dimension-ref' audit: $ref: '#/components/schemas/audit' construction-rate-table-purchasing-line: type: object description: Project contract rate table line for purchase orders. properties: key: type: string description: System-assigned unique key for the rate table purchase order line. example: '176' readOnly: true id: type: string description: Rate table purchase order line ID. example: '176' readOnly: true rateTable: $ref: '#/components/schemas/rate-table-ref' href: type: string example: /objects/construction/rate-table-purchasing-line/176 readOnly: true lineNumber: type: integer description: Line number example: 1 description: type: string description: Description example: Aug Costing SOPA maxLength: 1000 startDate: type: string format: date description: Start date example: '2021-08-03' markupPercent: type: string format: decimal-precision-3 description: Markup %. Defaults to 0%. example: '15.9' unitPrice: type: string format: decimal-precision-3 description: Unit price example: '112.560' accumulationType: $ref: '#/components/schemas/accumulation-type-ref' standardCostType: $ref: '#/components/schemas/standard-cost-type-ref' standardTask: $ref: '#/components/schemas/standard-task-ref' dimensions: $ref: '#/components/schemas/dimension-ref' audit: $ref: '#/components/schemas/audit' construction-rate-table-accounts-payable-line: type: object description: Project Contract rate table line for accounts payable. properties: key: type: string description: System-assigned unique key for the rate table accounts payable line. example: '397' readOnly: true id: type: string description: Rate table accounts payable line ID. Same as `key` for this object. example: '397' readOnly: true rateTable: $ref: '#/components/schemas/rate-table-ref' href: type: string description: URL endpoint of the rate table accounts payable line. example: /objects/construction/rate-table-accounts-payable-line/397 readOnly: true lineNumber: type: integer description: Line number example: 1 description: type: string description: Description example: Aug Service maxLength: 1000 startDate: type: string format: date description: Start date example: '2021-08-01' markupPercent: type: string format: decimal-precision-3 description: Markup %. Defaults to 0%. example: '25.5' accumulationType: $ref: '#/components/schemas/accumulation-type-ref' standardCostType: $ref: '#/components/schemas/standard-cost-type-ref' standardTask: $ref: '#/components/schemas/standard-task-ref' dimensions: $ref: '#/components/schemas/dimension-ref' audit: $ref: '#/components/schemas/audit' construction-rate-table-journal-line: type: object description: Project contract rate table line for general ledger. properties: key: type: string description: System-assigned unique key for the rate table journal line. example: '64' readOnly: true id: type: string description: Rate table journal line ID. example: '64' readOnly: true rateTable: $ref: '#/components/schemas/rate-table-ref' href: type: string example: /objects/construction/rate-table-journal-line/64 readOnly: true lineNumber: type: integer description: Line number example: 1 description: type: string description: Description example: Aug John Smith maxLength: 1000 startDate: type: string format: date description: Start date example: '2021-08-01' markupPercent: type: string format: decimal-precision-3 description: Markup %. Defaults to 0%. example: '12.500' accumulationType: $ref: '#/components/schemas/accumulation-type-ref' standardCostType: $ref: '#/components/schemas/standard-cost-type-ref' standardTask: $ref: '#/components/schemas/standard-task-ref' dimensions: $ref: '#/components/schemas/dimension-ref' audit: $ref: '#/components/schemas/audit' construction-rate-table-credit-card-line: type: object description: Project contract rate table line for credit cards. properties: key: type: string description: System-assigned unique key for the rate table credit card line. example: '145' readOnly: true id: type: string description: Rate table credit card line ID. example: '145' readOnly: true rateTable: $ref: '#/components/schemas/rate-table-ref' href: type: string description: URL endpoint for the rate table credit card line. example: /objects/construction/rate-table-credit-card-line/145 readOnly: true lineNumber: type: integer description: Line number example: 1 description: type: string description: Description example: Aug Costing SOPA maxLength: 1000 startDate: type: string format: date description: Start date example: '2021-08-03' markupPercent: type: string format: decimal-precision-3 description: Markup %. Defaults to 0%. example: '15.900' accumulationType: $ref: '#/components/schemas/accumulation-type-ref' standardCostType: $ref: '#/components/schemas/standard-cost-type-ref' standardTask: $ref: '#/components/schemas/standard-task-ref' dimensions: $ref: '#/components/schemas/dimension-ref' audit: $ref: '#/components/schemas/audit' construction-rate-table-employee-expense-line: type: object description: Project contract rate table line for employee expenses. properties: key: type: string description: System-assigned unique key for the rate table employee expense line. example: '30' readOnly: true id: type: string description: Rate table employee expense line ID. example: '30' readOnly: true rateTable: $ref: '#/components/schemas/rate-table-ref' href: type: string example: /objects/construction/rate-table-employee-expense-line/30 readOnly: true lineNumber: type: integer description: Line number example: 1 description: type: string description: Description example: Aug Manager maxLength: 1000 startDate: type: string format: date description: Start date example: '2021-08-02' markupPercent: type: string format: decimal-precision-3 description: Markup %. Defaults to 0%. example: '14.800' accumulationType: $ref: '#/components/schemas/accumulation-type-ref' standardCostType: $ref: '#/components/schemas/standard-cost-type-ref' standardTask: $ref: '#/components/schemas/standard-task-ref' dimensions: $ref: '#/components/schemas/dimension-ref' audit: $ref: '#/components/schemas/audit' construction-rate-table: type: object description: Header information for rate table. properties: key: type: string description: Rate table key example: '145' readOnly: true id: type: string description: Rate table ID example: 2021-LV2 maxLength: 20 name: type: string description: Rate table name. example: 2021 Level 2 maxLength: 200 description: type: string description: Description of the rate table. example: 2021 Level 2 Rate Table maxLength: 1000 location: $ref: '#/components/schemas/location-ref' audit: $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' timesheetLines: description: Timesheet lines for the rate table. type: array items: $ref: '#/components/schemas/construction-rate-table-timesheet-line' purchasingLines: type: array description: Rate table purchase order lines items: $ref: '#/components/schemas/construction-rate-table-purchasing-line' accountsPayableLines: type: array description: Rate table accounts payable lines items: $ref: '#/components/schemas/construction-rate-table-accounts-payable-line' journalLines: type: array description: Rate table general ledger lines items: $ref: '#/components/schemas/construction-rate-table-journal-line' creditCardLines: type: array description: Rate table credit card lines items: $ref: '#/components/schemas/construction-rate-table-credit-card-line' employeeExpenseLines: type: array description: Rate table employee expense lines items: $ref: '#/components/schemas/construction-rate-table-employee-expense-line' contracts-contractRequiredProperties: type: object contract-dimension-ref: type: object properties: location: type: object description: >- Location or entity associated with the contract. This field is required in a multi-entity environment. Contract lines are restricted to the specified location or entity or to a child of the location or entity. properties: key: type: string description: Location Key example: '22' id: type: string description: Location example: LOC-22 name: type: string description: Location Name readOnly: true example: California href: type: string readOnly: true example: /objects/company-config/location/731 department: type: object description: Department associated with the contract. properties: key: type: string description: Department Key example: '11' id: type: string description: Department example: DEP-11 name: type: string description: Department name example: Human Resources href: type: string readOnly: true example: /objects/company-config/department/731 class: type: object properties: key: type: string description: Class Key example: '731' id: type: string description: Class ID example: REST_CLS_001 name: type: string description: Class Name readOnly: true example: Enterprises href: type: string readOnly: true example: /objects/company-config/class/731 task: type: object properties: id: type: string description: Task ID example: '1' key: type: string description: Task Key example: '1' name: type: string description: Task Name readOnly: true example: Project Task href: type: string readOnly: true example: /objects/projects/task/1 vendor: type: object properties: key: type: string description: Vendor Key example: '357' id: type: string description: Vendor ID example: '1605212096809' name: type: string description: Vendor Name readOnly: true example: GenLab href: type: string readOnly: true example: /objects/accounts-payable/vendor/357 customer: type: object description: >- Customer that the contract is associated with. The customer cannot be changed after a contract line has been posted to the contract. properties: key: type: string description: Customer Key example: '250' id: type: string description: Customer ID example: CUS-RT-0011 name: type: string description: Customer Name readOnly: true example: Ability Software href: type: string readOnly: true example: /objects/accounts-receivable/customer/13 project: type: object properties: key: type: string description: Project Key example: '2' id: type: string description: Project ID example: NET-XML30-2 name: type: string description: Project Name readOnly: true example: Talcomp training href: type: string readOnly: true example: /objects/projects/project/2 employee: type: object properties: key: type: string description: Employee Key example: '10' id: type: string description: Employee ID example: EMP-10 name: type: string description: Employee Name readOnly: true example: Thomas, Glenn href: type: string example: /objects/company-config/employee/10 readOnly: true contracts-contract: type: object properties: key: type: string description: System-assigned unique key for the contract. readOnly: true example: '12' id: type: string description: Unique ID for the contract. example: CON-0045-1 href: type: string description: URL endpoint for the contract. readOnly: true example: /objects/contracts/contract/12 name: type: string description: Contract name example: ACME Widgets - Service parent: type: object readOnly: true description: Original contract that a renewal contract was copied from. properties: key: type: string description: Key of parent contract. readOnly: true example: '59' id: type: string description: ID of parent contract. readOnly: true example: CON-0045 href: type: string readOnly: true description: Endpoint of parent contract. example: /objects/contracts/contract/249 description: type: string description: Description of the contract. example: YMCA of Metro Atlanta - 360 Support nullable: true status: $ref: '#/components/schemas/status' state: description: >- State of the contract. Use `draft` when creating a contract that is not ready to post to the general ledger. * `draft`: The contract was saved as a preliminary version. A draft contract has no effect on the General Ledger. * `inProgress`: The contract was posted and is considered in effect. A contract keeps this state until it is renewed, ends without being renewed, or is canceled. * `canceled`: All contract schedules (revenue, expense, and billing) were canceled for all contract lines associated with this contract. * `notRenewed`: The contract completed its term, but it was not renewed. Only applicable if `termType` = `termed`. * `renewed`: The contract was renewed. Only applicable if `termType` = `termed`. type: string default: inProgress enum: - draft - inProgress - renewed - canceled - notRenewed example: inProgress startDate: description: >- Contract start date. The start date cannot be changed after a contract line has been posted to the contract. For evergreen contracts the start date determines the start day of each recurring billing period. The contract line billing frequency (Monthly, Quarterly, or Annually) determines the length of each recurring billing period. type: string format: date example: '2023-01-01' endDate: description: >- Contract end date. The end date drives the renewal process. Required when `termType` = `termed`. type: string format: date example: '2024-01-01' contacts: type: object description: Contract contacts properties: shipTo: type: object description: Contact to ship to. Leave blank to use customer's default. properties: key: type: string example: '1482' id: type: string example: Gruppen (Estate Europe) Services ABCUS-RT-0010 email1: type: string readOnly: true example: qa-auto-emails@intacct.com email2: type: string readOnly: true example: twoaddres@yahoo.com href: type: string readOnly: true example: /objects/company-config/contact/1482 billTo: type: object description: Contact to bill to. Leave blank to use customer's default. properties: key: type: string example: '1482' id: type: string example: Gruppen (Estate Europe) Services ABCUS-RT-0010 email1: type: string example: qa-auto-emails@intacct.com readOnly: true email2: type: string readOnly: true example: twoaddres@yahoo.com href: type: string readOnly: true example: /objects/company-config/contact/1482 cancellationDate: type: string description: The effective date for the contract cancellation. format: date example: '2023-04-01' nullable: true billingFrequency: type: string description: Billing frequency enum: - null - monthly - quarterly - annually example: monthly nullable: true default: null paymentTerm: type: object description: AR payment term for this contract. properties: key: type: string example: '16' id: type: string example: N90 href: type: string readOnly: true example: /objects/accounts-receivable/term/16 billingPriceList: type: object description: Billing price used for all contract lines. properties: key: type: string description: Billing price list key example: '12' id: type: string example: SoftwarePackages href: type: string readOnly: true example: /objects/contracts/billing-price-list/1 meaPriceList: type: object description: >- MEA price list. Only applicable if `termType` = `termed` and the company is subscribed to Contract Advanced Revenue Recognition. properties: key: type: string description: MEA price list key example: '12' id: type: string example: Services MEA Price List href: type: string readOnly: true example: /objects/contracts/mea-price-list/12 holdBilling: type: boolean description: Billing hold example: false nullable: true holdRevenue: type: boolean description: Revenue hold example: false nullable: true holdExpense: type: boolean description: Expense hold example: false nullable: true currency: description: >- Currencies used in the contract. Required if company is configured for multi-currency. type: object properties: exchangeRateType: type: string description: >- Exchange rate type. Leave blank to use Intacct Daily Rate. The exchange rate type cannot be changed after a contract line is posted to the contract. example: EUR-Rate baseCurrency: type: string description: >- Base currency. Defaults to the base currency associated with the selected location/entity. example: USD txnCurrency: type: string description: >- Transaction currency. Defaults to the transaction currency associated with the selected customer. All contract lines have the same transaction currency. The transaction currency cannot be changed after a contract line is posted to the contract. example: USD isRenewable: type: boolean description: >- Whether the contract is enabled for renewal. Only applicable if `termType` = `termed`. default: false example: false renewedContract: type: object readOnly: true description: The previous contract for which this contract is the renewal. properties: key: type: string description: Unique key of the previous contract. readOnly: true example: '12' id: type: string description: ID of the previous contract. readOnly: true example: CON-0045-2 href: type: string readOnly: true example: /objects/contracts/contract/12 renewal: type: object properties: template: type: string description: Renewal template. Only used if `renewal` is `true`. example: 12 months with notifications contractTermType: type: string description: |- Contract term type: * `termed` - a traditional payment term such as Net 30 * `evergreen` - perpetual contract default: termed enum: - termed - evergreen example: termed termLength: type: integer description: >- How frequently the contract is renewed, counted in `renewTermPeriod`s (days, months, or years). Only applicable if `termType` = `termed`. example: 12 nullable: true termPeriod: type: string description: Renewal term period. Only applicable if `termType` = `termed`. default: months enum: - years - months - days example: months triggerDate: type: string format: date description: Trigger date. example: '2024-12-01' date: type: string format: date description: Renewal date. example: '2024-12-01' billInAdvanceLength: type: integer description: >- Number of `renewalBillInAdvancePeriod` units (months or days) before the renewal date to bill the customer. Overrides bill-in-advance settings on the customer. example: 2 nullable: true billInAdvancePeriod: type: string description: >- Renewal bill in advance time units. Must be set to `days` or `months` if using bill in advance for renewals. default: null nullable: true enum: - null - days - months example: days billInAdvanceLength: type: integer description: >- Number of `billInAdvancePeriod` units (months or days) before the contract start date to bill the customer. Overrides bill-in-advance settings on the customer. example: 1 nullable: true billInAdvancePeriod: type: string description: >- Bill in advance time units. Must be set to `days` or `months` if using bill in advance. default: null nullable: true enum: - null - days - months example: months contractType: type: object description: > [Contract type](/openapi/contract/contracts-contract-type/tag/Contract-types) properties: key: type: string example: '1' name: type: string example: service href: type: string readOnly: true example: /objects/contracts/contract-type/2 deferEstimatedTimeBasedRevenueBy: type: string description: >- Specifies how Intacct should combine the timesheet hours associated with a Time & Materials project: * `project`: All hours billed from timesheets associated with the project will be used to determine actual revenue for the contract line. There can only be one In progress Project time contract line in the contract linked to a particular project. * `projectAndItem`: All hours billed from timesheets associated with a particular item and with a particular project will be combined and used to determine the actual revenue for the contract line. Each project/item combination on each Project time contract line within a contract must be unique. * `projectAndTask`: All hours billed from timesheets associated with a particular task and with a particular project will be combined and used to determine the actual revenue for the contract line. Each project/task combination on each Project time contract line within a contract must be unique. Only applicable if `termType` = `termed` and "Enable deferred revenue for Time & Materials projects" is turned on for the company. default: null nullable: true enum: - null - project - projectAndItem - projectAndTask example: projectAndTask contractTotalAmount: type: string description: >- The total flat/fixed amount value of the contract (does not include usage). example: '2300' billedAmount: type: string description: The total amount invoiced from the contract. example: '1000' attachment: type: object description: Supporting document attached to the contract. properties: key: type: string description: System-assigned key for the supporting document. example: '18' id: type: string description: System-assigned ID for the supporting document. example: '18' href: type: string readOnly: true example: /objects/company-config/attachment/18 postMemo: type: string description: Post memo. example: Cash customer nullable: true dimensions: $ref: '#/components/schemas/contract-dimension-ref' audit: $ref: '#/components/schemas/audit' contracts-contract-lineRequiredProperties: type: object required: - contract - item - billing - dimensions contracts-contract-line: type: object description: Information for contract lines. properties: key: type: string description: System-assigned unique key for the contract line. readOnly: true example: '1' id: type: string description: Contract line unique ID. Same as `key` for this object. readOnly: true example: '1' href: type: string description: URL endpoint of the contract line. readOnly: true example: /objects/contracts/contract-line/1 state: type: string description: State enum: - draft - inProgress - renewalOnly - canceled - notRenewed - completed - revalued - closed - renewalForecast default: inProgress example: completed lineNumber: type: integer description: Line number readOnly: true example: 1 recurringBillingPeriod: type: integer description: The recurring billing period number. readOnly: true default: 0 example: 2 startDate: type: string format: date description: Line start example: '2024-01-01' endDate: type: string format: date description: Line end example: '2024-04-30' cancelationDate: type: string format: date description: Cancel date readOnly: true example: '2024-04-01' changeType: type: string description: Change type enum: - null - newMRR - addOnMRR - renewalUpgrade - renewalDowngrade - churnMRR - downgrade nullable: true default: null example: newMRR itemDescription: type: string description: Item description example: API usage priceCalculationMemo: type: string description: >- Displays information on how Sage Intacct determined the suggested price readOnly: true example: 'Flat Amount: 0, Billing Preference: One-time, Price Type: Tiered' nullable: true deliveryStatus: type: string description: Delivery status enum: - delivered - undelivered default: delivered example: undelivered deliveryDate: type: string format: date description: Delivery date example: '2024-04-30' readOnly: true postingDate: type: string format: date description: GL posting date example: '2024-01-01' lineType: type: string description: Line type readOnly: true enum: - sale - discount - debook example: sale default: sale memo: type: string description: Post Memo example: POSTING LINE nullable: true shipToSource: type: string description: Specifies where the ship-to contact information should come from enum: - contractValue - userSpecifiedValue default: contractValue example: contractValue billToSource: type: string description: Specifies where the bill-to contact information should come from enum: - contractValue - userSpecifiedValue default: contractValue example: contractValue revenueDeferralStatus: type: string description: Revenue recognition deferral status enum: - deferRevenueUntilItemIsDelivered - deferRevenueUntilAllItemsAreDelivered default: deferRevenueUntilItemIsDelivered example: deferRevenueUntilItemIsDelivered isRecurring: type: boolean description: Recurring default: false example: false currency: type: object properties: exchangeRateDate: type: string format: date description: Exchange rate date example: '2024-01-01' exchangeRate: type: string description: Exchange rate format: decimal-precision-12 example: '1.345' baseCurrency: type: string description: Base currency readOnly: true example: USD txnCurrency: type: string description: Transaction currency readOnly: true example: USD billing: type: object properties: amountFrequency: type: string description: Flat/fixed amount frequency enum: - oneTime - useBillingTemplate - includeWithEveryInvoice default: useBillingTemplate example: oneTime template: type: object description: Billing template to use. properties: key: type: string description: Key example: '12' id: type: string description: Contract Billing Template ID example: 12P_BeginingPeriod method: type: string description: Template type readOnly: true example: predefinedPercentages href: type: string readOnly: true example: /objects/contracts/billing-template/12 schedule: type: object readOnly: true description: Contract billing schedule title: contract-billing-schedule properties: key: type: string description: Billing Schedule Key readOnly: true example: '12' id: type: string description: Unique identifier of the contract billing schedule. readOnly: true example: '12' status: type: string description: Billing schedule status readOnly: true example: inProgress href: type: string readOnly: true example: /objects/contracts/billing-schedule/12 method: type: string description: Billing method enum: - fixedPrice - quantityBased - projectT&M - projectTime - projectMaterials default: fixedPrice example: fixedPrice usageQuantityReset: type: string description: Reset usage quantity enum: - null - afterEachRenewal - afterEachInvoice nullable: true default: null example: afterEachRenewal isUsageQuantityRecurring: type: boolean description: Usage quantity recurs default: false example: false committedQuantityEndAction: type: string description: On contract line end date enum: - null - billUnusedQuantity - cancelUnusedQuantity - doNothing nullable: true default: null example: billUnusedQuantity committedQuantityExcess: type: string description: If usage exceeds the committed quantity enum: - null - billOverage - doNotAllowOverage - doNothing nullable: true default: null example: billOverage quantityType: type: string description: Quantity type enum: - null - variable - committed nullable: true default: null example: variable durationInPeriods: type: string description: Duration (in periods) example: '3' proratePartialPeriods: type: boolean description: Prorate partial periods? default: false example: false frequency: type: string description: Billing frequency enum: - null - monthly - quarterly - annually example: monthly nullable: true default: null startDate: type: string format: date description: Billing start example: '2022-01-01' endDate: type: string format: date description: Billing end example: '2022-04-30' holdDate: type: string format: date description: Hold date readOnly: true example: '2022-04-01' resumeDate: type: string format: date description: Resume date readOnly: true example: '2022-04-10' memo: type: string description: Memo example: Cash customer nullable: true quantity: type: string description: Quantity example: '8' nullable: true rate: type: string description: Rate example: '100' nullable: true multiplier: type: string description: Multiplier example: '1' nullable: true discount: type: string description: Discount example: '10' default: '0' flatFixedAmount: type: string description: Flat/fixed amount example: '100' baseFlatFixedAmount: type: string description: Base flat/fixed amount example: '100' totalFlatFixedAmount: type: string description: Total flat/fixed amount example: '100' readOnly: true totalBaseFlatFixedAmount: type: string description: Total base flat/fixed amount example: '100' readOnly: true expense: type: object properties: holdDate: type: string format: date description: Hold date example: '2022-04-01' readOnly: true resumeDate: type: string format: date description: Resume date example: '2022-04-01' readOnly: true memo: type: string description: Memo example: Cash customer nullable: true revenue: type: object properties: journal1: type: object title: Revenue Type properties: glJournal: type: object readOnly: true description: Journal properties: key: type: string description: System-assigned key for the gl-journal. example: '4' readOnly: true id: type: string description: Journal symbol. readOnly: true example: LEGACYREVREC name: type: string description: The full name of the journal. readOnly: true example: Expense Journal href: type: string readOnly: true example: /objects/general-ledger/journal/4 revenueTemplate: type: object properties: key: type: string description: Revenue template key. example: '13' id: type: string description: Revenue template ID. example: STRAIGHTLINE_MANUAL recognitionMethod: type: string description: Recognition method readOnly: true example: straightLine href: type: string readOnly: true example: /objects/contracts/revenue-template/13 revenueSchedule: type: object readOnly: true description: contract title: contract properties: key: type: string description: Revenue schedule key readOnly: true example: '16' id: type: string description: Contract revenue schedule ID. readOnly: true example: '16' href: type: string readOnly: true example: /objects/contracts/revenue-schedule/16 startDate: type: string format: date description: Revenue 1 start date example: '2022-04-01' endDate: type: string format: date description: Revenue 1 end date example: '2022-04-30' journal2: type: object title: Revenue Type properties: glJournal: type: object readOnly: true description: Journal 2 properties: key: type: string description: System-assigned key for the journal readOnly: true example: '3' id: type: string description: journal symbol. readOnly: true example: ASC606REVREC name: type: string description: The full name of the journal. readOnly: true example: Expense Journal href: type: string readOnly: true example: /objects/general-ledger/journal/3 revenueTemplate: type: object properties: key: type: string description: Key example: '15' nullable: true id: type: string description: Contract Revenue Template ID example: STRAIGHTLINE_MANUAL recognitionMethod: type: string description: Recognition method readOnly: true example: straightLine href: type: string readOnly: true example: /objects/contracts/revenue-template/15 revenueSchedule: type: object readOnly: true description: contract title: contract properties: key: type: string description: Revenue Schedule readOnly: true example: '16' href: type: string readOnly: true example: /objects/contracts/revenue-schedule/16 startDate: type: string format: date description: Revenue 1 start date example: '2018-04-01' endDate: type: string format: date description: Revenue 1 end date example: '2022-04-30' totalQuantity: type: string description: Total revenue quantity example: '30' resumeDate: type: string format: date description: Resume date readOnly: true example: '2022-04-10' holdDate: type: string format: date description: Hold date readOnly: true example: '2022-04-02' memo: type: string description: Memo example: Cash customer nullable: true renewal: type: object properties: renew: type: boolean description: Renew default: false example: false billingTemplate: type: object properties: key: type: string description: Key example: '17' id: type: string description: Contract revenue template ID example: 12P_BeginingPeriod href: type: string readOnly: true example: /objects/contracts/billing-template/17 contacts: type: object readOnly: true properties: shipTo: type: object readOnly: true title: shipTo properties: key: type: string readOnly: true example: '1472' id: type: string example: Gruppen (Estate Europe) Services ABCUS-RT-0010 readOnly: true href: type: string readOnly: true example: /objects/company-config/contact/1472 billTo: type: object readOnly: true title: billTo properties: key: type: string readOnly: true example: '1472' id: type: string readOnly: true example: Gruppen (Estate Europe) Services ABCUS-RT-0010 href: type: string readOnly: true example: /objects/company-config/contact/1472 contract: type: object description: contract properties: key: type: string description: Contract unique key example: '249' id: type: string description: Contract unique identifier example: CON-0045 endDate: type: string format: date readOnly: true example: '2022-04-30' termType: type: string readOnly: true example: Termed state: type: string description: Contract state. readOnly: true example: inProgress name: type: string description: Contract name. readOnly: true example: ACME Widgets - Service href: type: string readOnly: true example: /objects/contracts/contract/249 item: type: object properties: key: type: string description: Item Key example: '13' id: type: string description: Item ID example: API3.0 name: type: string description: Item Name readOnly: true example: Platform pack href: type: string readOnly: true example: /objects/inventory-control/item/13 renewalTriggerDate: type: string format: date description: Trigger date. readOnly: true example: '2022-03-30' lineRenewalDate: type: string format: date description: Renewal date. readOnly: true example: '2022-03-30' parent: type: object readOnly: true description: Original contract line. properties: key: type: string description: Key of parent contract line. readOnly: true example: '60' id: type: string description: ID of parent contract. readOnly: true example: '60' lineNumber: type: string description: Parent line number readOnly: true example: '2' href: type: string readOnly: true description: Endpoint of parent contract line. example: /objects/contracts/contract-line/60 dimensions: $ref: '#/components/schemas/contract-dimension-ref' audit: $ref: '#/components/schemas/audit' contracts-contract-typeRequiredProperties: type: object required: - id contracts-contract-type: type: object properties: key: type: string description: System-assigned unique key for the contract type. readOnly: true example: '12' id: type: string description: Contract type name readOnly: true example: Services description: type: string description: Contract type description nullable: true example: contract type description href: type: string description: URL endpoint for the contract type. readOnly: true example: /objects/contracts/contract-type/12 parent: type: object description: Parent contract type, for type hierarchies. properties: key: type: string description: Key of parent contract type. example: '11' id: type: string description: ID of parent contract type. example: API href: type: string readOnly: true description: URL endpoint for the parent contract type. example: /objects/contracts/contract-type/1 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' contracts-contract-usageRequiredProperties: type: object required: - contractLine - usageDate - quantity contracts-contract-usage: type: object description: >- Contract usage data including contract line and contract header information. properties: key: type: string description: System-assigned key for the contract usage data. readOnly: true example: '145' id: type: string description: Contract usage data ID. Same as `key` for this object. readOnly: true example: '145' href: type: string description: URL endpoint of the contract usage. readOnly: true example: /objects/contracts/contract-usage/1 contract: type: object properties: key: type: string example: '34' id: type: string description: Contract example: CAR-IMPLEMENTATION name: type: string readOnly: true description: Contract name example: CAR-IMPLEMENTATION href: type: string readOnly: true example: /objects/contracts/contract/34 contractLine: type: object properties: key: type: string example: '3' id: type: string description: Contract detail key example: '3' lineNumber: readOnly: true type: string description: Contract line number example: '1' href: type: string readOnly: true example: /objects/contracts/contract-line/3 usageDate: type: string description: Usage date format: date example: '2024-02-01' quantity: type: string description: Usage quantity example: '1' item: type: object properties: id: type: string description: Item ID example: LICNERP key: type: string description: Item key example: '306' name: readOnly: true type: string description: Item name example: Licenses-ERP href: type: string readOnly: true example: /objects/inventory-control/item/306 documentId: type: string description: Document ID readOnly: true nullable: true example: Contract Invoice-CONIN#0100#doc revenueSchedule: type: object readOnly: true properties: key: type: string description: Revenue schedule readOnly: true nullable: true example: '1' id: type: string description: Revenue schedule readOnly: true nullable: true example: '1' href: type: string readOnly: true example: /objects/contracts/revenue-schedule/1 revenueScheduleLine: type: object readOnly: true properties: key: type: string description: Revenue schedule entry key readOnly: true nullable: true example: '1' id: type: string description: Revenue schedule entry key readOnly: true nullable: true example: '1' postingDate: readOnly: true nullable: true type: string format: date example: '2015-01-16' amount: readOnly: true nullable: true type: string example: '162215.47' href: type: string readOnly: true example: /objects/contracts/revenue-schedule-line/1 revenue2Schedule: type: object readOnly: true properties: key: type: string description: Revenue schedule readOnly: true nullable: true example: '2' id: type: string description: Revenue schedule readOnly: true nullable: true example: '2' href: type: string readOnly: true example: /objects/contracts/revenue-schedule/2 revenue2ScheduleLine: type: object readOnly: true properties: key: type: string description: Revenue schedule entry key readOnly: true nullable: true example: '2' id: type: string description: Revenue schedule entry key readOnly: true nullable: true example: '2' postingDate: readOnly: true nullable: true type: string format: date example: '2015-01-16' amount: readOnly: true nullable: true type: string example: '162215.47' href: type: string readOnly: true example: /objects/contracts/revenue-schedule-line/1 usageType: type: string description: Usage type. example: revenue enum: - billingVariable - revenue - canceled - trackedRevenue - billingCommitted - trackedVariable - billingOverage default: billingVariable contractUsageBilling: type: object properties: billedDate: type: string format: date description: Billed date. nullable: true example: '2022-01-01' recurringUsageDate: type: string description: Recurring usage date. format: date nullable: true example: '2022-01-01' customer: type: object readOnly: true properties: key: type: string description: Customer Key readOnly: true nullable: true example: '13' id: type: string description: Customer ID readOnly: true nullable: true example: CUST-13 name: type: string description: Customer Name readOnly: true nullable: true example: Jack In the Box href: type: string readOnly: true example: /objects/accounts-receivable/customer/13 audit: $ref: '#/components/schemas/audit' contracts-billing-price-listRequiredProperties: type: object required: - id contracts-billing-price-list: type: object properties: key: type: string description: >- System-assigned unique key for the billing price list. Used to identify the price list in URLs or JSON bodies for all operations on the price list. readOnly: true example: '12' id: type: string description: Unique name or ID for the billing price list. example: Lumber billing price list description: type: string description: Description of the billing price list. example: Subscription price list status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' contracts-billing-price-list-entryRequiredProperties: type: object required: - billingPriceList - item - priceType - variableUnitDivisor contracts-billing-price-list-entry-line-tier: type: object description: Contract billing price list entry line tier. properties: key: type: string description: System-assigned key for the billing price list entry line tier. readOnly: true example: '23' id: type: string description: Billing price list entry line tier ID. readOnly: true example: '23' href: type: string description: URL endpoint for the billing price list line tier. readOnly: true example: /objects/contracts/billing-price-list-entry-line-tier/23 beginQuantity: type: string description: Begin quantity. Use 0 for first tier. example: '0' tierRate: type: string description: Tier rate. example: '850' billingPriceListEntryLine: type: object description: The billing-price-list-entry-line object that owns this tier. properties: href: type: string description: URL endpoints for the billing price list entry line. readOnly: true example: /objects/contracts/billing-price-list-entry-line/1 key: type: string description: Billing price list entry line key. example: '1' id: type: string description: Billing price list entry line ID. readOnly: true example: '1' audit: $ref: '#/components/schemas/audit' contracts-billing-price-list-entry-line: type: object description: Contract billing price list entry detail properties: key: type: string description: System-assigned key for the billing price list entry line. readOnly: true example: '23' id: type: string description: Billing price list entry line ID. Same as `key` for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the billing price list entry line. readOnly: true example: /objects/contracts/billing-price-list-entry-line/23 startDate: type: string format: date description: The date on which the price becomes effective. example: '2024-01-01' flatAmount: type: string description: > Flat amount. * The established amount to bill each period. For example, if the item is text message, 5,000 text messages are included for a Flat amount of 10.00. Set this field to `0` to price the item only by the contracted quantity or quantity used. * The fixed price for items that don't include pricing by contracted quantity or quantity used. For example, the item is a service plan that is 300.00 for a one-year term. format: decimal-precision-2 example: '999.99' variableUnitRate: type: string description: >- The amount to charge for each quantity range beyond the included units. Only applicable if `priceType` = `range`. example: '11.99' nullable: true includedUnits: type: string description: > The item quantity included in the `flatAmount`. Enter `0` in this field to: * Price the item only by the contracted quantity or quantity used * Set a fixed fee * Use the item with committed quantity billing. Included units must be 0.00 to save a committed quantity contract line. example: '2000' nullable: true memo: type: string description: Notes. example: note to save nullable: true billingPriceListEntry: type: object description: The `billing-price-list-entry` object that this line belongs to. readOnly: true properties: href: type: string description: Endpoint for the billing price list entry. readOnly: true example: /objects/contracts/billing-price-list-entry/281 key: type: string description: Billing price list entry key. readOnly: true example: '281' id: type: string description: Billing price list entry ID. readOnly: true example: '281' tiers: description: Pricing tiers. Only applicable if `priceType` = `tiered`. type: array items: $ref: '#/components/schemas/contracts-billing-price-list-entry-line-tier' audit: $ref: '#/components/schemas/audit' contracts-billing-price-list-entry: type: object description: Contract billing price list entry. properties: key: type: string description: System-assigned key for the billing price list entry. readOnly: true example: '23' id: type: string description: Billing price list entry ID. Same as `key` for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the billing price list entry. readOnly: true example: /objects/contracts/billing-price-list-entry/23 billingPriceList: description: Billing price list that the entry belongs to. type: object properties: href: type: string description: URL endpoint for billing price list. readOnly: true example: /objects/contracts/billing-price-list/1 key: type: string description: System-assigned unique key for the billing price list. example: '1' id: type: string description: Unique ID of the price list. example: SoftwarePackagePL currency: $ref: '#/components/schemas/currency' priceType: type: string description: > Price type. * `range` - Use this option for items with high-volume quantities, such as items measured in CPM. You set pricing for groups of thousands, hundreds, dozens, and so on. For example, say you are selling ad clicks. Each group of 1000 ad clicks will be priced at 20.00. * `tiered` - Use this option to define price tiers. Use the `tieredPricingType` to set the type of tiered pricing and an array of `billing-price-list-entry-line-tier` objects to specify the tiers. example: range enum: - range - tiered default: range flatAmountFrequency: type: string description: > How often the `flatAmount` from a billing-price-list-entry-line should be invoiced during the contract term. * `oneTime` - The flat amount should only be invoiced once. * `useBillingTemplate` - The flat amount should be divided into more than one invoice. * `includeWithEveryInvoice` - The flat amount should be included in every invoice. This value is used for evergreen contract lines. example: oneTime enum: - oneTime - useBillingTemplate - includeWithEveryInvoice default: oneTime usageQuantityResetPeriod: type: string description: > Indicates when the usage quantity should be reset to 0 to start the pricing structure over. On quantity-based evergreen contract lines, this field defaults to afterEachInvoice and cannot be changed. example: afterEachRenewal enum: - afterEachRenewal - afterEachInvoice default: afterEachRenewal roundingType: type: string description: >- Indicate how you want the total usage to be rounded after the total usage quantity is divided by the `variableUnitDivisor`. Only applicable if `priceType` = `range`. example: standard enum: - none - standard - roundUp - roundDown default: standard isQuantityRecurring: type: boolean description: Set to `true` to make this a recurring quantity. example: false default: false variableUnitDivisor: type: string description: >- Variable unit divisor to apply to all lines. This field is only applicable if `priceType` = `range`. example: '1000' tieredPricingType: type: string description: > Tiered pricing type. * `volume` - The total quantity will be priced at the rate in the tier in which the quantity falls. * `step` - The item will be priced at the successive tiers in which the quantity falls. * `absolute` - Set a specific amount to be charged when the quantity falls within a tier. This field is only applicable if `priceType` = `tiered`. example: step enum: - volume - step - absolute default: volume item: description: The item that this price list entry is for. type: object properties: key: type: string description: Item key example: '13' id: type: string description: Item ID example: ID3614 name: type: string readOnly: true description: Item name example: Interior door href: type: string description: Endpoint URL of the item. readOnly: true example: /objects/inventory-control/item/13 lines: description: Billing price list entry lines type: array items: $ref: '#/components/schemas/contracts-billing-price-list-entry-line' audit: $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' contracts-billing-price-list-entry-line-tierRequiredProperties: type: object required: - beginQuantity - tierRate contract-billing-schedule-type-ref: type: object properties: key: type: string description: Contract billing schedule system-assigned key. readOnly: true example: '145' id: type: string description: Contract billing schedule unique identifier. readOnly: true example: '145' href: type: string description: Contract billing schedule URL. readOnly: true example: /objects/contracts/billing-schedule/145 contract-usage-type-ref: type: object properties: key: type: string description: Contract usage system-assigned key. readOnly: true example: '145' id: type: string description: Contract usage unique identifier. example: '145' href: type: string description: Contract usage URL. readOnly: true example: /objects/contracts/contract-usage/145 contracts-billing-schedule-line: type: object description: Contract billing schedule line. required: - scheduledBillingDate properties: href: type: string description: Schedule line URL. readOnly: true example: /objects/contracts/billing-schedule-line/145 scheduledBillingDate: type: string description: Schedule line scheduled billing date. format: date example: '2022-04-30' nullable: false billed: type: boolean description: Schedule line billed flag. readOnly: true example: false actualBillingDate: type: string description: Schedule line actual billing date. readOnly: true format: date example: '2022-04-30' actualBaseAmount: type: string description: Schedule line actual billing base amount. format: decimal-precision-2 example: '137.52' actualExchangeRate: type: string description: Schedule line actual billing exchange rate. format: decimal-precision-12 example: '1.345' sourceHours: type: string description: >- Schedule line source hours from project or task. Used with approvedHours to determine percentage to use for billing. example: '118' approvedHours: type: string description: >- Schedule line approved hours. Used with sourceHours to determine percentage to use for billing. example: '16' documentId: type: string description: Schedule line document ID. readOnly: true example: Contract Invoice-CONIN#0100#doc computationMemo: type: string description: >- Schedule line computation memo. This is a system generated memo to explain how the amount was calculated. readOnly: true example: >- MEA amount 1000, adjustment amount 333.32. Prorated amount before effective date 03/01/2022 is 0. linkedBillingScheduleLine: type: object description: >- The linked billing schedule line, used for linking a negative discount line to the original line. properties: key: type: string description: Contract billing schedule line system-assigned key. readOnly: true example: '145' id: type: string description: Contract billing schedule line unique identifier. readOnly: true example: '145' href: type: string description: Contract billing schedule line URL. readOnly: true example: /objects/contracts/billing-schedule-line/145 readOnly: true contractBillingSchedule: $ref: '#/components/schemas/contract-billing-schedule-type-ref' contractUsage: $ref: '#/components/schemas/contract-usage-type-ref' contract-schedule-line-type-ref: type: object required: - scheduledAmount properties: key: type: string description: Schedule line system-assigned key. readOnly: true example: '145' id: type: string description: Schedule line unique identifier. example: '145' scheduledOperationKey: type: string description: Scheduled operation key for the associated offline operation. example: '57665' readOnly: true status: type: string description: Schedule line status. readOnly: true example: posted enum: - open - terminated - posted - onHold scheduledAmount: type: string description: Schedule line scheduled amount. format: decimal-precision-2 example: '125.27' nullable: false scheduledBaseAmount: type: string description: Schedule line scheduled base amount. format: decimal-precision-2 example: '137.52' scheduledExchangeRate: type: string description: Schedule line scheduled exchange rate. format: decimal-precision-12 example: '1.345' isHistorical: type: boolean description: >- Schedule line historical flag indicating the line was added during initial implementation for historical purposes. readOnly: true example: false audit: $ref: '#/components/schemas/audit' contracts-billing-schedule: type: object description: Header information for contract billing schedule. properties: key: type: string description: Contract billing schedule Key readOnly: true example: '145' id: type: string description: Contract billing schedule unique ID. Same as `key` for this object. readOnly: true example: '145' href: type: string description: URL endpoint for the contract billing schedule. readOnly: true example: /objects/contracts/billing-schedule/145 status: type: string description: Schedule status. readOnly: true example: inProgress enum: - draft - inProgress - onHold - completed - terminated - estimateRevalued default: inProgress lines: type: array description: Contract billing schedule lines. items: type: object allOf: - $ref: '#/components/schemas/contracts-billing-schedule-line' - $ref: '#/components/schemas/contract-schedule-line-type-ref' estimateRevaluationDate: type: string description: >- The date the Revalue estimation function was executed on the 'Project time' contract line. readOnly: true format: date example: '2023-03-31' contract-type-ref: type: object properties: key: type: string description: System-assigned key for the contract. readOnly: true example: '2' id: type: string description: Unique identifier of the contract. readOnly: true example: CON-2 href: type: string description: URL of the contract. readOnly: true example: /objects/contracts/contract/2 contract-schedule-contract-line-type-ref: type: object properties: key: type: string description: System-assigned key for the contract line. readOnly: true example: '2' id: type: string description: Unique identifier of the contract line. readOnly: true example: '2' href: type: string description: URL of the contract line. readOnly: true example: /objects/contracts/contract-line/2 contract-schedule-type-ref: type: object properties: key: type: string description: Schedule system-assigned key. readOnly: true example: '145' id: type: string description: Schedule unique identifier. readOnly: true example: '145' cancellationDate: type: string description: Schedule cancellation date. readOnly: true format: date example: '2022-08-13' contract: $ref: '#/components/schemas/contract-type-ref' contractLine: $ref: '#/components/schemas/contract-schedule-contract-line-type-ref' audit: $ref: '#/components/schemas/audit' contracts-billing-templateRequiredProperties: type: object required: - id contracts-billing-template-line: type: object description: Template details required when method = predefinedPercentages. properties: key: type: string description: System-assigned unique key for the billing template entry. readOnly: true example: null id: type: string description: Same as key. readOnly: true example: null href: type: string description: URL of the billing template line. readOnly: true example: /objects/contracts/billing-template-line/1 periodOffset: type: string description: Number of months offset example: '2' percentToBill: type: string description: Percent to bill format: decimal-precision-8 example: '10.12312000' stepPercent: type: string format: decimal-precision-8 description: Percentage completed threshold example: '90.12312000' contractBillingTemplate: type: object description: Billing template that this entry belongs to. properties: key: type: string description: System-assigned key for the parent billing template. example: '1' id: type: string description: Id of the parent billing template. example: 12P_BeginingPeriod href: type: string description: Enpoint for the parent billing template. example: /objects/contracts/billing-template/1 readOnly: true status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' contracts-billing-template: type: object description: >- A billing template defines the rules to use to invoice the flat or fixed amount of a contract line item. properties: key: type: string description: System-assigned key for the contract billing template. readOnly: true example: '1' id: type: string description: Name or other unique identifier for the billing template. example: 12P_BeginningPeriod href: type: string description: Endpoint for the billing template. readOnly: true description: type: string description: Description of the billing template. example: 12P Beginning Period method: type: string description: Template type example: predefinedPercentages enum: - predefinedPercentages - projectPercentComplete - taskPercentComplete default: predefinedPercentages source: type: string description: >- Specifies the data source to use to determine the percentage of completeness for the project or task. example: estimatedHours enum: - null - estimatedHours - observedPercentCompleted - budgetedHours - plannedHours nullable: true default: null isStepBilling: type: boolean description: >- Indicates whether to define billing thresholds to determine the percentage of the flat/fixed amount to invoice. default: false example: false lines: type: array description: Contract billing template details. items: $ref: '#/components/schemas/contracts-billing-template-line' status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' contracts-expenseRequiredProperties: type: object required: - contract - item - postingDate - dimensions - txnAmount contracts-expense: type: object description: Information for a contract expense line. properties: href: type: string example: /objects/contracts/expense/1 readOnly: true key: type: string description: System-assigned key readOnly: true example: '1' id: type: string description: >- Unique identifier of the expense line. Same as `key` for this object. readOnly: true example: '1' txnAmount: type: string format: decimal-precision-2 description: Amount example: '100.00' baseAmount: type: string format: decimal-precision-2 description: Base amount example: '100.00' currency: type: object properties: exchangeRateDate: type: string format: date description: Exchange rate date example: '2022-01-01' exchangeRate: type: string description: Exchange rate format: decimal-precision-12 example: '1.345' baseCurrency: type: string description: Base currency readOnly: true example: USD txnCurrency: type: string description: Transaction currency readOnly: true example: USD lineNumber: type: integer description: Line number readOnly: true example: 1 postingDate: type: string format: date description: GL posting date example: '2022-02-01' cancelationDate: type: string format: date description: Cancellation date example: '2022-11-01' readOnly: true state: type: string description: State enum: - draft - inProgress - canceled default: inProgress example: inProgress readOnly: true expenseType: type: string description: Expense type readOnly: true enum: - contract - contractLine default: contract example: contract calculatedExpensePostingType: type: string description: expense posting type example: manual readOnly: true calculatedExpense2PostingType: type: string description: expense posting type example: manual readOnly: true memo: type: string description: Post memo readOnly: true example: Test contract: type: object description: contract properties: key: type: string description: Contract key example: '59' id: type: string description: Contract example: CON-0045 name: type: string description: Contract name example: ACME Widgets - Service status: type: string description: Contract Status readOnly: true href: type: string example: /objects/contracts/contract/59 readOnly: true contractLine: type: object properties: key: type: string description: Contract detail key example: '2' id: type: string description: Contract detail key example: '2' state: type: string description: contract detail state readOnly: true example: completed lineNumber: type: integer description: contract line number readOnly: true example: 1 href: type: string example: /objects/contracts/contract-line/2 readOnly: true templates: type: object properties: expenseJournal1: type: object title: Expense Journal 1 properties: postingType: type: string description: Journal 1 expense posting type enum: - null - automatic - manual nullable: true default: null example: manual readOnly: true postingConversionDate: type: string format: date description: Journal 1 expense posting conversion date example: '2022-05-01' readOnly: true glJournal: type: object description: Journal details properties: key: type: string description: Expense journal key example: '3' readOnly: true name: type: string readOnly: true example: Expense Journal id: type: string readOnly: true example: EJ href: type: string example: /objects/general-ledger/journal/3 readOnly: true readOnly: true expenseTemplate: type: object description: Expense template properties: defaultPostingType: type: string description: expense template posting type readOnly: true example: manual id: type: string description: Expense template 1 example: EXPSTRAIGHTLINE_MAN key: type: string example: '1' href: type: string readOnly: true example: /objects/contracts/expense-template/1 schedule: type: object description: contract expense schedule readOnly: true properties: id: type: string description: expense Schedule key example: '12' readOnly: true key: type: string description: expense Schedule key example: '12' readOnly: true status: type: string description: Schedule1 status readOnly: true example: inProgress href: type: string readOnly: true example: /objects/contracts/expense-schedule/12 startDate: type: string format: date description: Expense start example: '2022-01-01' endDate: type: string format: date description: Expense end example: '2022-12-01' expenseJournal2: type: object title: Expense Journal 2 properties: postingType: type: string description: Journal 2 expense posting type enum: - null - automatic - manual nullable: true default: null example: manual readOnly: true postingConversionDate: type: string format: date description: Journal 2 expense posting conversion date example: '2022-05-01' readOnly: true glJournal: type: object description: Journal details properties: key: type: string description: Expense journal key example: '3' readOnly: true name: type: string readOnly: true example: Expense Journal id: type: string readOnly: true example: EJ href: type: string example: /objects/general-ledger/journal/3 readOnly: true readOnly: true expenseTemplate: type: object description: Expense template properties: id: type: string description: Expense template 2 example: EXPSTRAIGHTLINE_MAN defaultPostingType: type: string readOnly: true example: manual key: type: string example: '1' href: type: string example: /objects/contracts/expense-template/1 readOnly: true schedule: type: object description: contract expense schedule properties: key: type: string description: expense Schedule key example: '12' status: type: string description: Schedule2 status readOnly: true example: inProgress href: type: string readOnly: true example: /objects/contracts/expense-schedule/12 startDate: type: string format: date description: Expense2 start example: '2022-01-01' endDate: type: string format: date description: Expense2 end example: '2022-12-01' deferredExpenseGLAccount: type: object description: Deferred expense account Details readOnly: true properties: name: type: string description: Deferred expense account title readOnly: true example: Expense Account id: type: string description: Deferred expense account number readOnly: true example: '150' key: type: string description: Deferred expense account key readOnly: true example: '411' href: type: string readOnly: true example: /objects/general-ledger/account/411 expenseAccrualGLAccount: type: object readOnly: true description: Expense accural account Details properties: name: type: string readOnly: true example: Expense Account id: type: string description: Expense accrual account number readOnly: true example: '4113' key: type: string description: Expense accrual account key readOnly: true example: '412' href: type: string readOnly: true example: /objects/general-ledger/account/412 recognizedExpenseGLAccount: type: object readOnly: true properties: id: type: string description: Recognized expense readOnly: true example: '1501' name: type: string description: Recognized expense account title readOnly: true example: Expense Account key: type: string description: Recognized expense account key readOnly: true example: '413' href: type: string readOnly: true example: /objects/general-ledger/account/413 item: $ref: '#/components/schemas/item-ref' dimensions: $ref: '#/components/schemas/contract-dimension-ref' audit: $ref: '#/components/schemas/audit' contracts-expense-templateRequiredProperties: type: object required: - id contracts-expense-template-line: type: object description: Contract expense template entry properties: href: type: string example: /objects/contracts/expense-template-line/1 readOnly: true key: type: string description: Contract Expense Template Entry Key readOnly: true example: '1' id: type: string description: Contract Expense Template Entry Key readOnly: true example: '1' periodOffset: type: string description: Number of months offset example: '2' percentToRecognize: type: string format: decimal-precision-8 description: Percentage to recognize example: '10.12312000' contractExpenseTemplate: type: object properties: key: type: string description: Template Key example: '1' id: type: string description: Contract Expense Template ID example: EXPSTRAIGHTLINE_MAN href: type: string example: /objects/contracts/expense-template/1 readOnly: true status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' contracts-expense-template: type: object description: Header information for contract expense templates. properties: href: type: string example: /objects/contracts/expense-template/1 readOnly: true key: type: string description: Key readOnly: true example: '1' id: type: string description: Contract Expense Template ID example: EXPSTRAIGHTLINE_MAN description: type: string description: Description example: Expense straight line manual amortizationSchedulePeriod: type: string description: Amortization Schedule Period example: annually enum: - monthly - quarterly - semiAnnually - annually default: monthly postingDay: type: integer description: Posting Day readOnly: true minimum: 1 maximum: 31 example: 1 default: 1 amortizationMethod: type: string description: Amortization method example: straightLine enum: - straightLine - dailyRate - predefinedPercentages default: straightLine defaultPostingType: type: string description: Default Posting type example: manual enum: - automatic - manual default: manual lines: type: array description: Contract expense template entries items: $ref: '#/components/schemas/contracts-expense-template-line' status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' contracts-expense-template-lineRequiredProperties: type: object required: - id contract-expense-schedule-type-ref: type: object properties: key: type: string description: Contract expense schedule system-assigned key. readOnly: true example: '145' id: type: string description: Contract expense schedule unique identifier. readOnly: true example: '145' href: type: string description: Contract expense schedule URL. readOnly: true example: /objects/contracts/expense-schedule/145 contracts-expense-schedule-line: type: object description: Contract expense schedule line. required: - scheduledExpenseDate properties: href: type: string description: Schedule line URL. readOnly: true example: /objects/contracts/expense-schedule-line/145 contractExpenseSchedule: $ref: '#/components/schemas/contract-expense-schedule-type-ref' contract-schedule-line-postable-type-ref: type: object required: - scheduledPostingDate properties: scheduledPostingDate: type: string description: Schedule line scheduled posting date. format: date example: '2022-04-30' nullable: false posted: type: boolean description: Schedule line posted flag. readOnly: true example: false actualPostingDate: type: string description: Schedule line actual posting date. readOnly: true format: date example: '2022-04-30' journalEntry: type: object properties: key: type: string description: Journal entry key. readOnly: true example: '8153' id: type: string description: Journal entry ID. readOnly: true example: '4765' href: type: string description: Journal entry URL. readOnly: true example: /objects/general-ledger/journal-entry/1981 contracts-expense-schedule: type: object description: Header information for contract expense schedule. properties: href: type: string description: URL endpoint for the contract expense schedule. readOnly: true example: /objects/contracts/expense-schedule/145 journal: type: string description: The journal association for this schedule (J1 or J2). readOnly: true example: J1 enum: - J1 - J2 status: type: string description: Schedule status. readOnly: true example: inProgress enum: - draft - inProgress - onHold - completed - terminated - estimateRevalued expenseScheduleLines: type: array description: Contract expense schedule lines. items: type: object allOf: - $ref: '#/components/schemas/contracts-expense-schedule-line' - $ref: '#/components/schemas/contract-schedule-line-type-ref' - $ref: '#/components/schemas/contract-schedule-line-postable-type-ref' contracts-mea-price-listRequiredProperties: type: object required: - id contracts-mea-price-list: type: object properties: key: type: string description: >- System-assigned unique key for the MEA price list. Used to identify the price list in URLs or JSON bodies for all operations on the price list. readOnly: true example: '12' id: type: string description: Unique name or ID for the MEA price list. example: Subscription MEA price list href: type: string description: URL endpoint for the MEA price list. readOnly: true example: /objects/contracts/mea-price-list/12 description: type: string description: Description of the MEA price list. example: Fair value for high-volume customers isDefault: type: boolean description: Set to `true` to make this the default price list. example: false status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' contracts-mea-price-list-entryRequiredProperties: type: object required: - meaPriceList - item - currency properties: currency: required: - txnCurrency contracts-mea-price-list-entry-line: type: object description: Contracts MEA price list entry line properties: key: type: string description: System-assigned key for the MEA price list entry line. readOnly: true example: '23' id: type: string description: MEA price list entry line ID. readOnly: true example: '23' href: type: string description: URL endpoint for the MEA price list entry line. readOnly: true example: /objects/contracts/mea-price-list-entry-line/23 meaPriceListEntry: type: object description: MEA price list entry that this line belongs to. readOnly: true properties: href: type: string description: URL endpoint for the MEA price list entry. readOnly: true example: /objects/contracts/mea-price-list-entry/281 key: type: string description: MEA price list entry key. readOnly: true example: '281' id: type: string description: MEA price list entry ID. readOnly: true example: '281' startDate: type: string format: date description: Start date. example: '2016-01-01' amountOrPercent: type: string description: Flat amount/percent. format: decimal-precision-2 example: '999.99' markDown: type: string description: >- Only applicable if priceType = Amount and usePriceRange = true. Enter the amount or percent difference by which Intacct will calculate the lowerLimit of the price range. example: '1' markUp: type: string description: >- Only applicable if priceType = Amount and usePriceRange = true. Enter the amount or percent by which Intacct will calculate the upperLimit of the price range. example: '1' lowerLimit: type: string description: Lower limit. example: '10' upperLimit: type: string description: Upper limit. example: '10' memo: type: string description: Notes. example: flat amount memo nullable: true audit: $ref: '#/components/schemas/audit' contracts-mea-price-list-entry: type: object description: Contracts MEA price list entry properties: key: type: string description: System-assigned key for the MEA price list entry. readOnly: true example: '23' id: type: string description: MEA price list entry ID. Same as `key` for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the MEA price list entry. readOnly: true example: /objects/contracts/mea-price-list-entry/23 meaPriceList: type: object description: MEA price list that this entry belongs to. properties: href: type: string description: URL endpoint for the MEA price list. readOnly: true example: /objects/contracts/mea-price-list/1 key: type: string description: System-assigned unique key for the MEA price list. example: '1' id: type: string description: Unique ID of the MEA price list. example: SoftwarePackagePL fairValueCategory: type: object properties: href: type: string description: URL endpoint for the MEA category. readOnly: true example: /objects/contracts/mea-category/3 key: type: string description: System-assigned key for the MEA category. example: '1' id: type: string description: MEA category name. example: Software-License-ERP item: type: object description: The item that this price list entry is for. properties: key: type: string description: Item key example: '13' id: type: string description: Item ID. example: API_Usage name: type: string readOnly: true description: Item name. example: API Usage href: type: string readOnly: true example: /objects/inventory-control/item/13 currency: $ref: '#/components/schemas/currency' priceType: type: string description: Item priced as. example: amount enum: - amount - percent - priceRange - noFairValue default: amount calculatePercentageBasedOn: type: string description: Calculate percentage based on. example: extendedFairValuePrice enum: - null - extendedFairValuePrice - extendedContractLinePrice nullable: true default: null usePriceRange: type: boolean description: Set to `true` to use price range. example: false default: false priceRangeVarianceType: type: string description: Price range variances entered as. example: amount enum: - null - amount - percent nullable: true default: null priceRuleOutsideRange: type: string description: Price rule when outside range. example: fairValue enum: - null - fairValue - nearestBoundary nullable: true default: null lines: type: array description: MEA price list entry lines. items: $ref: '#/components/schemas/contracts-mea-price-list-entry-line' audit: $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' contracts-mea-categoryRequiredProperties: type: object required: - id contracts-mea-category: type: object description: A label for an MEA fair value category. properties: key: type: string description: System-assigned key for the MEA category. readOnly: true example: '23' id: type: string description: MEA fair value category name or ID. example: Software-License-ERP href: type: string description: URL endpoint for the MEA category. readOnly: true example: /objects/contracts/mea-category/23 description: type: string description: Description of the MEA category example: Fair value category for software licenses status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' contracts-revenue-templateRequiredProperties: type: object required: - id contracts-revenue-template: description: >- A contract revenue template defines the revenue recognition schedule for the flat/fixed amount associated with a contract line. type: object properties: key: type: string description: Revenue Template Key readOnly: true example: '2' id: type: string description: Name example: STRAIGHTLINE_MANUAL href: type: string description: URL of the revenue template. readOnly: true example: /objects/contracts/revenue-template/2 description: type: string description: Description example: STRAIGHTLINE MANUAL schedulePeriod: type: string description: Recognition schedule period enum: - monthly - quarterly - semiAnnually - annually default: monthly example: monthly recognitionMethod: type: string description: Recognition method enum: - straightLine - dailyRate - quantityBased - predefinedPercentages - projectPercentComplete - taskPercentComplete default: straightLine example: straightLine recognitionSource: type: string description: Recognition method source enum: - null - estimatedHours - observedPercentCompleted - budgetedHours - plannedHours nullable: true default: null example: estimatedHours stepRevenue: type: boolean description: >- Define recognition thresholds. Only applicable when `recognitionMethod` = `projectPercentComplete` or `taskPercentComplete`. default: false example: false defaultPostingType: type: string description: Default posting type enum: - automatic - manual default: manual example: automatic revenueAdjustmentOption: type: string description: Revenue adjustment option enum: - null - oneTime - distributed - walkForward example: oneTime nullable: true default: null recognitionPercentages: type: array description: >- Only applicable if `recognitionMethod` = `predefinedPercentages` `projectPercentComplete`, or if `recognitionMethod` = `taskPercentComplete` AND `stepRevenue` = `true`. items: properties: monthsOffset: type: integer description: >- If `recognitionMethod` = `predefinedPercentages`, enter the number of months in the future from the contract line start date the corresponding `recognitionPercent` should post. nullable: true default: null example: 5 percentToRecognize: type: string description: Percent to recognize. format: decimal-precision-2 example: '10' thresholdPercent: type: string description: Threshold percent. format: decimal-precision-2 example: '70' status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' contract-revenue-schedule-type-ref: type: object properties: key: type: string description: Contract revenue schedule system-assigned key. readOnly: true example: '145' id: type: string description: Contract revenue schedule unique identifier. readOnly: true example: '145' href: type: string description: Contract revenue schedule URL. readOnly: true example: /objects/contracts/revenue-schedule/145 contracts-revenue-schedule-line: type: object description: Contract revenue schedule line. properties: key: type: string description: System-assigned key for the contract revenue schedule line readOnly: true example: '145' id: type: string description: contract revenue schedule line ID. readOnly: true example: '145' href: type: string description: Schedule line URL. readOnly: true example: /objects/contracts/revenue-schedule-line/145 derivedPostingDate: type: string description: Schedule line derived posting date. readOnly: true format: date example: '2022-04-30' meaDetails: type: string description: Schedule line MEA details. readOnly: true example: (1000 * 1 {line# 1}) adjustedFor: type: string description: Schedule line adjusted for. readOnly: true example: MEA percentageRecognized: type: string description: >- The percentage of the line to be recognized. Calculated based on 'sourceHours' and 'approvedHours'. readOnly: true example: '25.18' sourceHours: type: string description: >- Schedule line source hours from project or task. Used with 'approvedHours' to determine the percentage to be recognized. example: '118' approvedHours: type: string description: >- Schedule line approved hours. Used with 'sourceHours' to determine the percentage to be recognized. example: '16' computationMemo: type: string description: >- Schedule line computation memo. This is a system generated memo to explain how the amount was calculated. readOnly: true example: >- MEA amount 1000, adjustment amount 333.32. Prorated amount before effective date 03/01/2022 is 0. linkedBillingScheduleLine: type: object description: >- The system generated linked billing schedule line. Used for splitting revenue across contract lines in case of MEA. properties: key: type: string description: Contract billing schedule line system-assigned key. readOnly: true example: '145' id: type: string description: Contract billing schedule line unique identifier. readOnly: true example: '145' href: type: string description: Contract billing schedule line URL. readOnly: true example: /objects/contracts/billing-schedule-line/145 readOnly: true contractRevenueSchedule: $ref: '#/components/schemas/contract-revenue-schedule-type-ref' contracts-revenue-schedule: type: object description: Header information for contract revenue schedule. properties: key: type: string description: System-assigned key for the contract revenue schedule readOnly: true example: '145' id: type: string description: contract revenue schedule ID. readOnly: true example: '145' href: type: string description: Contract revenue schedule URL. readOnly: true example: /objects/contracts/revenue-schedule/145 journal: type: string description: The journal association for this schedule (J1 or J2). readOnly: true example: J1 enum: - J1 - J2 status: type: string description: Schedule status. readOnly: true example: inProgress enum: - draft - inProgress - onHold - completed - terminated - pendingDelivery - pendingDeliveryAll - estimateRevalued - renewalForecast estimateRevaluationDate: type: string description: >- The date the Revalue estimation function was executed on the 'Project time' contract line. readOnly: true format: date example: '2023-03-31' revenueScheduleLines: type: array description: Contract revenue schedule lines items: type: object allOf: - $ref: '#/components/schemas/contracts-revenue-schedule-line' - $ref: '#/components/schemas/contract-schedule-line-type-ref' - $ref: '#/components/schemas/contract-schedule-line-postable-type-ref' core-composite: description: >- Schema for describing a single request that will be included as part of a POST body sent to the composite request service. type: object properties: method: type: string description: Operation for request. nullable: false example: POST enum: - GET - POST - PATCH - DELETE path: type: string description: Path to the request endpoint in the Intacct REST API. nullable: false pattern: ^\/(objects|services)\/[a-z_][a-z_0-9.\-:]+(.*)?$ example: /objects/accounts-payable/vendor headers: type: object description: Headers needed for this request. example: Idempotency-Key: e9606bb2-6be1-4c9e-a2a7-134cd644a5ee body: type: object description: Request body for POST or PATCH operations. example: lastName: Doe firstName: John id: Doe, John resultReference: type: string description: >- Reference identifier for success results, used by other requests as input data. nullable: false example: contactRef required: - method - path object-model: type: object description: Generic response for object model definition properties: fields: type: object groups: type: object refs: type: object idempotenceSupported: type: boolean example: true default: true httpMethods: type: string example: OPTIONS,GET,DELETE,PATCH,POST core-query: description: Query request type: object properties: object: type: string example: accounts-payable/vendor description: >- Object type to query, in the form `/`. For custom objects use `platform-apps/nsp::`. fields: description: >- List of fields to include in the response. Can be any combination of these: * The name of a field in the object that you are querying, such as `id`. * The name of a field in a related object, using the form `relatedObjectName.fieldName`, such as `vendor.id`. * The result of an aggregate function run against the values in the returned objects. Use the form `function:fieldName`, such as `min:startDate` to return the earliest starting date. Valid function names are: * `count` * `avg` * `sum` * `min` * `max` * The result of an aggregate function run against the values in related objects, using the form `function:relatedObjectName.fieldName`, such as `max:vendor.creditLimit`. The same functions are supported as for object fields. type: array items: type: string example: - key - id - max:vendor.creditLimit filters: description: >- Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as `{"$eq":{"status":"active"}}` to select objects in which `status` is equal to "active". example: - $eq: status: active - $gt: totalDue: '1000' - $contains: name: Acme type: array items: anyOf: - title: equal type: object description: >- Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the `asOfDate` in [filterParameters](#filterParameters), if set:
  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the `asOfDate` each time to retrieve the same data set for different time periods. For example, `{"eq":{"postingDate":"priorYear"}}`. properties: $eq: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string nullable: true - type: integer nullable: true - type: number nullable: true - type: boolean example: $eq: status: active - title: not equal type: object description: >- Field value must not be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the `asOfDate` in [filterParameters](#filterParameters), if set:
  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the `asOfDate` each time to retrieve the same data set for different time periods. properties: $ne: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string nullable: true - type: integer nullable: true - type: number nullable: true - type: boolean example: $ne: status: inactive - title: less than type: object description: >- Field value must be less than this specified value. For date fields, you can use these macro values that are relative to the current date or the `asOfDate` in [filterParameters](#filterParameters), if set:
  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the `asOfDate` each time to retrieve the same data set for different time periods. properties: $lt: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $lt: totalDue: '100' - title: less than or equal type: object description: >- Field value must be less than or equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the `asOfDate` in [filterParameters](#filterParameters), if set:
  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the `asOfDate` each time to retrieve the same data set for different time periods. properties: $lte: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number - type: boolean example: $lte: totalDue: '500' - title: greater than type: object description: >- Field value must be greater than this specified value. For date fields, you can use these macro values that are relative to the current date or the `asOfDate` in [`filterParameters`](#filterParameters), if set:
  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the `asOfDate` each time to retrieve the same data set for different time periods. properties: $gt: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $gt: totalDue: '1000' - title: greater than or equal type: object description: >- Field value must be greater than or equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the `asOfDate` in [`filterParameters`](#filterParameters), if set:
  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the `asOfDate` each time to retrieve the same data set for different time periods. properties: $gte: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number - type: boolean example: $gte: totalDue: '999' - title: in type: object description: >- Field value is one of the specified values. For date fields, you can use these macro values that are relative to the current date or the `asOfDate` in [`filterParameters`](#filterParameters), if set:
  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the `asOfDate` each time to retrieve the same data set for different time periods. properties: $in: type: object description: >- The field name and list of values to be compared with object values. additionalProperties: type: array items: oneOf: - type: string - type: integer - type: number - type: boolean example: $in: firstName: - Tim - Anjali - Gabriel - title: not in type: object description: >- Field value is not one of the specified values. For date fields, you can use these macro values that are relative to the current date or the `asOfDate` in [`filterParameters`](#filterParameters), if set:
  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the `asOfDate` each time to retrieve the same data set for different time periods. properties: $notIn: type: object description: >- The field name and list of values to be compared with object values. additionalProperties: type: array items: oneOf: - type: string - type: integer - type: number - type: boolean example: $notIn: country: - United States - Canada - title: between type: object description: >- Field value is within the given range, inclusive. For date fields, you can use these macro values that are relative to the current date or the `asOfDate` in [`filterParameters`](#filterParameters), if set:
  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the `asOfDate` each time to retrieve the same data set for different time periods. properties: $between: type: object description: >- The field name and the beginning and ending values to be compared with object values. additionalProperties: type: array items: oneOf: - type: string - type: integer - type: number example: $between: totalDue: - '1' - '1000' - title: not between type: object description: >- Field value is not within the given range. For date fields, you can use these macro values that are relative to the current date or the `asOfDate` in [`filterParameters`](#filterParameters), if set:
  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the `asOfDate` each time to retrieve the same data set for different time periods. properties: $notBetween: type: object description: >- The field name and the beginning and ending values to be compared with object values. additionalProperties: type: array items: oneOf: - type: string - type: integer - type: number example: $notBetween: totalDue: - '100' - '1000' - title: contains type: object description: >- Field value contains the given string or number. Cannot be used with date fields. properties: $contains: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $contains: name: Acme - title: does not contain type: object description: >- Field value does not contain the given string or number. Cannot be used with date fields. properties: $notContains: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $notContains: name: llc - title: starts with type: object description: >- Field value starts with this string or number. Cannot be used with date fields. properties: $startsWith: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $startsWith: name: A - title: does not start with type: object description: >- Field value does not start with this string or number. Cannot be used with date fields. properties: $notStartsWith: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $notStartsWith: name: Q - title: ends with type: object description: >- Field value ends with this string or number. Cannot be used with date fields. properties: $endsWith: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $endsWith: name: inc - title: does not end with type: object description: >- Field value does not end with this string or number. Cannot be used with date fields. properties: $notEndsWith: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $notEndsWith: name: llc filterExpression: description: > Logical operators to apply when there are multiple filter conditions. The conditions in the `filters` array are implicitly numbered starting at 1. Supports `and`, `or`, and grouping with parentheses. Shortcuts: + `and` by itself means that all conditions must be true. + `or` by itself means that at least one condition must be true. type: string example: (1 and 2) or 3 default: and filterParameters: description: |- Pre-defined filter options. type: object properties: asOfDate: type: string format: date description: >- The "as of" date to use with any relative date comparisons in `filters`. For example, if `asOfDate` is set to "2022-04-01" then `priorMonth` will be "03". The current date is used if `asOfDate` is not set. example: '2022-04-01' includeHierarchyFields: description: >- Set to `true` to include hierarchical structure information with each object in the response. type: boolean example: false default: false caseSensitiveComparison: description: >- Queries are case-sensitive by default. Set to `false` to ignore case in a query. type: boolean example: true default: true includePrivate: description: >- By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities. type: boolean default: false example: false orderBy: description: >- Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. type: array items: type: object title: field name and sort order additionalProperties: type: string enum: - asc - desc example: - totalDue: asc - lastPaymentMadeDate: desc start: description: First record of the result set to include in the response. type: integer example: 1 size: description: Number of records to include in the response. type: integer example: 100 general-ledger-accountRequiredProperties: type: object required: - id - name required-dimensions-ref: type: object description: >- The dimensions that must be included on transactions that post to the account. properties: class: type: boolean description: Set to `true` to require a value for class. default: false example: false contract: type: boolean description: Set to `true` to require a value for contract. default: false example: false customer: type: boolean description: Set to `true` to require a value for customer. default: false example: false department: type: boolean description: Set to `true` to require a value for department. default: false example: true employee: type: boolean description: Set to `true` to require a value for employee. default: false example: false item: type: boolean description: Set to `true` to require a value for item. default: false example: false location: type: boolean description: Set to `true` to require a value for location. default: false example: false project: type: boolean description: Set to `true` to require a value for project. default: false example: false vendor: type: boolean description: Set to `true` to require a value for vendor. default: false example: false warehouse: type: boolean description: Set to `true` to require a value for warehouse. default: false example: false asset: type: boolean description: Set to `true` to require a value for asset. default: false example: false general-ledger-account: type: object description: General ledger account properties: key: type: string description: >- System-assigned key for the account. Used to identify the account in URLs or JSON bodies for all operations on the account. readOnly: true example: '411' id: type: string description: >- The primary account number. This number must be a specific length, which is set on the Accounting tab of the Company Information page. example: '1501.04' name: type: string description: >- Name or title of the account, which appears on report headings. Max length is 80. example: Expense Account accountType: type: string description: >- Type of account: - `balanceSheet` - A snapshot of the current state of a company's assets, liabilities, and equity at a specific time. - `incomeStatement` - Income statement accounts, sometimes called Profit and Loss statements, are cumulative for the selected period. enum: - balanceSheet - incomeStatement default: balanceSheet example: balanceSheet normalBalance: type: string description: >- Sets whether the normal balance, from an accounting standpoint, is a debit or credit. For example, expense accounts are normally a debit. Sales accounts are normally a credit. enum: - debit - credit default: debit example: debit closingType: type: string description: >- Sets the account as a closing or non-closing account. Instead of manually closing accounts at year end, you can set them to be closing accounts and then specify the account in which to close that period. - `nonClosingAccount` - Balance sheet accounts. - `closingAccount` - Income statement accounts. Also specify a `closeToGLAccount`, which will typically be Retained Earnings. Sage Intacct then zeroes closing-type accounts into retained earnings at year-end. - `closedToAccount` - An account that other accounts close to, such as Retained Earnings. enum: - nonClosingAccount - closingAccount - closedToAccount default: nonClosingAccount example: nonClosingAccount closeToGLAccount: type: object description: >- Account into which this account should close. Required if `closingType` is set to `closingAccount`. properties: key: type: string description: System-assigned key for account. example: '5' id: type: string description: GL account number. example: '3500' href: type: string description: URL endpoint of the account. readOnly: true example: /objects/general-ledger/account/5 alternativeGLAccount: type: string description: > Sets whether the account can be used as an override of the default AP or AR GL accounts. - `payablesAccount` - The account can be used as an override account for bill and adjustment transactions, and transactions involving a specific vendor. - `receivablesAccount` - The account can be used as an override for invoice and adjustment transactions and transactions involving a specific customer. - `none` - The account cannot be used as an override account. The same alternative GL account can be used for all line items in a transaction, or different alternative accounts can be set for each line item. For vendors and customers, one alternative GL account can be used for balancing all transactions involving that vendor or customer. Note: Currently, this field applies to bills, invoices, and adjustments only. It doesn't apply to recurring bills or invoices, manual payments, manual deposits, or advances. enum: - none - payablesAccount - receivablesAccount default: none example: payablesAccount disallowDirectPosting: type: boolean description: >- Set to `true` to prevent direct entry of journal entries to the subledger control account (for example Accounts Payable, Accounts Receivable, etc.). Use this control to ensure that the account balance for the subledger account is accurate and has the necessary subledger details supporting the figure, rather than a direct entry which would not be reflected in the subledger application area. default: false example: false status: $ref: '#/components/schemas/status' requireDimensions: $ref: '#/components/schemas/required-dimensions-ref' category: type: string description: >- Account categories are pre-defined groupings that arrange accounts into out-of-the-box reports, graphs, and performance cards. This field is available only for companies that were created with a QuickStart template or chose one later. If enabled, set a category for the account. The available values are tied to the particular QuickStart template used for the company. The category chosen will automatically set values for `accountType`, `normalBalance`, and `closingType`. example: Cash and Cash Equivalents isTaxable: type: boolean description: Set to `true` to mark the account as taxable. default: false example: false taxCode: type: string description: >- Provide the tax return code needed by external tax compliance products to map tax codes to the tax forms that the company uses. Requires tax codes to be enabled in the General Ledger. example: CST mrcCode: type: string description: The M-3 return code box to map M-3 return codes to your M-3 form. example: m-3 1065 audit: $ref: '#/components/schemas/audit' href: description: URL endpoint for the account. type: string readOnly: true example: /objects/general-ledger/account/411 general-ledger-statistical-accountRequiredProperties: type: object required: - id - name general-ledger-statistical-account: type: object description: Statistical account properties: key: type: string description: >- System-assigned key for the statistical account. Used to identify the account in URLs or JSON bodies for all operations on the account. readOnly: true example: '397' id: type: string description: Statistical account ID. example: '9001' name: type: string description: Name or title of this statistical account. example: Customer Account reportType: type: string description: >- This is a non-functional field, for information purposes only. It does not affect how amounts are calculated for reporting. enum: - forPeriod - cumulative default: forPeriod example: forPeriod requireDimensions: $ref: '#/components/schemas/required-dimensions-ref' isTaxable: type: boolean description: Set to `true` to mark the account as taxable. default: false example: true category: type: string description: >- Account categories are pre-defined groupings that arrange accounts into out-of-the-box reports, graphs, and performance cards. This field is available only for companies that were created with a QuickStart template or chose one later. If enabled, set a category for the account. The available values are tied to the particular QuickStart template used for the company. example: Customers status: $ref: '#/components/schemas/status' example: inactive audit: $ref: '#/components/schemas/audit' href: type: string description: URL endpoint for this statistical account. readOnly: true example: /objects/general-ledger/statistical-account/397 general-ledger-account-groupRequiredProperties: type: object required: - id gl-account-range: type: object description: GL Account Group Range properties: key: type: string description: System-assigned key for the GL Account Group Range. readOnly: true example: '2' id: type: string description: Same as `key`. readOnly: true example: '2' sortOrder: type: integer description: Set the sort order of the account range example: 2 default: 0 rangeFrom: type: string description: Specify GL account to start range example: '1000' rangeTo: type: string description: Specify GL account to end range example: '1001' audit: $ref: '#/components/schemas/audit' href: type: string readOnly: true example: /objects/gl-account-range/2 general-ledger-account-group: type: object description: General ledger account groups. properties: key: type: string description: >- System-assigned key for the account group. Used to identify the group in URLs or JSON bodies for all operations involving this account group. readOnly: true example: '33' id: type: string description: Account group name. example: 85 - Cash title: type: string description: Display on report as. example: null totalTitle: type: string description: Display total line as. example: Total Accounts Payable manager: type: string description: >- Person to consult if there are questions about the account group. This is a free form field not tied to users (you can provide a partner name, or any other name). example: null calculationMethod: type: string description: Calculation method example: period enum: - null - period - startOfPeriod - endOfPeriod nullable: true default: null reportFilters: description: > Use report filters to restrict the data displayed by dimension or other factors. Report filters can be more restrictive than filtering at other levels. The filters here work on charts, graphs, performance cards, and financial reports, but are ignored in GL reports. Valid values for all dimension report filters: - `noFilter` - Do not filter on this dimension. Include all transactions, regardless of the dimension value. - `specific` - Only include transactions with the specified dimension value. - `specificHierarchy` - Only include transactions with the specified dimension value and its children. - `nullValue` - Only include transactions that have no value set for this dimension. type: object properties: location: type: string description: Location filter to use in reports. example: null enum: - noFilter - specificHierarchy - specific - nullValue debitOrCredit: type: string description: Include debits, credits, or both in reports. example: both enum: - null - both - debitOnly - creditOnly nullable: true default: null department: type: string description: Department filter to use in reports. example: null enum: - noFilter - specificHierarchy - specific - nullValue vendor: type: string description: Vendor filter to use in reports. example: null enum: - null - noFilter - specificHierarchy - specific - unspecified nullable: true default: null customer: type: string description: Customer filter to use in reports. example: null enum: - noFilter - specificHierarchy - specific - nullValue project: type: string description: Project filter to use in reports. example: null enum: - noFilter - specificHierarchy - specific - nullValue employee: type: string description: Employee filter to use in reports. example: null enum: - noFilter - specificHierarchy - specific - nullValue item: type: string description: Item filter to use in reports. example: null enum: - noFilter - specific - nullValue class: type: string description: Class filter to use in reports. example: null enum: - noFilter - specificHierarchy - specific - nullValue contract: type: string description: Contract filter to use in reports. example: null enum: - noFilter - specificHierarchy - specific - nullValue task: type: string description: Task filter to use in reports. example: null enum: - noFilter - nullValue warehouse: type: string description: Warehouse filter to use in reports. example: null enum: - noFilter - specificHierarchy - specific - nullValue costtype: type: string description: Cost type filter to use in reports. example: null enum: - noFilter - nullValue asset: type: string description: Asset filter to use in reports. example: null enum: - noFilter - specificHierarchy - specific - nullValue normalBalance: type: string description: Normal balance, either debit or credit. example: credit enum: - debit - credit groupType: type: string description: > Account group type. - `accounts` - Consists of one or more accounts from the chart of accounts. - `groups` - Contains other account groups, thus forming a hierarchy. You can have groups within groups within groups, and so on, to any level of depth. - `statisticalAccounts` - Consists of accounts that contain specific non-financial data, such as headcount, hospital beds, square footage, or hotel rooms. Using statistical account groups, you can calculate against and report on data to get a virtually unlimited variety of ratios and business metrics - `computation` - Consists of other account groups or individual accounts that you use as components in a mathematical equation; results of the equation display in financial report. - `category` - Contains accounts based on their category. - `statisticalCategory` - Contains statistical accounts based on their category. example: groups enum: - null - accounts - groups - statisticalAccounts - computation - category - statisticalCategory nullable: true default: null isKPI: type: boolean description: Is a KPI. example: false includeChildAmount: type: boolean description: Roll up child amounts. example: true department: type: object description: >- Department to filter by if `reportFilters.department` is set to `specific` or `specificHierarchy`. properties: key: type: string description: System-assigned key for the department. example: '9' id: type: string description: Unique identifier of the department. example: '01' name: type: string description: Name of the department. readOnly: true example: Accounting href: type: string description: URL endpoint of the department. readOnly: true example: /objects/company-config/department/9 departmentGroup: type: object description: >- Department group to filter by if `reportFilters.department` is set to `specific` or `specificHierarchy`. properties: key: type: string description: System-assigned key for the department group. example: '3086' id: type: string description: Unique identifier of the department group. example: SA01 name: type: string description: Name of the department group. example: Sales href: type: string description: URL endpoint of the department group. readOnly: true example: /objects/company-config/department-group/3086 accountPurpose: type: object description: Account group purpose to associate with this account group. properties: key: type: string description: System-assigned key for the account group purpose. example: '126' id: type: string description: Unique identifier of the account group purpose. example: P&L name: type: string description: Name of the account group purpose. example: null href: type: string description: URL endpoint of the account group purpose. readOnly: true example: /objects/company-config/account-group-purpose/126 location: type: object description: >- Location to filter by if `reportFilters.location` is set to `specific` or `specificHierarchy`. properties: key: type: string id: type: string name: type: string readOnly: true href: type: string readOnly: true locationGroup: type: object description: >- Location group to filter by if `reportFilters.location` is set to `specific` or `specificHierarchy`. properties: key: type: string example: null id: type: string example: null name: type: string example: null href: type: string readOnly: true glAccountRanges: description: Array of account range for the account group. type: array items: $ref: '#/components/schemas/gl-account-range' audit: $ref: '#/components/schemas/audit' href: type: string readOnly: true example: /objects/general-ledger/account-group/33 general-ledger-account-group-purposeRequiredProperties: type: object required: - id general-ledger-account-group-purpose: type: object description: >- Account group purposes let you filter account groups according to why you might use them, which is particularly useful in financial reporting. You create account group purposes and then assign them to account groups when you create or update the groups. properties: key: type: string description: System-assigned key for the account group purpose. readOnly: true example: '21' id: type: string description: Name for the account group purpose. example: P&L href: type: string description: URL endpoint of the account group purpose. readOnly: true example: /objects/general-ledger/account-group-purpose/2 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' general-ledger-journalRequiredProperties: type: object required: - id - name general-ledger-journal: type: object description: General ledger journal properties: key: type: string description: >- System-assigned key for the journal. Used to identify the journal in URLs or JSON bodies for all operations on the journal. readOnly: true example: '3' id: type: string description: >- An abbreviation (symbol) for this journal, for example, AP. In most places in Sage Intacct, the symbol appears along with the title of the journal, as in "AP--Accounts Payable." example: EJ name: type: string description: The full name of the journal, as it should appear in reports. example: Expense Journal isBillable: type: boolean description: >- Set to `true` to enable journal entry line items for a project to be marked as billable. (Requires Projects subscription and billable General Ledger transactions to be enabled.) default: false example: true status: $ref: '#/components/schemas/status' example: inactive isAdjustment: type: boolean description: Set to `true` if the journal is an adjustments journal. default: false example: false bookId: type: string description: >- The reporting book for which the journal was created. For most companies, the reporting book is accrual. If the company is set up for dual-method reporting, the choices are accrual, cash, or accrual and cash. readOnly: true example: Accrual bookType: type: string description: >- A book type could be Accrual, Cash, Cash and Accrual or Consolidation. For most companies, the reporting book is accrual. If the company is set up for dual-method reporting, the choices are accrual, cash, or accrual and cash. enum: - accrual - cash - cashAndAccrual - consolidation default: accrual example: accrual audit: $ref: '#/components/schemas/audit' enableApproval: type: boolean description: >- Set to `true` to enable [journal entry approvals](https://www.intacct.com/ia/docs/en_US/help_action/General_Ledger/Approvals/journal-entry-approval-overview.htm). readOnly: true default: false example: false href: type: string description: URL for this journal. example: /objects/general-ledger/journal/3 readOnly: true general-ledger-statistical-journalRequiredProperties: type: object required: - id - name general-ledger-statistical-journal: type: object description: Statistical journal hold all non-financial transactions. properties: key: type: string description: >- System-assigned key for the statistical journal. Used to identify the journal in URLs or JSON bodies for all operations on the journal. readOnly: true example: '36' id: type: string description: >- An abbreviation (symbol) for this journal, for example, APJ. In most places in Sage Intacct the symbol appears along with the title of the journal, as in "TS--Timesheets." example: TSSJ name: type: string description: >- The full name or title of the journal, as it should appear in reports. example: Timesheet Statistical Journal status: $ref: '#/components/schemas/status' example: active audit: $ref: '#/components/schemas/audit' href: type: string description: URL endpoint for this journal. readOnly: true example: /objects/general-ledger/statistical-journal/36 general-ledger-journal-entryRequiredProperties: type: object required: - glJournal - postingDate - description - lines properties: lines: type: array items: required: - txnAmount - txnType - glAccount general-ledger-journal-entry-line: type: object description: Journal entry line, owned object of journal entry. properties: key: type: string description: System assigned unique key for the journal entry line. readOnly: true example: '1981' id: type: string description: Same as `key` for this object. readOnly: true example: '1981' lineNumber: type: integer description: Line number of the journal entry line. readOnly: true example: 1 txnType: type: string description: Transaction type - debit or credit. enum: - debit - credit default: debit example: credit txnAmount: type: string description: Transaction amount as an absolute value. format: decimal-precision-2 example: '100.45' entryDate: type: string format: date description: Entry date. Default is the current date. readOnly: true example: '2024-01-23' documentId: type: string description: Document number of entry. example: Revenue_Documentation description: type: string description: Description of the journal entry line. example: Revenue Entries numberOfUnits: type: integer description: Number of units example: 5 reconciliationGroup: type: object readOnly: true properties: clearingDate: type: string format: date description: Automatically added when reconciliation is done. readOnly: true example: '2024-01-23' cleared: type: string enum: - 'true' - 'false' - matched description: Status to show the reconciliation stage. readOnly: true example: 'false' reconciliationDate: type: string format: date description: Reconciliation date readOnly: true example: '2024-01-23' accountingPeriod: type: integer description: Accounting period if company uses custom accounting periods. example: 11 isBillable: type: boolean description: >- Set to `true` to mark the line item as billable. (Requires Projects subscription and billable General Ledger transactions to be enabled.) default: false example: false isBilled: type: boolean description: Billed flag readOnly: true default: false example: false baseAmount: type: string description: Transaction amount multiplied by the exchange rate. format: decimal-precision-2 example: '100.45' readOnly: true exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2024-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: number description: >- Exchange rate is used to calculate the base amount from the transaction amount. Required if multi currency is enabled and `typeId` is not set. Exchange rate amount to 4 decimals. example: 1.0789 typeId: type: string description: >- Exchange rate type is used to calculate the base amount from the transaction amount. Required if multi-currency is enabled and `rate` is not set. Default value is `custom`. example: INR-Rate state: $ref: '#/components/schemas/state' audit: $ref: '#/components/schemas/audit' currency: $ref: '#/components/schemas/currency' glAccount: $ref: '#/components/schemas/gl-account-ref' allocation: type: object description: Template to use for predefined transaction allocations. properties: key: type: string description: System-assigned key for the transaction allocation template. example: '21' id: type: string description: User-defined transaction allocation template ID. example: FA_ALLOC href: type: string readOnly: true example: /objects/general-ledger/txn-allocation-template/21 dimensions: $ref: '#/components/schemas/dimension-ref' href: type: string description: URL endpoint for this journal entry line. readOnly: true example: /objects/general-ledger/journal-entry-line/1981 journalEntry: type: object description: Journal entry that this journal entry line is owned by. properties: id: type: string example: '132' key: type: string example: '132' href: type: string readOnly: true example: /objects/general-ledger/journal-entry/132 general-ledger-journal-entry: type: object description: >- Journal entries are used to add, edit, or reverse transactions to a journal. properties: key: type: string description: >- System-assigned unique key for the journal entry. Used to identify the journal entry in URLs or JSON bodies for all operations on the journal entry. example: '132' readOnly: true id: type: string description: Same as `key` for this object. example: '132' readOnly: true txnNumber: type: integer description: System-assigned transaction number. example: 40 readOnly: true glJournal: type: object description: The journal to use for this entry. properties: key: type: string description: System-assigned key for the journal. example: '3' id: type: string description: The id of the journal. example: EJ isAdjustment: type: boolean description: Value will be `true` if the journal is an adjustments journal. readOnly: true example: false default: false href: type: string description: URL endpoint for this journal. example: /objects/general-ledger/journal/3 readOnly: true description: type: string description: Description of the transaction. example: Revenue entries postingDate: type: string format: date description: Posting date. example: '2023-04-01' automaticReversalDate: type: string format: date description: >- Reversal date if you want to reverse this transaction on a certain date. Must be greater than `postingDate`. example: '2023-04-04' nullable: true reversedFromDate: type: string format: date description: >- Populated only if the journal is reversed and represents the posting date of the reversal. example: '2023-04-05' readOnly: true nullable: true reversedBy: type: object description: Reference to the journal entry that reversed the current entry. readOnly: true properties: key: type: string description: System-assigned key of the reversing entry. readOnly: true example: '663' nullable: true href: type: string readOnly: true example: /objects/general-ledger/journal-entry/663 moduleName: type: string description: Intacct module that the journal entry originates from. example: 2.GL referenceNumber: type: string description: User-provided reference number. example: Recurr_GL_101 baseLocation: type: object description: >- Base location for a multi-entity company. Required if a company is multi-entity enabled and entries do not balance by entity. properties: key: description: Location key. type: string example: '32' id: description: Location unique ID. type: string example: BC href: description: Location URL. type: string example: /objects/company-config/location/32 readOnly: true state: type: string description: >- State of the entry. The only valid values when creating a new entry are `posted` (default) to post to the GL, and `draft`. enum: - draft - submitted - partiallyApproved - approved - posted - declined - reversalPending - reversed default: posted example: draft sequenceNumber: type: string description: System-generated accounting sequence number. example: GLJE#_001 taxSolution: type: object description: >- Tax solution reference. Required only if the company is configured for multiple tax jurisdictions and the transaction is occurring at the top level of the company. See [Tax Solutions](/openapi/tax/tax-tax-solution/tag/Tax-solutions) for more information. (GB, AU, and ZA only) readOnly: true properties: key: type: string example: '5' id: type: string example: Australia - GST href: type: string readOnly: true example: /objects/tax/tax-solution/5 audit: $ref: '#/components/schemas/audit' href: type: string description: URL endpoint for this journal entry. readOnly: true example: /objects/general-ledger/journal-entry/132 lines: description: >- Journal entry lines included in this entry. Must have at least two lines, one debit and one credit. type: array minItems: 2 items: $ref: '#/components/schemas/general-ledger-journal-entry-line' general-ledger-journal-entry-lineRequiredProperties: type: object properties: glAccount: required: - id example: '1000' required: - txnAmount - txnType - glAccount general-ledger-budgetRequiredProperties: type: object required: - id - description properties: lines: type: array items: required: - glAccount - amount reporting-period-ref: type: object properties: key: type: string description: Reporting period key. example: '79' id: type: string description: Reporting period ID (case sensitive) example: January 2021 href: type: string description: URL for this reporting period. readOnly: true example: /objects/general-ledger/reporting-period/45 general-ledger-budget-detail: type: object description: Budget detail properties: key: type: string description: >- System-assigned key for the budget detail. Used to identify the budget detail in URLs or JSON bodies for all operations on the budget. readOnly: true example: '291' id: type: string description: Budget detail ID readOnly: true example: '291' budget: description: The budget object that this budget detail is owned by. type: object readOnly: true properties: id: type: string readOnly: true example: Employee Expense Budget key: type: string readOnly: true example: '5' href: type: string readOnly: true example: /objects/general-ledger/budget/5 glAccount: type: object description: >- The General Ledger or Statistical account that this budget is for. The account in a budget-detail object cannot be changed after it has been created. allOf: - $ref: '#/components/schemas/gl-account-ref' - type: object properties: key: type: string description: Account key example: '9' id: type: string description: Account ID example: '4000' name: type: string description: Account title readOnly: true example: Revenue href: type: string description: URL endpoint of the account. readOnly: true example: /objects/general-ledger/account/9 dimensions: description: >- Dimensions to apply to this budget detail. Any dimension that is available in the General Ledger can be used with budgets, including user-defined dimensions (not listed here). To track budget data at the dimension level, such as tracking data for different departments and locations, you will need to add multiple budget detail objects for each account. For example, if you are entering Travel Expense data for 3 locations, you will need 3 budget detail objects for this account, one for each location. The dimensions in a budget-detail object cannot be changed after it has been saved. type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: title: location description: Location is required if multi-currency is enabled. type: object properties: key: type: string description: Location key example: '1' id: type: string description: Location ID example: NV name: type: string description: Location name readOnly: true example: Nevada href: type: string example: /objects/company-config/location/1 department: title: department type: object properties: key: type: string description: Department Key example: '3' id: type: string description: Department example: ENG name: type: string description: Department Name readOnly: true example: Engineering href: type: string example: /objects/company-config/department/3 reportingPeriod: type: object description: >- The reporting period for the budget detail. A period cannot be used if it is already being used in another budget combination of reporting period, account, department, and location. allOf: - $ref: '#/components/schemas/reporting-period-ref' notes: type: string description: Notes or description of the budget detail. example: Projection for 2021 budgetGrowth: type: object description: >- To create a budget from an existing budget, provide the type of budget to use and the planned growth amount. The resulting amount will be computed when you create or update the budget-detail. properties: basedOn: description: >- Whether the new budget should be based on the budget amounts from the selected past period, the actual amounts, or by employee count. type: string example: budget enum: - null - budget - actual - employeeCount nullable: true default: null growBy: description: >- The amount of planned budget growth or reduction to apply to the past period budget or actual amount. type: string format: decimal-precision-2 example: '10.00' perPeriod: description: >- Whether planned budget change is an actual value or a percentage. type: string enum: - null - actual - percentage nullable: true default: null example: percentage amount: description: >- Budget amount for the specified period. The API does not compute amounts for calculated budgets, so an `amount` must be provided when creating a budget-detail. type: string format: decimal-precision-2 example: '100.00' currency: description: >- For global consolidations, the base and transaction currencies to use. $ref: '#/components/schemas/currency' audit: $ref: '#/components/schemas/audit' general-ledger-budget: type: object description: General ledger budget header properties: key: type: string description: >- System-assigned key for the budget. Used to identify the budget in URLs or JSON bodies for all operations on the budget. readOnly: true example: '5' id: type: string description: >- Budget name or ID. Best practice is to give the budget an ID that doesn't reference a particular fiscal year or date. This allows appending new time periods to an existing budget. example: Employee Expense Budget description: type: string description: Description of the budget. example: Budget for project costs isDefault: type: boolean description: >- Set to `true` to mark the budget as the company's default budget to use in financial reports. One top-level budget must be designated as the default. The system sets this value for all other budgets to `false`. default: false example: false submitterName: type: string description: The ID of the user who most recently modified the budget. readOnly: true example: Admin status: $ref: '#/components/schemas/status' example: active consolidateAmounts: type: boolean description: >- For companies using consolidation, set this field to `true` to mark this as a consolidated budget. default: false example: false currency: type: string description: >- Consolidation currency code. Required if `consolidateAmounts` is set to `true`. example: USD postProjectEstimate: type: boolean description: >- Set to `true` to enable project estimates to post to this budget. Requires Construction subscription. default: false example: false audit: $ref: '#/components/schemas/audit' href: type: string description: URL endpoint for the budget. readOnly: true example: /objects/general-ledger/budget/1 lines: description: Array of budget details for each reporting period. type: array items: $ref: '#/components/schemas/general-ledger-budget-detail' general-ledger-reporting-periodRequiredProperties: type: object required: - id - columnHeader1 general-ledger-reporting-period: type: object description: Reporting period definition required: - id - columnHeader1 properties: key: type: string description: System-assigned unique key for the reporting period. readOnly: true example: '421' id: type: string description: Reporting period name. example: Current Month columnHeader1: type: string description: The first line to be shown on the report, such as "Quarter Ended". example: Quarter Ended columnHeader2: type: string description: The second line to be shown on the report, such as "April 2023". nullable: true example: April 2023 startDate: type: string format: date description: The starting date of the reporting period. nullable: true example: '2023-04-01' endDate: type: string format: date description: The ending date of the reporting period. nullable: true example: '2023-06-30' isBudgetable: type: boolean description: >- Set to `true` to make this reporting period available for inclusion in budgets. example: true default: false href: type: string description: URL endpoint for the reporting period. readOnly: true example: /objects/general-ledger/reporting-period/1 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' general-ledger-txn-allocation-templateRequiredProperties: type: object required: - id - lines general-ledger-txn-allocation-template-line: type: object description: Line level component of a transaction allocation template. properties: key: type: string description: System-assigned unique key for the allocation line. readOnly: true example: '1' id: type: string description: This value is the same as the `key` value for this object. readOnly: true example: '1' value: type: string description: The exact amount or percentage to allocate for this line. example: '60.56' unit: type: string description: >- Specifies whether the current line is an exact amount or percentage. Must be set when creating `fixedAmount` allocations, but is set automatically for `percentage` and `exactAmount` allocations. example: amount enum: - amount - percent default: amount lineNumber: type: integer description: >- Line number of the allocation entry. For `fixedAmount` allocations, exact amounts are distributed by line number. example: 1 dimensions: type: object description: Dimensions to use in allocations. allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: title: location type: object properties: key: type: string description: Location key example: '1' id: type: string description: Location ID example: US name: type: string description: Location name readOnly: true example: United States of America href: type: string description: URL endpoint of the location. example: /objects/company-config/location/1 department: title: department type: object properties: key: type: string description: Department key example: '3' id: type: string description: Department ID example: ENG name: type: string description: Department name readOnly: true example: Engineering href: type: string description: URL endpoint of the department. example: /objects/company-config/department/3 audit: $ref: '#/components/schemas/audit' href: type: string description: URL endpoint of the allocation template line. readOnly: true example: /objects/general-ledger/txn-allocation-template-line/1 txnAllocationTemplate: type: object description: >- Transaction allocation template that this allocation line belongs to. properties: key: type: string readOnly: true example: '1' id: type: string readOnly: true example: RootAllocation href: type: string readOnly: true example: /objects/general-ledger/txn-allocation-template/1 general-ledger-txn-allocation-template: type: object description: >- Header object for standard allocation combinations that are used routinely. properties: key: type: string description: System-assigned unique key for the transaction allocation template. example: '21' readOnly: true id: type: string description: User defined transaction allocation template ID. example: FA_ALLOC description: type: string description: A description of the allocation. example: Fixed amount allocation allocateBy: type: string description: > Determines how transaction allocations are split across the dimensions included in a transaction. * Use `percentage` to specify entries as percentages (default) * Use `exactAmount` to specify entries as fixed amounts * Use `fixedAmount` for a combination of both. Exact amounts are distributed first, based on the `lineNumber` values in each txn-allocation-template-line. Any remaining amount is distributed using the percentage allocations. Entries for exact amounts must have lower line numbers than entries for percentages, and percentages must always total 100%. (You use the `unit` parameter on each entry to specify amount or percent.) example: percentage enum: - percentage - exactAmount - fixedAmount default: percentage documentNumber: type: string description: >- A reference number or name to a specific document--such as a contract--used to define the transaction allocation template formula. example: RJEALC status: $ref: '#/components/schemas/status' attachment: type: object description: Supporting document for this allocation template. properties: key: type: string description: Unique key of the attachment. example: '21' id: type: string description: ID of the attachment. example: Sales01 href: type: string description: URL endpoint of the attachment. readOnly: true example: /objects/attachment/21 audit: $ref: '#/components/schemas/audit' href: type: string description: URL endpoint of the allocation template. example: /objects/general-ledger/txn-allocation-template/21 readOnly: true lines: type: array description: Transaction allocation lines. items: $ref: '#/components/schemas/general-ledger-txn-allocation-template-line' general-ledger-txn-allocation-template-lineRequiredProperties: type: object required: - id gl-reports-get-account-balances-by-dimensions-response: description: get-account-balances-by-dimensions response type: object properties: accountBalances: type: object gl-reports-get-account-balances-by-dimensions-request: description: Get account balances by dimension request type: object properties: reportingPeriodName: type: string description: >- Reporting period name. Required if not using `startDate` and `endDate`. example: Calendar Year Ended December 2022 startDate: type: string format: date description: Opening balance date. Required if not using `reportingPeriodName`. example: '2022-01-01' endDate: type: string format: date description: Closing balance date. Required if not using `reportingPeriodName`. example: '2022-03-30' contentSelection: type: string description: |- Specifies the type of data to return. **Valid Values** * `Actual` * `Budget` * `Actual and Budget` default: Actual example: Budget budgetComparison: type: string description: >- Specifies how to compare actual data to budget data. Required when `contentSelection` is `Actual and Budget`. **Valid Values** * `Budget minus Actual` * `Actual minus Budget` default: Budget minus Actual example: Actual minus Budget budgetId: type: string description: >- ID of the budget to use. Required when `contentSelection` is `Budget` or `Actual and Budget`. Uses the default budget for the company if configured. default: null example: Travel Budget reportingBook: type: string description: >- Reporting book ID. Use `ACCRUAL` or `CASH` depending on the company configuration. If Global Consolidations is enabled, you can provide a consolidation book ID instead default: Configured reporting book ID example: ACCRUAL isIncludeReportingBook: type: boolean description: >- Set to `true` to include the reporting book entries with entries from the specified adjustment books, or `false` to return only entries for the specified adjustment books. example: true default: false adjustmentBook: type: string description: >- Adjustment book IDs for journals that are enabled in the GL configuration. Use `GAAP`, `TAX`, and/or the IDs of user defined books. Do not append text to the IDs. If you need help, look at the Account Balances page in the Sage Intacct UI to see what is enabled. example: GAAP,TAX glAccountNumber: type: string description: >- General ledger account number. If set, overrides `accountGroupName`, `startAccountNumber` and `endAccountNumber`. If no account numbers or groups are set, the response contains data for all accounts. example: '4000' startAccountNumber: type: string description: >- Starting GL account number for including a range of accounts. Requires `endAccountNumber`. example: '4000' endAccountNumber: type: string description: >- Ending GL account number for including a range of accounts. Requires `startAccountNumber`. example: '4999' accountGroupName: type: string description: >- Account group name to include all accounts in the account group. If set, overrides `startAccountNumber` and `endAccountNumber`. example: Payments statistical: type: string description: |- Whether to include statistical accounts. **Valid Values** * `include` - Include both statistical and financial accounts. * `exclude` - Do not include statistical accounts. * `only` - Return account balances only for statistical accounts. default: include example: exclude groupBy: type: string description: >- Comma-separated list of the names of standard and/or user-defined dimensions to break out in the results. For example, setting `groupBy` to `location` causes the response to include balance information for the specified accounts in each location. example: location,department showPeriodBalanceDetail: type: boolean description: >- Set to `true` to include the `PERIODBALANCEDETAIL` amounts in the response as well as the `PERIODBALANCE` amount. Only valid when `contentSelection` is `Actual`. example: true default: false isShowZeroBalances: type: boolean description: Set to `true` to include accounts that have zero balances. example: true default: false showZeroWithActivity: type: boolean description: >- Set to `true` to only include accounts that have zero balances if they have activity. example: true default: false locationId: type: string description: >- ID of a location or location group to filter on. This field is required in a multi-base currency company. example: California includeLocationSubDimensions: type: boolean description: Set to `true` to include location subdimensions. example: true default: true departmentId: type: string description: ID of a department to filter on. example: Sales includeDepartmentSubDimensions: type: boolean description: Set to `true` to include department subdimensions. example: true default: true projectId: type: string description: ID of a project or project group to filter on. example: P-0045 includeProjectSubDimensions: type: boolean description: Set to `true` to include project subdimensions. example: true default: true projectTypeId: type: string description: ID of a project type to filter on. Do not use if `projectId` is set. example: Internal taskId: type: string description: >- ID of a task to filter on. The `projectId` for the task must also be specified. example: 01-052 includeTaskIdSubDimensions: type: boolean description: Set to `true` to include task subdimensions. example: true default: true costTypeId: type: string description: >- ID of a cost type to filter on. Requires that a `taskId` is also specified. example: EQ includeCostTypeIdSubDimensions: type: boolean description: Set to `true` to include cost type subdimensions. example: true default: true customerId: type: string description: The ID of a customer or customer group to filter on. example: C-00003 includeCustomerIdSubDimensions: type: boolean description: Set to `true` to include customer subdimensions. example: true default: true customerTypeId: type: string description: >- The ID of a customer type to filter on. Do not use if `customerId` is set. example: Partners vendorId: type: string description: The ID of a vendor or vendor group to filter on. example: V-00014 includeVendorIdSubDimensions: type: boolean description: Set to `true` to include vendor subdimensions. example: true default: true vendorTypeId: type: string description: >- The ID of a vendor type to filter on. Do not use if `vendorId` is set. example: 1099 Contractors employeeId: type: string description: The ID of an employee or employee group to filter on. example: dwilkes includeEmployeeIdSubDimensions: type: boolean description: Set to `true` to include employee subdimensions. example: true default: true employeeTypeId: type: string description: >- The ID of an employee type to filter on. Do not use if `employeeId` is set. example: Contractor itemId: type: string description: The ID of an item or item group to filter on. example: FV04 productLineId: type: string description: >- The ID of a product line to filter on. Do not use if `itemId` is set. example: Sports Clothing classId: type: string description: The ID of a class or class group to filter on. example: Implementation includeClassIdSubDimensions: type: boolean description: Set to `true` to include class subdimensions. example: true default: true contractId: type: string description: The ID of a contract or contract group to filter on. example: CON-078 includeContractIdSubDimensions: type: boolean description: Set to `true` to include contract subdimensions. example: true default: true warehouseId: type: string description: The ID of a warehouse or warehouse group to filter on. example: WS002 includeWarehouseIdSubDimensions: type: boolean description: Set to `true` to include warehouse subdimensions. example: true default: true userDefinedDimension: type: array description: User defined dimensions to include. items: type: object properties: objectName: type: string example: category recordId: type: string example: '2' recordName: type: string example: CAT1 inventory-control-aisleRequiredProperties: type: object required: - id inventory-control-aisle: type: object description: >- An aisle is one of four optional attributes (zone, aisle, row, and bin face) you can assign to a bin to make it easier to find in the warehouse. properties: key: type: string description: System-assigned key for the aisle. example: '13' readOnly: true id: type: string description: >- Name or other unique identifier for the aisle. The aisle ID cannot be modified. example: A2 description: type: string description: Description for the aisle. example: Aisle 2 Dishwashers href: type: string description: URL for the aisle. readOnly: true example: /objects/inventory-control/aisle/13 audit: $ref: '#/components/schemas/audit' inventory-control-bin-faceRequiredProperties: type: object required: - id inventory-control-bin-face: type: object description: >- A bin face is one of four optional attributes (zone, aisle, row, and bin face) you can assign to a bin to make it easier to find the bin within the warehouse. properties: key: type: string description: System-assigned key for the bin face. example: '3' readOnly: true id: type: string description: >- Unique identifier or name for the bin face. The bin face ID cannot be modified. example: BF232 description: type: string description: Description for the bin face. example: Bin Face 232 href: type: string description: URL for the bin face. example: /objects/inventory-control/bin-face/3 readOnly: true audit: $ref: '#/components/schemas/audit' inventory-control-bin-sizeRequiredProperties: type: object required: - id inventory-control-bin-size: type: object description: >- A bin size in an attribute you can assign to a bin to help determine whether the bin is suitable for storing certain items. properties: key: type: string description: System-assigned key for the bin size. example: '5' readOnly: true id: type: string description: >- Unique identifier or name for the bin size. This ID should make it easy to understand the bin size. This ID cannot be modified. example: 2x2 description: type: string description: Description for the bin size. example: Bin Size 10 Wrenches href: type: string description: URL for the bin size. example: /objects/inventory-control/bin-size/5 readOnly: true audit: $ref: '#/components/schemas/audit' inventory-control-binRequiredProperties: type: object required: - id inventory-control-bin: type: object description: >- A bin identifies a specific location within a warehouse where items are or can be stored. Bins make it easier to find items during transaction processing. properties: key: type: string description: System-assigned key for the bin. example: '10' maxLength: 8 readOnly: true id: type: string description: >- Name or other unique identifier for the bin. The identifier should make it easy to find the bin. For example, if bin 10 is in zone 4, aisle 2, row 3a, and bin face 2, Z4-A2-R3a-BF2-B10 would be a good ID. example: Z4-A2-R3a-BF2-B10 maxLength: 30 description: type: string description: Description of the bin. example: Bin of wrenches 02 maxLength: 100 href: type: string description: URL for this bin. example: /objects/inventory-control/bin/10 readOnly: true warehouse: type: object properties: key: type: string description: System-assigned key for the warehouse. example: '2' id: type: string description: Name or other unique identifier for the warehouse. example: WA2 href: type: string description: URL for the warehouse. example: /objects/inventory-control/warehouse/2 readOnly: true aisle: type: object properties: key: type: string description: System-assigned key for the aisle. example: '13' id: type: string description: Name or other unique identifier for the aisle. example: A2 href: type: string description: URL for the aisle. example: /objects/inventory-control/aisle/13 readOnly: true row: type: object properties: key: type: string description: System-assigned key for the row. example: '23' id: type: string example: R3a description: Name or other unique identifier for the row. href: type: string description: URL for the row. example: /objects/inventory-control/row/23 readOnly: true zone: type: object properties: key: type: string description: System-assigned key for the zone. example: '12' id: type: string example: Z4 description: Name or other unique identifier for the zone. href: type: string description: URL for the zone. example: /objects/inventory-control/zone/12 readOnly: true binFace: type: object properties: key: type: string description: System-assigned key for the bin face. example: '3' id: type: string example: BF2 description: Name or other unique identifier for the bin face. href: type: string description: URL for the bin face. example: /objects/inventory-control/bin-face/3 readOnly: true binSize: type: object properties: key: type: string description: System-assigned key for the Bin Size example: '5' id: type: string example: B10 description: Name or other unique identifier for the bin size. href: type: string description: URL for the bin size. example: /objects/inventory-control/bin-size/5 readOnly: true sequenceNumber: type: string maxLength: 10 description: >- Sequence number for the bin. Sequence numbering supports more efficient picking, packing, and cycle counts. example: '1233' pattern: ^-{0,1}[0-9]*\.{0,1}[0-9]*$ isPortable: type: boolean description: >- Set to true if the bin can be moved to another location, otherwise set to false. example: true default: false status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' inventory-control-itemRequiredProperties: type: object required: - id - name - itemType - costMethod inventory-control-item-landed-cost: type: object description: > A landed cost item is a non-inventory item that represents a landed cost expense, such as freight, insurance, customs duties, or handling fees. This object is valid when Inventory Control is configured to enable landed costs. properties: key: type: string description: System-assigned key for the item landed cost. readOnly: true example: '23' maxLength: 8 id: type: string description: System-assigned ID for the item landed cost. readOnly: true example: '23' maxLength: 8 href: type: string description: Endpoint URL for the item landed cost. readOnly: true example: /objects/inventory-control/item-landed-cost/23 distributionMethod: type: string description: >- The distribution method for the item landed cost. The distribution method provides a fair distribution of landed costs across multiple items. example: count enum: - volume - weight - count distributionMethodBaseUnit: type: string description: >- A read-only field that provides the base unit for the distribution method. readOnly: true example: Each landedCostValue: type: string description: > This field establishes how the landed cost is distributed for the associated item. This value should be appropriate for the unit of measure (UOM) for the item. For example, if the distribution method is weight and the base unit for the item is ounce, and the item weighs 1 pound, a value of 16 to represent 1 pound in ounces is appropriate. example: '16' format: decimal-precision-9 minimum: 0 active: type: boolean description: >- If set to `true`, the landed cost value provided will be distributed for the item. example: true default: false item: type: object description: Item associated with the landed cost. properties: key: type: string description: System-assigned key for the item. example: '1000' maxLength: 8 id: type: string description: Unique identifier for the item. example: Dell Laptop maxLength: 30 href: type: string description: Endpoint URL for the item. readOnly: true example: /objects/inventory-control/item/1000 tax.item-tax-group-item-map: type: object description: >- This object maps items to a corresponding item tax group which includes a standard tax solution. properties: key: type: string description: System-assigned key for the item-tax-group-item-map. readOnly: true example: 2 id: type: string description: Item tax group item map ID. readOnly: true example: 2 href: type: string description: Endpoint for the item-tax-group-item-map. readOnly: true example: /objects/tax/item-tax-group-item-map/2 item: type: object description: Inventory item. properties: key: type: string description: System-assigned key for the item. example: 1 id: type: string description: Unique identifier for the item. example: 1 href: type: string description: Item details URL. readOnly: true example: /objects/inventory-control/item/1 taxSolution: type: object description: Tax solution associated with the tax group. properties: key: type: string description: System-assigned key for the tax solution. example: 4 id: type: string description: Unique identifier for the tax solution. example: Canadian Sales Tax - SYS href: type: string description: URL for the tax solution. readOnly: true example: /objects/tax/tax-solution/4 taxGroup: type: object description: The tax group to which the item is assigned. properties: key: type: string description: System-assigned key for the tax group. example: 4 id: type: string description: Unique identifier for the tax group. example: Goods Exempt Rate - CA href: type: string description: URL for the tax group. readOnly: true example: /objects/tax/item-tax-group/4 inventory-control-item-warehouse-vendor: type: object description: >- Use this object to specify the vendor information you want to use in the replenishment calculations for the item in this warehouse. properties: key: type: string description: System generated Item Warehouse Vendor Key readOnly: true example: '5' id: type: string description: System generated Item Warehouse Vendor ID readOnly: true example: '5' itemWarehouse: type: object description: The item warehouse combination that can be ordered from the vendor. properties: key: type: string description: System generated Item Warehouse Inventory Key example: '13' maxLength: 8 id: type: string description: System generated Item Warehouse Inventory ID example: '13' maxLength: 8 href: type: string description: Item Warehouse Inventory URL. readOnly: true example: /objects/inventory-control/item-warehouse-inventory/13 vendor: type: object description: >- The vendor to use in the replenishment calculations for the item in this warehouse. properties: key: type: string description: System generated Vendor Key example: '38' maxLength: 8 id: type: string description: User sepcified Vendor ID example: Office_Supplies maxLength: 20 href: type: string description: Vendor details URL. readOnly: true example: /objects/accounts-payable/vendor/38 stockNumber: type: string description: The stock number that vendor uses for this item. example: '#5678901234' maxLength: 50 leadTime: type: integer description: >- The number of days it takes the vendor to deliver this item to you after receiving the order. example: 15 maxLength: 3 demandForecastDuringLeadTime: type: integer description: >- The quantity of this item that's expected to be sold during the lead time. example: 5 economicalOrderQuantity: type: integer description: >- The quantity that makes the cost of reordering this item the most economical. example: 10 maxLength: 8 vendorMinimumOrderQuantity: type: integer description: The minimum quantity of this item the vendor is willing to sell. example: 10 maxLength: 8 bestPrice: type: string description: The lowest price you paid for the item. readOnly: true format: decimal-precision-2 example: '100' maxLength: 8 latestPrice: type: string description: This latest price you paid for the item. readOnly: true format: decimal-precision-2 example: '110' maxLength: 8 unitOfMeasure: type: object description: The units of measure detail is the vendor sells this item in. properties: key: type: string description: The units of measure Key example: '38' maxLength: 8 id: type: string description: The units of measure Id. example: Each maxLength: 20 href: type: string description: Units of measure URL. readOnly: true example: /objects/inventory-control/unit-of-measure/38 conversionFactor: type: string description: >- The number of base units required to equal the measure of the corresponding related unit. readOnly: true example: '1' maxLength: 30 isPreferredVendor: type: boolean description: >- This identify a vendor as the preferred vendor for replenishing this item for warehouse. example: false default: false href: type: string description: Endpoint for the item warehouse vendor. readOnly: true example: /objects/inventory-control/item-vendor/5 inventory-control-item-warehouse-standard-cost: type: object description: >- Standard cost for Item for warehouse. You can record different standard costs for different date ranges for item and warehouse combinations. properties: key: type: string description: System-assigned key for item warehouse standard cost. readOnly: true example: '23' maxLength: 8 id: type: string description: System assigned ID for item warehouse standard cost. readOnly: true example: '23' maxLength: 8 href: type: string description: Endpoint for the item warehouse standard cost. readOnly: true example: /objects/inventory-control/item-warehouse-standard-cost/23 effectiveStartDate: type: string description: > Set the date at which the cost will be effective. The cost is used in the journal entries to debit Costs of Goods Sold and credit Inventory. Any postings before the first effective start date will use a cost of zero. The cost for the last effective start date is used for any postings after that date until a subsequent effective start date is entered. format: date example: '2021-01-23' maxLength: 10 standardCost: type: string description: >- Provide the standard cost that will be effective from effective date. example: '122' format: decimal-precision-10 maxLength: 15 minimum: 0 itemWarehouse: type: object description: Provide the Item warehouse information properties: key: type: string description: System generated Item Warehouse Inventory Key example: '13' maxLength: 8 id: type: string description: System generated Item Warehouse Inventory ID example: '13' maxLength: 8 href: type: string description: Item Warehouse Inventory URL. readOnly: true example: /objects/inventory-control/item-warehouse-inventory/13 itemId: type: string description: Related Item Id for item warehouse inventory. readOnly: true example: LapTop Kit 1 maxLength: 30 warehouseId: type: string description: Related Warehouse Id for item warehouse inventory. readOnly: true example: WS001 maxLength: 40 audit: $ref: '#/components/schemas/audit' inventory-control-item-warehouse-inventory: type: object description: >- Warehouse inventory information is used with Inventory and Stockable Kit items. properties: key: type: string description: System-assigned key for the item warehouse inventory information. readOnly: true example: '1' id: type: string description: Unique identifier for the item warehouse inventory information. readOnly: true example: '1' item: type: object description: Details for the good, service, or kit that is purchased or sold. properties: key: type: string description: System-assigned key for the item. example: '9' id: type: string description: Unique identifier for the item. example: Prnt_Paper href: type: string description: URL for the item. readOnly: true example: /objects/inventory-control/item/9 warehouse: type: object description: Details for the warehouse or stocking location for the item. properties: key: type: string description: System-assigned key for the warehouse. example: '1' id: type: string description: Unique identifier for the warehouse. example: WH10001 href: type: string description: URL for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/1 storageArea: type: string description: >- Location within the warehouse where the item is normally stored, such as Aisle 23, Row 12, Shelf 3, Bin 5. example: Bin 5 inventoryCycle: type: object description: >- Inventory cycles are used to keep track of when to take physical inventory. properties: key: type: string description: System-assigned key for the inventory cycle. example: '2' id: type: string description: Unique identifier for the inventory cycle. example: Daily Cycle href: type: string description: URL for the inventory cycle. readOnly: true example: /objects/inventory-control/cycle/2 economicOrderQuantity: type: integer description: >- The quantity that makes the cost of reordering this item the most economical by minimizing total holding costs and total ordering costs. example: 10 standardCost: type: string description: >- The planned or expected costs. Used in situations where purchase costs remain relatively stable over time. example: '110' lastCost: type: string description: The most recent cost information for the item. readOnly: true example: '100' averageCost: type: string description: The weighted average of all units. readOnly: true example: '100' reorderMethod: type: string description: Available methods to reorder items when the inventory stock is low. enum: - null - economicQuantity - maxStockLevel - reorderPoint example: economicQuantity nullable: true default: null readOnly: true reorderPoint: type: integer description: >- Value used as the starting point to determine when the item needs to be replenished. example: 121 reorderQuantity: type: integer description: >- When current net inventory falls to the reorder point plus the safety stock, the item is triggered for reorder with reorder quantity. example: 10 minOrderQuantity: type: integer description: The minimum quantity to be reordered at one time. example: 10 maxOrderQuantity: type: integer description: The maximum quantity to be reordered at one time. example: 100 maximumStock: type: integer description: The quantity of the item you do not want to exceed in the inventory. example: 300 minimumStock: type: integer description: >- The quantity of the item you do not want to fall below in the inventory. example: 50 lastSoldDate: type: string format: date example: '2022-04-08' description: Last date the item was sold. readOnly: true lastReceivedDate: type: string format: date example: '2022-04-10' description: Last date the item was received. readOnly: true defaultBin: type: object description: Default bin details for the item. properties: key: type: string description: System-assigned key for the default bin. example: '45' id: type: string description: Unique identifier for the default bin. example: '45' href: type: string description: URL for the default bin. readOnly: true example: /objects/inventory-control/bin/45 warehouseLocation: type: object description: Warehouse location and currency details for the item. readOnly: true properties: key: type: string description: System-assigned key for the warehouse location. readOnly: true example: '3' id: type: string description: Unique identifier for the warehouse location. readOnly: true example: LOC-USA-0778 currency: type: string description: Currency for the warehouse location. readOnly: true example: USD href: type: string description: URL for the warehouse location. readOnly: true example: /objects/company-config/entity/3 safetyStock: type: integer description: >- The extra quantity to have in inventory to avoid running out of stock. example: 20 replenishmentMethod: type: string description: >- Replenishment method to use to automatically identify and reorder items when inventory is low. enum: - null - demandForecastBySingleValue - reorderPoint - demandForecastByFluctuatingValues example: reorderPoint nullable: true default: null enableReplenishment: type: boolean description: Set replenishment to `true` to replenish the items. example: true default: true onOrder: type: integer description: >- Quantities that are expected to arrive in the warehouse from purchase orders. example: 100 readOnly: true inTransit: type: integer description: Total number of warehouse transfer items that are in transit. example: 50 readOnly: true onHand: type: integer description: >- The item total received into the warehouse less the total that have been shipped from the warehouse. example: 200 readOnly: true onHold: type: integer description: The quantity of the item that is on hold for the transaction. example: 10 readOnly: true reserved: type: integer description: >- The reserved quantity for a warehouse is subtracted from available items to keep that amount from being sold. example: 50 readOnly: true allocated: type: integer description: >- The allocated inventory quantity is the count of items present in the warehouse, which are reserved to open sale orders. example: 20 readOnly: true unCommitted: type: integer description: >- Uncommitted inventory is excess inventory, the difference between the forecast and the inventory. example: 500 readOnly: true href: type: string description: URL for the item warehouse inventory. example: /objects/inventory-control/item-warehouse-inventory/1 readOnly: true itemWarehouseVendor: type: array description: >- Only required when override replenishment values on the enableReplenishment is set to true. Provide vendor information you want to use in the replenishment calculations for the item in this warehouse. items: $ref: '#/components/schemas/inventory-control-item-warehouse-vendor' standardCostEntries: type: array description: >- You can provide the standard cost of the item for the warehouse. You can use different standard costs for different date ranges. items: $ref: '#/components/schemas/inventory-control-item-warehouse-standard-cost' audit: $ref: '#/components/schemas/audit' inventory-control-item-vendor: type: object description: >- This object provides details about an item that can be purchased from a particular vendor. properties: key: type: string description: System-assigned key for the item vendor. readOnly: true example: '5' id: type: string description: Unique ID for the item vendor. readOnly: true example: '5' item: type: object description: The item that can be ordered from the vendor. properties: key: type: string description: System-assigned key for the item. example: '13' id: type: string description: Unique ID for the item. example: Phones href: type: string description: Endpoint URL for the item. readOnly: true example: /objects/inventory-control/item/9 vendor: type: object description: The vendor the item can be ordered from. properties: key: type: string description: System-assigned key for the vendor. example: '38' id: type: string description: Unique ID for the vendor. example: Office_Supplies href: type: string description: Endpoint URL for the vendor. readOnly: true example: /objects/accounts-payable/vendor/38 stockNumber: type: string description: The stock number that vendor uses for this item. example: '#5678901234' leadTime: type: integer description: >- The number of days it takes the vendor to deliver this item to you after receiving the order. example: 15 demandForecastDuringLeadTime: type: integer description: >- The quantity of this item that's expected to be sold during the lead time. example: 5 economicalOrderQuantity: type: integer description: >- The quantity that makes the cost of reordering this item the most economical. example: 10 vendorMinimumOrderQuantity: type: integer description: The minimum quantity of this item the vendor is willing to sell. example: 10 bestPrice: type: string description: The lowest price paid for the item. readOnly: true format: decimal-precision-2 example: '100' latestPrice: type: string description: The latest price paid for the item. readOnly: true format: decimal-precision-2 example: '110' unitOfMeasure: type: object description: The unit of measure the vendor sells this item in. properties: key: type: string description: System-assigned key for the unit of measure. example: '38' id: type: string description: Unique ID for the unit of measure. example: Each href: type: string description: Endpoint URL for the unit of measure. readOnly: true example: /objects/inventory-control/unit-of-measure/38 conversionFactor: type: string description: >- The number of base units required to equal the measure of the corresponding related unit. readOnly: true example: '1' isPreferredVendor: type: boolean description: >- Identifies a preferred vendor for replenishing this item for warehouses that do not have a vendor specified. example: false default: false href: type: string description: Endpoint URL for the item vendor. readOnly: true example: /objects/inventory-control/item-vendor/5 inventory-control-kit-component: type: object description: >- Kit-Components are common combinations of items to be ordered and invoiced as a single item for simplifying data entry. properties: key: type: string description: System generated kit-component key example: '1' readOnly: true id: type: string description: System generated kit-component identifier. example: '1' readOnly: true kit: type: object description: Kit is item of type kit or stockable kit. properties: key: type: string description: System generated Item key example: '27' id: type: string description: Item unique identifier. example: Kit_1 href: type: string description: Item URL details. example: /objects/inventory-control/item/27 readOnly: true component: type: object description: >- Components are items to be ordered and invoiced as a single item (i.e. kit or stockable kit). properties: key: type: string description: System generated Item key example: '10' id: type: string description: Item unique identifier. example: Prnt_Paper href: type: string description: Item/Component URL details. example: /objects/inventory-control/item/10 readOnly: true name: type: string description: The unique name of the item. example: Paper for Printer readOnly: true costMethod: type: string description: >- The cost method affects how the inventory cost layers are used, the total valuation is determined, and the unit cost is derived for an inventory item. example: standard enum: - standard - average - FIFO - LIFO readOnly: true itemType: type: string description: Type of the item. example: inventory enum: - inventory - nonInventory - purchaseOnlyNonInventory - salesOnlyNonInventory - kit - stockableKit readOnly: true standardCost: type: string description: >- The planned or expected costs. This method is used in situations where purchase costs remain relatively stable over time. format: decimal-precision-9 example: '100.00' maxLength: 15 readOnly: true unitOfMeasure: type: string description: The standard unit of measure of the above item (i.e. component). example: 10 Pack readOnly: true numberOfUnits: type: number description: Number of component units required in this kit. example: 1 revenuePercentage: type: number description: >- When item sold as part of Kit, the revenue part of the each item will calculated based on the given percentage. example: 10 maximum: 100 minimum: 0 defaultDeliveryStatus: type: string description: >- Default that will indicate the most common delivery status of this item when it's sold. enum: - delivered - undelivered example: delivered default: delivered defaultDeferralStatus: type: string description: >- Choose whether to defer until this item is delivered or until the entire bundle is delivered. enum: - deferUntilItemIsDelivered - deferBundleUntilItemIsDelivered example: deferUntilItemIsDelivered default: deferUntilItemIsDelivered lineNumber: type: integer description: >- Line number of Kit Component on Kit. If not provided, the system automatically assigns a unique line number. If the user specifies the linenumber already used, the application will push set other lines to unique numbers. example: 1 href: type: string description: kit-component URL example: /objects/inventory-control/kit-component/1 readOnly: true audit: $ref: '#/components/schemas/audit' inventory-control-item-cross-reference: type: object description: >- An item cross reference associates an inventory item with a specific customer or vendor, or with another inventory item. properties: key: type: string description: System-assigned key for the item cross reference. readOnly: true example: '23' id: type: string description: >- ID for the item cross reference. This value is the same as the `key` for this object. readOnly: true example: '23' href: type: string description: Endpoint URL for the item cross reference. readOnly: true example: /objects/inventory-control/item-cross-reference/23 referenceType: type: string description: >- Reference type. Use `vendor` or `customer` for an external cross reference. Use `substitute`, `upgrade`, `downgrade`, or `complement` for an internal cross reference. example: substitute enum: - customer - vendor - substitute - upgrade - downgrade - complement itemAliasId: type: string description: >- Required for an external cross reference. Identifier for the item as understood by the given vendor or customer. Must be unique for the combination of vendor/item or customer/item. example: Logitech - MK825 maxLength: 100 default: null nullable: true itemAliasDescription: type: string description: Description of the item alias for the cross reference. example: Logitech - MK825 Wireless Keyboard and Mouse maxLength: 50 nullable: true default: null unitOfMeasure: type: object description: Valid unit of measure for the item. properties: key: type: string description: System-assigned key for the unit of measure. example: '21' nullable: true id: type: string description: Valid unit of measure ID for the item. example: EACH nullable: true href: type: string description: Endpoint URL for the unit of measure. readOnly: true example: /objects/inventory-control/unit-of-measure/21 referenceTypeContext: type: string description: >- The system assigns `external` when the `referenceType` is `customer` or `vendor`. For all other `referenceType` values, the system assigns `internal`. example: internal readOnly: true enum: - internal - external alternateItem: type: object description: >- An alternate item. This field is required when using an internal `referenceType`, such as `substitute` or `upgrade`. properties: key: type: string description: System-assigned key for the alternate item. example: '22' nullable: true id: type: string description: ID for the alternate item. example: Logitech-MK850 nullable: true name: type: string description: Name of alternate item. example: MK850 Wireless Keyboard and Mouse nullable: true readOnly: true href: type: string description: Endpoint URL for the alternate item. readOnly: true example: /objects/inventory-control/item/22 customer: type: object description: The customer ID is required if `referenceType` is `customer`. properties: key: type: string description: System-assigned key for the customer. example: '11' nullable: true id: type: string description: Customer ID, which is required if `referenceType` is `customer`. example: C00023 nullable: true name: type: string description: Name of the customer. example: EDCO Financial nullable: true readOnly: true href: type: string description: Endpoint URL for the customer. readOnly: true example: /objects/accounts-receivable/customer/11 item: type: object description: Inventory item to create the cross reference for. properties: key: type: string description: System-assigned key for the item. example: '13' id: type: string description: ID for the item. example: Logitech-MK825 name: type: string description: Name of the item. example: MK825 Wireless Keyboard and Mouse readOnly: true href: type: string description: Endpoint URL for the item. readOnly: true example: /objects/inventory-control/item/13 vendor: type: object description: The vendor ID is required if `referenceType` is `vendor`. properties: key: type: string description: System-assigned key for the vendor. example: '22' nullable: true id: type: string description: Vendor ID, which is required if `referenceType` is `vendor`. example: V0001 nullable: true name: type: string description: Name of the vendor. example: Ez Tech Solutions nullable: true readOnly: true href: type: string description: Endpoint URL for the vendor. readOnly: true example: /objects/accounts-payable/vendor/22 audit: $ref: '#/components/schemas/audit' inventory-control-item: type: object description: >- Items are goods, services, or kits that you purchase from vendors or sell to customers. properties: key: type: string description: System-assigned key for the item. readOnly: true example: '23' maxLength: 8 id: type: string description: Unique identifier for the item. example: '23' maxLength: 30 name: type: string description: Unique name for the item. example: Dell Laptop 13inch maxLength: 100 status: $ref: '#/components/schemas/status' itemType: type: string description: >- The type for the item. Item type determines where the item will be available. enum: - inventory - nonInventory - purchaseOnlyNonInventory - salesOnlyNonInventory - kit - stockableKit default: inventory example: inventory enableFulfillment: type: boolean description: >- Set this field to true if you want to enable fulfillment for non inventory item. example: true default: false isItemEnabledForMRR: type: boolean description: > Whether to include the item in the Software Digital Board Book calculations of monthly recurring revenue. Changing an item's MRR field only affects new transactions or contract lines going forward. It will not affect existing transactions or contract lines. The best practice is to not change an item's MRR setting once the item has been used in a transaction. If you need to change your item's MRR configuration after implementing Digital Board Book (DBB), contact your Sage Intacct account manager for more information. This field is only applicable if your company subscribes to the Software Digital Board Book. example: true default: false productLine: type: object description: Provide product line to which this item belongs. properties: key: type: string description: Record number of product line example: '59' maxLength: 8 id: type: string description: ID of the product line to which the item belongs. example: '1233' maxLength: 30 href: type: string description: URL for this product line. readOnly: true example: /objects/product-linel/59 costMethod: type: string enum: - null - standard - average - FIFO - LIFO description: > Set the accounting method to use to determine the cost of inventory. This field applies only if Inventory Control is configured to enable multiple cost methods and the item type is Inventory. After you create an item, you cannot change its cost method. example: standard default: standard nullable: true extendedDescription: type: string description: > Provide a detailed description of the item. This is most useful if you have many items that have only slight variations. The description is used as the default Item description when the item is entered in Order Entry, Purchasing, and Inventory Control transactions. example: 13 inch dell laptop maxLength: 400 poDescription: type: string description: > Use this field to provide a purchase transaction description that was used in a legacy accounting system during implementation or to provide additional item details for internal reporting. This description does not appear in any transactions and does not print on any documents. example: 13 inch dell laptop maxLength: 400 soDescription: type: string description: > Use this field to provide a sales transaction description that was used in a legacy accounting system during implementation or to provide additional item details for internal reporting. This description does not appear in any transactions and does not print on any documents. example: 13 inch dell laptop maxLength: 400 unitOfMeasureGroup: type: object description: Unit of measure group for the item. properties: key: type: string description: System-assigned key for the unit of measure group. example: '10' maxLength: 8 id: type: string description: Unique identifier for the unit of measure group. example: '10' href: type: string description: URL for the unit of measure group. readOnly: true example: /objects/inventory-control/unit-of-measure-group/10 notes: type: string description: Notes or detailed information not captured elsewhere. example: Dell 13 inch laptop maxLength: 1000 dateLastSold: description: Date last sold type: string format: date example: '2014-01-08' readOnly: true dateLastReceived: description: Date last received type: string format: date example: '2014-01-08' readOnly: true quantityOnOrder: description: >- The item total for the quantity on order. Item totals are combined for all warehouses and automatically displayed based on transaction entries. type: string example: '10' readOnly: true maxLength: 10 quantityInTransit: description: >- The item total in warehouse transfers that are in transit. Item totals are combined for all warehouses and automatically displayed based on transaction entries. In addition, you can view totals per warehouse. This field applies only if in-transit warehouse transfers is enabled. type: string example: '2' readOnly: true maxLength: 10 quantityOnHand: description: >- The item total for quantity on hand. Item totals are combined for all warehouses and automatically displayed based on transaction entries. In addition, you can view totals per warehouse. type: string example: '3' readOnly: true maxLength: 10 quantityOnHold: description: >- The item total for the quantity on hold. Item totals are combined for all warehouses and automatically displayed based on transaction entries. In addition, you can view totals per warehouse. type: string example: '3' readOnly: true maxLength: 10 quantityReserved: description: >- The item total for the quantity reserved. Item totals are combined for all warehouses and automatically displayed based on transaction entries. In addition, you can view totals per warehouse. type: string example: '3' readOnly: true maxLength: 10 quantityAllocated: description: >- The item total for the quantity allocated. Item totals are combined for all warehouses and automatically displayed based on transaction entries. In addition, you can view totals per warehouse. type: string example: '3' readOnly: true maxLength: 10 quantityUncommitted: description: >- The item total for the quantity uncommitted. Item totals are combined for all warehouses and automatically displayed based on transaction entries. In addition, you can view totals per warehouse. type: string example: '3' readOnly: true maxLength: 10 inventory: type: object properties: shippingWeight: type: number description: Total shipping weight for the item. example: 1233 maxLength: 10 autoPrintLabel: type: boolean default: false description: > Set to true if using a third-party label scanner to print barcode labels when processing the item in purchasing transactions. When set to true, this field triggers label printing for the received quantity. This field is used with scanner integrations and has no functionality within Sage Intacct. This field applies to inventory items and stockable kits only if the Integrated scanner product in use option is enabled during inventory control configuration. example: false glGroup: type: object description: The GL group to which the item belongs. title: glGroup properties: id: type: string description: Unique identifier for the GL group. example: '1501.0' defaultRevenueRecognitionTemplate: type: string description: Default revenue recognition template ID. example: '1232' incomeGLAccount: type: string description: Revenue GL account number. example: '12322' inventoryGLAccount: type: string description: Inventory GL account number example: '12322' expenseGLAccount: type: string description: Expense GL account number example: '12322' cogsGLAccount: type: string description: COGS GL account number example: '12322' arGLAccountNumber: type: string description: AR GL account number example: '12322' apGLAccountNumber: type: string description: AP GL account number example: '12322' deferredRevenueGLAccountNumber: type: string description: Deferred revenue GL account number example: '12322' vsoeCategory: type: string description: Fair value category. example: software default: null enum: - null - productSpecified - software - productUnspecified - upgradeUnspecified - upgradeSpecified - services - postContractSupport nullable: true vsoeDefaultDeliveryStatus: type: string description: VSOE default delivery status. example: delivered default: delivered enum: - null - delivered - undelivered nullable: true vsoeDefaultDeferralStatus: type: string description: VSOE default deferral status. example: deferUntilItemIsDelivered default: deferUntilItemIsDelivered enum: - null - deferUntilItemIsDelivered - deferBundleUntilItemIsDelivered nullable: true substituteItemId: type: string description: Substitute item ID example: Dell Laptop 14inch tracking: type: object description: >- Provide information about if item is tracked by serial, lot, bin, expiration date, or any combination of those. properties: enableSerialNo: type: boolean description: >- Serial tracking enabled. Applicable to inventory or stockable kit item types. example: false default: false serialMask: type: string description: >- Serial number mask to enforce a specific format. Applicable to inventory or stockable kit item types. example: XXAS maxLength: 30 enableLotCategory: type: boolean description: >- Lot tracking enabled. Applicable to inventory or stockable kit item types. example: false default: false lotCategory: type: string description: >- Lot category. Applicable to inventory or stockable kit item types. example: Kitchen maxLength: 30 enableBins: type: boolean description: >- Bin tracking enabled. Applicable to inventory or stockable kit item types. example: false default: false enableExpiration: type: boolean description: >- Expiration tracking enabled. Applicable to inventory or stockable kit item types. example: false default: false precision: type: object description: > These numbers override the default precision, or number of decimal places, for this item in the Inventory Control, Order Entry, and Purchasing applications. For example, an item with a cost of $0.00456 requires five decimal places. Depending on your needs, you can assign the item a different precision in each application. For example, you can enter 4 in Purchasing and Inventory and 2 in Sales. The default precision as shipped from Intacct is two decimal places for each application. However, for Order Entry and Purchasing, you can change this default to a precision of up to 10 decimal places in the application's configuration. While Sage Intacct uses the number of decimal places specified here for the item in transactions, it rounds values to 10 decimal places for costing calculations, to 2 decimal places for the General Ledger, and to 2 decimal places for reports. If your company is subscribed to Contracts, the value of Unit cost precision. Sales must either be blank or 10. In this scenario, the best practice is to leave this field blank. properties: upc: type: string description: Universal Product Code (UPC) for the item. example: '23342' maxLength: 40 inventoryPrecision: type: integer description: Inventory unit cost precision example: 2 maxLength: 2 salesPrecision: type: integer description: Sales unit cost precision example: 2 maxLength: 2 purchasingPrecision: type: integer description: Sales unit cost precision example: 2 maxLength: 2 landedCost: type: object properties: enableLandedCost: type: boolean description: > For inventory items set true to have Sage Intacct distribute landed costs to this item. For Non-inventory and Non-inventory (purchase only) set this field to to identify the item as a landed cost. These items are used to enter the actual landed cost amounts (such as for shipping, insurance, and customs) for which you’re invoiced after purchasing inventory items. example: false default: false itemLandedCost: type: array description: >- Only for Inventory items. Provide the count, volume, and weight of the item expressed in the base unit of the unit of measure (UOM) so a landed cost is distributed proportionately to the item when a landed cost is distributed across multiple items. items: $ref: '#/components/schemas/inventory-control-item-landed-cost' replenishment: type: object description: > When replenishment is enabled on the Configure Inventory Control, use this section of fields to include the item in replenishment, which automates the process of identifying when to reorder items and generating purchase orders. The values you enter are used in the replenishment calculations and drive the reorder information displayed for the item on the Replenish Inventory. properties: enableReplenishment: type: boolean description: Enable replenishment for this item in the Vendor history. example: false default: false unitOfMeasureDefault: type: string description: >- Units of measure default for base units for inventory replenishment for this item in the Vendor history. For example, with the Count unit of measure group, you can specify each, dozen, or pair. See the information about unit of measure groups in the Sage Intacct product help. example: Each safetyStock: type: integer description: >- Safety stock for this item in the Vendor history. Extra quantity held in inventory to reduce the risk of stock outs due to uncertainty in supply and demand. example: 2 default: 0 maxLength: 10 maximumOrderQuantity: type: integer description: >- Maximum order quantity for this item in the Vendor history. Largest amount you can order in any one order. The provided may be affected by the economic order quantity and/or unit of measure set on the vendor. example: 10 default: 0 maxLength: 10 replenishmentMethod: type: string description: > Replenishment method for this item in the Vendor history. Provide how the amount to reorder is calculated. Reorder point - base calculation on a specific reorder quantity and optional safety stock quantity Demand forecast by single value - base calculation on lead time for the vendor Demand forecast by statistical account - base calculation on statistical journal entries for a statistical account (statistical account must be configured for inventory) See the information about replenishment methods and calculations in the Sage Intacct product help. example: reorderPoint enum: - '' - demandForecastBySingleValue - reorderPoint - demandForecastByFluctuatingValues default: '' reorderPoint: type: integer description: >- Reorder point specifying the quantity of inventory that you don’t want to fall below. When the current net inventory falls to the reorder point plus the safety stock, the item is triggered for reorder. Use blank or positive integers. Applies when the replenishmentMethod is Reorder point example: 1 minimum: 0 maxLength: 10 reorderQuantity: type: integer description: >- Reorder quantity for this item in the Vendor history. As an example, if 12 units are needed according to other replenishment calculations, a reorder quantity of 50 would cause the generated purchase order to be for 50. Applies when the replenishmentMethod is Reorder point example: 1 default: 0 maxLength: 10 forecastDemandInLeadTime: type: integer description: >- Forecast demand in lead time. Provide the quantity of this item expected to be sold during the lead time. Valid values are blank, 0, and positive integers. Only applicable when the REPLENISHMENT_METHOD is Demand forecast by a single value. Only applicable when the replenishmentMethod is Demand forecast by a single value. example: 1 default: 1 minimum: 0 maxLength: 10 itemDetails: type: object description: >- The Item details gives wholesale distribution companies the ability to define an item with many more attributes that are unique for their operations. properties: primaryCountryOfOrigin: type: string description: Primary country of origin. example: China 75% maxLength: 30 condition: type: string description: Condition name or descriptor. example: good maxLength: 30 engineeringAlert: type: string description: Engineering Alert name or descriptor. example: Software Setup maxLength: 30 specification1: type: string description: Specification name/descriptor 1. example: length 12 cm maxLength: 30 specification2: type: string description: Specification name/descriptor 2. example: width 12 cm maxLength: 30 specification3: type: string description: Specification name/descriptor 3. example: height 13 cm maxLength: 30 universalProductCode: type: integer description: UPC-12, the 12-digit Universal Product Code of the item. example: 123456789123 maxLength: 12 internationalArticleNumber: type: integer description: EAN-13, the 13-digit International Article Number of the item. example: 1234567891234 maxLength: 13 isSafetyItem: type: boolean description: Use true if item is classified as a Safety Item. example: true default: false isRestrictedItem: type: boolean description: Use true if item is classified as a Restricted Item. example: true default: false isCompliantItem: type: boolean description: Use true if item is classified as a Compliant Item. example: true default: false isApprovedByEngineering: type: boolean description: Use true if item is approved by engineering. example: true default: false isApprovedByQualityControl: type: boolean description: Use true if item is approved by quality control. example: true default: false isApprovedBySales: type: boolean description: Use true if item is approved by sales. example: true default: false measurements: type: object properties: weightUnitOfMeasure: type: object description: >- Provide shipWeight without weightUnitOfMeasure or netWeight, but if you provide netWeight you must also specify the other two. weightUnitOfMeasure must be set to one of the values defined for the Weight unit of measure. properties: id: type: string description: Id of unit of measure example: Grams maxLength: 50 key: type: string description: system generated key of unit of measure example: '25' maxLength: 8 href: type: string description: URL for the unit of measure. readOnly: true example: /objects/inventory-control/unit-of-measure/25 netWeight: type: number description: Net weight of item. example: 1.67 maxLength: 13 lengthWidthHeightUnitOfMeasure: type: object description: >- The size of the item, useful for calculating storage bin and shipping box size requirements. Specify the unit of measure and the length, width, and height. You must specify all four values or none. lengthWidthHeightUnitOfMeasure must be set to one of the values defined for the length unit of measure. properties: id: type: string description: Id of unit of measure example: inches maxLength: 50 key: type: string description: system generated key of unit of measure example: '21' maxLength: 8 href: type: string description: URL for the unit of measure. readOnly: true example: /objects/inventory-control/unit-of-measure/21 length: type: number description: Length of item. example: 10 maxLength: 13 width: type: number description: Width of item. example: 23 maxLength: 13 height: type: number description: Height of item. example: 11.23 maxLength: 13 thicknessUnitOfMeasure: type: object description: >- The thickness of the item, useful for calculating storage bin or shipping box size requirements. Specify the unit of measure, actual thickness, and minimum and maximum thickness. You must specify all four values or none. If the item thickness does not vary, set all three thickness fields to the same value. thicknessUnitOfMeasure must be set to one of the values defined for the length unit of measure. properties: id: type: string description: Id of unit of measure example: inches maxLength: 50 key: type: string description: system generated key of unit of measure example: '21' maxLength: 8 href: type: string description: URL for the unit of measure. readOnly: true example: /objects/inventory-control/unit-of-measure/21 thickness: type: number description: Thickness of Item example: 10 maxLength: 13 maximum: 99999999.99 minimumThickness: type: number description: Minimum thickness of Item example: 23 maxLength: 13 maximum: 99999999.99 maximumThickness: type: number description: Maximum thickness of Item example: 11.23 maxLength: 13 maximum: 99999999.99 areaUnitOfMeasure: type: object description: >- The area of the item. You must specify both or neither. areaUnitOfMeasure must be set to one of the values defined for the Area unit of measure. properties: id: type: string description: Id of unit of measure example: Square Feet maxLength: 50 key: type: string description: system generated key of unit of measure example: '22' maxLength: 8 href: type: string description: URL for the unit of measure. readOnly: true example: /objects/inventory-control/unit-of-measure/22 area: type: number description: Area of Item example: 0.567 maxLength: 13 volumeUnitOfMeasure: type: object description: >- The item unit of measure and total volume. You must specify both or neither. volumeUnitOfMeasure must be set to one of the values defined for the Volume unit of measure. properties: id: type: string description: Id of unit of measure example: Cubic Meter maxLength: 50 key: type: string description: system generated key of unit of measure example: '24' maxLength: 8 href: type: string description: URL for the unit of measure. readOnly: true example: /objects/inventory-control/unit-of-measure/24 volume: type: number description: Volume of Item example: 0.789 maxLength: 13 densityUnitOfMeasure: type: string description: The density of the item unit of measure and density value. example: Cubic Meter density: type: number description: Density of Item example: 0.789 maxLength: 13 durometerUnitOfMeasure: type: string description: Durometer (hardness) measurement of the item. example: '10' maxLength: 10 diameterUnitOfMeasure: type: object description: >- The diameter of the item Unit of measure, and inner and outer diameter. You must specify all three or none. DIAMETERUOM must be set to one of the values defined for the length unit of measure. properties: id: type: string description: Id of unit of measure example: inches maxLength: 50 key: type: string description: system generated key of unit of measure example: '21' maxLength: 8 href: type: string description: URL for the unit of measure. readOnly: true example: /objects/inventory-control/unit-of-measure/21 innerDiameter: type: number description: Inner Diameter of Item example: 12 maxLength: 13 outerDiameter: type: number description: Outer Diameter of Item example: 13.5 maxLength: 13 commercial: type: object properties: brand: type: string description: Brand of the item. example: Touch Screen maxLength: 30 subBrand: type: string description: Sub brand of the item. example: Touch Screen with LED maxLength: 30 category: type: string description: Category of the item. example: Touch Screen with LED maxLength: 30 subCategory: type: string description: Sub category of the item. example: Touch Screen with LED maxLength: 30 catalogReference: type: string description: Catalog reference for the item. example: Touch Screen with LED laptops maxLength: 30 color: type: string description: Catalog reference for the item. example: black maxLength: 30 size1: type: string description: Size 1 of the item. example: '13' maxLength: 30 size2: type: string description: Size 2 of the item. example: '12' maxLength: 30 style: type: string description: Style of the item. example: '12' maxLength: 30 webName: type: string description: Name of the item to appear on the web. example: Dell Inspiration maxLength: 100 webShortDiscription: type: string description: Short description for the web. example: Dell Inspiration 13 inch LED maxLength: 1000 webLongDescription: type: string description: Long description for the web. example: Dell Inspiration 13 inch LED touchscreen maxLength: 2000 isGiftCard: type: boolean description: Use true if item is gift card. example: true default: false isWebEnabled: type: boolean description: Use true if item is web enabled. example: true default: false defaultConversionType: type: string description: Option to select default conversion type either Quantity or Price default: quantity example: quantity enum: - quantity - price purchasing: type: object properties: standardCost: type: string description: Standard cost value for the item. example: '1501.04' maxLength: 15 format: decimal-precision-10 sales: type: object properties: isTaxable: type: boolean description: Set to `true` if the sale of the item is taxable. default: false example: true basePrice: type: string description: Base price for the item. example: '1000' maxLength: 15 format: decimal-precision-10 isAvailableForDropShip: type: boolean description: Available for drop ship example: false default: false isAvailableForBuyToOrder: type: boolean description: Available for buy to order example: false default: false taxGroup: type: object description: The tax group to assign the item to. title: taxGroup properties: key: type: string description: System-assigned key for the tax group. example: '1000' id: type: string description: Unique identifier for the tax group. example: Acme Company Customers href: type: string description: URL for the tax group. readOnly: true example: /objects/tax/item-tax-group/23 taxSolution: type: object description: The tax solution to assign the item to. title: taxSolution properties: key: type: string description: System-assigned key for the tax solution. example: '1000' id: type: string description: Unique identifier for the tax solution. example: Acme Company Customers href: type: string description: URL for the tax solution. readOnly: true example: /objects/tax/tax-solution/23 allowMultipleTaxGroups: type: boolean description: > Allow multiple item tax groups per item, which is needed when an item is taxed at different rates in different tax jurisdictions. Allow multiple item tax groups. When you set this to true and provide an itemTaxMap, the tax group at the header level is ignored and the mapping is used instead. example: false default: false itemTaxMap: type: array items: $ref: '#/components/schemas/tax.item-tax-group-item-map' warehouseInfo: type: array items: $ref: '#/components/schemas/inventory-control-item-warehouse-inventory' itemVendor: type: array items: $ref: '#/components/schemas/inventory-control-item-vendor' isEnabledForContracts: type: boolean description: Set this to true if you want to enable the item for contracts. example: false default: false kitRevenuePosting: type: string enum: - null - componentLevel - kitLevel description: Kit revenue posting. example: componentLevel default: componentLevel nullable: true kitRevenuePrinting: type: string enum: - null - individualComponents - kit description: Kit revenue posting. example: individualComponents default: individualComponents nullable: true kitComponents: type: array items: $ref: '#/components/schemas/inventory-control-kit-component' contractTerm: type: object description: >- Contract Term section is enabled only if contracts is subscribed for item. properties: isStartDateAndEndDateEnabled: type: boolean example: false description: > Set this field to identify this item as having a default term. In Order Entry transactions, this also makes this item eligible for renewals and price proration. For Contracts, Set this to true if you want to set up automatic price proration for this item. default: false periodsMeasuredIn: type: string description: >- Provide the period of duration to use to measure the item's term. enum: - null - days - weeks - months - years example: days default: days nullable: true numberOfPeriods: type: integer description: >- Enter the default number of periods to include in the item's term. For example, if Periods measured in is Months and Number of periods is 6, then the item's default term is 6 months. Required if you set isStartDateAndEndDateEnabled to true. example: 2 maxLength: 4 isProratedPricingAllowed: type: boolean example: false description: > Set this field to true if you want the system to automatically prorate the price when the sales transaction line or contract line term is less than the item's default term. For Order Entry, this field prorates the fair value in a multiple-element arrangement (when also subscribed to Advanced Revenue Management). For Order Entry only, leave this checkbox cleared if you want the option to manually prorate the price using the prorate button in a sales transaction. default: false defaultRenewalTemplate: type: object description: >- Provide the default renewal instruction set for this item in sales transactions. Only displays if your company is subscribed to Revenue Recognition for Order Entry. This field is not applicable to the Contracts application. title: Default Renewal Template properties: key: type: string description: System-assigned key for the renewal template. example: '22' id: type: string description: Unique identifier for the renewal template. example: Sales Renewal Template US contractDefault: type: object description: > The fields in this section allow you to set default templates to use for this item when the item is selected in a contract line or as an expense. The user can override these defaults on the contract line or expense. For Non-Inventory (Purchase only) items, only the Expense template fields are applicable. This section is not applicable to Kit and Stockable kit items; properties: billingTemplate: type: object description: >- Provide billing template that would most often be associated with this item. title: Billing Template properties: key: type: string description: System-assigned key for the billing template example: '31' id: type: string description: Unique identifier for the billing template example: Monthly Billing revRecTemplate1: type: object description: >- Provide the default revenue template for the applicable journals. Your Contracts configuration may use one or two sets of revenue journals. title: Rev Rec Template 1 properties: key: type: string description: System-assigned key for the Rev Rec template example: '32' id: type: string description: Unique identifier for the Rev Rec template example: Monthly Billing href: type: string description: URL for the Rev Rec template readOnly: true example: /objects/contracts/revenue-template/32 revRecTemplate2: type: object description: >- Provide the default revenue template for the applicable journals. Your Contracts configuration may use one or two sets of revenue journals. Different from RevRecTemplate1 and RevRecTemplate2 is used for ASC606 standards. title: Rev Rec Template 2 properties: key: type: string description: System-assigned key for the Rev Rec template example: '33' id: type: string description: Unique identifier for the Rev Rec template example: Half Cycle href: type: string description: URL for the Rev Rec template readOnly: true example: /objects/contracts/revenue-template/33 expenseTemplate1: type: object description: >- Provide the default expense template for the applicable journals. Your Contracts configuration may use one or two expense journals. title: Rev Rec Template 2 properties: key: type: string description: System-assigned key for the contract expense template example: '33' id: type: string description: Unique identifier for the contract expense template example: Full Cycle Month Expense 2 href: type: string description: URL for the contract expense template readOnly: true example: /objects/contracts/expense-template/33 expenseTemplate2: type: object description: >- Provide the default expense template for the applicable journals. Your Contracts configuration may use one or two expense journals. Different from expenseTemplate1 and expenseTemplate2 is used for ASC606 standards. title: Rev Rec Template 2 properties: key: type: string description: System-assigned key for the contract expense template example: '34' id: type: string description: Unique identifier for the contract expense template example: Half Cycle Month Expense 2 href: type: string description: URL for the contract expense template readOnly: true example: /objects/contracts/expense-template/34 contractFairValueCategory: type: object description: > Sage Intacct uses fair value categories to distinguish products or services included in an MEA that will be used in the algorithm that determines another item's estimated standalone selling price. If the item can be sold as part of a multiple-element arrangement, Provide the category that identifies the performance obligation. Learn more about fair value categories in contracts. This field is only applicable if your company is subscribed to Contract Advanced Revenue Recognition. title: Contract Fair Value Category properties: key: type: string description: System-assigned key for Contract Fair Value Category example: '37' id: type: string description: Unique identifier for the Contract Fair Value Category example: Half Cycle Month Expense 2 defaultContractDeliveryStatus: type: string description: >- Options are Delivered the contract line's recognition event has occurred Undelivered the contract line's recognition event has not occurred default: delivered example: delivered enum: - null - delivered - undelivered nullable: true defaultContractDeferralStatus: type: string description: > Defer revenue until item is delivered the revenue schedule for this item will not start until this item has Delivery status = 'Delivered'. Defer revenue until all items are delivered the revenue schedule for this item will not start until all contract lines in the contract have Delivery status = 'Delivered'. default: deferRevenueUntilItemIsDelivered example: deferRevenueUntilItemIsDelivered enum: - null - deferRevenueUntilItemIsDelivered - deferRevenueUntilAllItemsAreDelivered nullable: true isDefaultBundle: type: boolean description: > Set this to true if item is to be included in the default bundle when an MEA allocation that includes this item is created. Users can choose to exclude the item when they create the MEA allocation. This field is only applicable if your company is subscribed to Contract Advanced Revenue Recognition. example: true default: false itemCrossReference: type: array items: $ref: '#/components/schemas/inventory-control-item-cross-reference' href: type: string description: Endpoint for the item. readOnly: true example: /objects/inventory-control/item/23 audit: $ref: '#/components/schemas/audit' inventory-control-item-gl-groupRequiredProperties: type: object required: - id example: id: Stockable Kit inventory-control-item-gl-group: type: object description: >- Item GL groups are used to organize transaction definitions for posting to the general ledger. properties: key: type: string description: System-assigned key for the item GL group. readOnly: true example: '13' id: type: string description: Name or other unique identifier for the item GL group. example: Stockable Kit deferredRevenueGLAccount: type: object description: >- GL account to which to defer revenue for items belonging to this GL group. properties: key: type: string description: System-assigned key for the deferred revenue GL account. example: '411' id: type: string description: Account number for the deferred revenue GL account. example: '1501.04' name: type: string description: Name of the deferred revenue GL account. example: Expense Account readOnly: true href: type: string description: URL for the deferred revenue GL account. example: /objects/general-ledger/account/411 readOnly: true defaultRevenueRecognitionTemplate: type: object description: >- Default revenue recognition template to use for deferred revenue for items belonging to this GL group. properties: key: type: string description: System-assigned key for the revenue recognition template. example: '1' id: type: string description: Unique identifier for the revenue recognition template. example: '100' href: type: string description: URL for the revenue recognition template. example: /objects/accounts-receivable/revenue-recognition-template/1 readOnly: true isSystemGenerated: type: boolean description: Indicates whether this is a system-generated GL group. example: false readOnly: true default: false href: type: string description: item gl group URL example: /objects/inventory-control/item-gl-group/13 readOnly: true audit: $ref: '#/components/schemas/audit' inventory-control-item-warehouse-inventoryRequiredProperties: type: object required: - item - warehouse example: item: key: '9' id: Prnt_Paper warehouse: key: '1' id: WH10001 inventory-control-rowRequiredProperties: type: object required: - id inventory-control-row: type: object description: >- A row is one of four optional attributes (zone, aisle, row, and bin face) you can assign to a bin to make it easier to find in the warehouse. properties: key: type: string description: System-assigned key for the row. example: '2' readOnly: true id: type: string description: >- Name or other unique identifier for the row. The row ID cannot be modified. example: R3ADW description: type: string description: Description for the row. example: Row 3A Dishwashers href: type: string description: URL for the row. readOnly: true example: /objects/inventory-control/row/2 audit: $ref: '#/components/schemas/audit' inventory-control-unit-of-measure-groupRequiredProperties: type: object required: - id - baseUnit inventory-control-unit-of-measure: type: object description: Unit of measure included in a unit of measure group. properties: key: type: string description: System-assigned key for this unit of measure. example: '59' readOnly: true id: type: string description: Unique identifier for this unit of measure. example: Hours nullable: false abbreviation: type: string description: Unique abbreviation for this unit of measure. example: HR numberOfDecimalPlaces: type: integer description: >- Allowed number of decimal places for this unit of measure. should be integer less than 4 maxLength: 1 example: 2 isBase: type: boolean description: >- Indicates whether this unit of measure is the base unit of measure for its group. example: false default: false readOnly: true parent: type: object description: Name of the unit of measure group that includes this unit. properties: key: type: string description: System-assigned key for the parent unit of measure group. readOnly: true example: '17' id: type: string description: Name of the parent unit of measure group. example: ComputerStorage href: type: string description: >- URL for the unit of measure group in which current unit of measure will be part of. readOnly: true example: /objects/inventory-control/unit-of-measure-group/17 conversionFactor: type: number description: Number of base units for this unit of measure. maxLength: 30 example: 2.5 href: type: string description: URL for this unit of measure. readOnly: true example: /objects/inventory-control/unit-of-measure/59 audit: $ref: '#/components/schemas/audit' inventory-control-unit-of-measure-group: type: object description: >- Unit of measure group, like Count,Area or Length, provided for items handled under Inventory Control, Order Entry, and Purchasing. properties: key: type: string description: >- System-assigned key for the unit of measure group. Used to identify the unit of measure group in URLs or JSON bodies for all operations on the group. example: '16' readOnly: true id: type: string description: Name of the unit of measure group. example: Time nullable: false baseUnit: type: string description: >- Base unit for the group. The base unit is the smallest reasonable unit for pricing within the unit of measure group. example: Seconds nullable: false abbreviation: type: string description: Abbreviation for the base unit. example: SEC defaults: type: object description: > Default unit of measure for Inventory, Order Entry, and Purchasing transactions. This is the default unit within a unit of measure group for transactions that contain items associated with the group. For example, Count is a standard unit of measure group with Each, Pair, and Dozen defined as related units. The Each unit can be set to be the default unit for inventory transactions. For more information, see [Unit of measure groups](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/UOM_groups/UOM-groups-OE.htm). properties: inventory: type: object description: Default unit of measure for Inventory transactions. properties: key: type: string description: >- System-assigned key for the default unit of measure for Inventory transactions. example: '3' id: type: string description: >- Id for the default unit of measure for Inventory transactions. example: Each href: type: string description: >- URL for the default unit of measure for Inventory transactions. readOnly: true example: /objects/inventory-control/unit-of-measure/3 purchaseOrder: type: object description: Default unit of measure for Purchasing transactions. properties: key: type: string description: >- System-assigned key for the default unit of measure for Purchasing transactions. example: '3' id: type: string description: >- Id for the default unit of measure for Purchasing transactions. example: Each href: type: string description: >- URL for the default unit of measure for Purchasing transactions. readOnly: true example: /objects/inventory-control/unit-of-measure/3 orderEntry: type: object description: Default unit of measure for Order Entry (Sales) transactions. properties: key: type: string description: >- System-assigned key for the default unit of measure for Order Entry (Sales) transactions. example: '3' id: type: string description: >- Id for the default unit of measure for Order Entry (Sales) transactions. example: Each href: type: string description: >- URL for the default unit of measure for Order Entry (Sales) transactions. readOnly: true example: /objects/inventory-control/unit-of-measure/3 unitsOfMeasure: type: array description: Related units of measure included in the group. items: $ref: '#/components/schemas/inventory-control-unit-of-measure' href: type: string description: Unit of measure group URL. readOnly: true example: /objects/inventory-control/unit-of-measure-group/41 audit: $ref: '#/components/schemas/audit' inventory-control-unit-of-measureRequiredProperties: type: object required: - id - parent - conversionFactor inventory-control-warehouseRequiredProperties: type: object required: - id - name - location inventory-control-warehouse: type: object description: > A warehouse can be an actual warehouse, a store, or any type of stocking location or site that requires inventory tracking and management. Warehouse also serves as a dimension that can be set on transactions to expand report functionality and insight. properties: key: type: string description: System-assigned key for the warehouse. example: '2' readOnly: true id: type: string description: Unique identifier for the warehouse. example: USNA1 name: type: string description: Name of the warehouse. example: US NA Warehouse-1 href: type: string description: URL for the warehouse. example: /objects/inventory-control/warehouse/2 readOnly: true status: $ref: '#/components/schemas/status' isReplenishmentEnabled: type: boolean description: >- This property is set to `true` by default if Inventory Control is configured for replenishment. If the warehouse should not be replenished, set to `false`. example: true default: true enableNegativeInv: type: boolean description: >- Set to `true` to save transactions that cause the inventory for items in this warehouse to be negative. example: true default: false location: type: object description: The geographical location of the warehouse. properties: id: type: string example: PHO--Phoenix key: type: string description: System-assigned key for the location. example: '2' href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/2 parent: type: object description: >- If this warehouse is part of a hierarchy, the parent warehouse of this warehouse. properties: id: type: string description: Unique identifier for the parent warehouse. example: WH10001--US AZ Warehouse 10001 key: type: string description: System-assigned key for the parent warehouse. example: '32' href: type: string description: URL for the parent warehouse. readOnly: true example: /objects/inventory-control/warehouse/32 manager: type: object description: Employee who is responsible for the warehouse. properties: id: type: string description: Unique identifier of the employee who is the warehouse manager. example: EM 1--Aman key: type: string description: System-assigned key for the warehouse manager. example: '23' href: type: string description: URL for the warehouse manager. readOnly: true example: /objects/company-config/employee/23 contacts: type: object description: | The contact for the warehouse. properties: primary: type: object title: primary properties: id: type: string description: Name for the warehouse contact. example: Sam Smith key: type: string description: System-assigned key for the warehouse contact. example: '210' href: type: string description: URL for the warehouse contact. readOnly: true example: /objects/company-config/contact/210 shipTo: type: object description: Ship to contact for the warehouse. title: shipTo properties: id: type: string description: Name for the Ship to contact. example: Bill North key: type: string description: System-assigned key for the Ship to contact. example: '223' href: type: string description: URL for the Ship to contact. readOnly: true example: /objects/company-config/contact/223 audit: $ref: '#/components/schemas/audit' inventory-control-zoneRequiredProperties: type: object required: - id inventory-control-zone: type: object description: >- A zone is one of four optional attributes (zone, aisle, row, and bin face) you can assign to a bin to make it easier to find in the warehouse. properties: key: type: string description: System-assigned key for the zone. readOnly: true example: '12' id: type: string description: >- Unique identifier or name for the zone. The zone ID cannot be modified. example: Z4REF description: type: string description: Description for the zone. example: Refrigeration Zone Four href: type: string description: URL for the zone. readOnly: true example: /objects/inventory-control/zone/12 audit: $ref: '#/components/schemas/audit' inventory-control-product-lineRequiredProperties: type: object required: - id inventory-control-product-line: type: object description: >- Product lines are groups of related products. Using product lines makes it easier to update prices and track inventory movement. properties: key: type: string description: System-assigned key for the product line. readOnly: true example: '25' id: type: string description: Name or other unique identifier for the product line. example: Telephones description: type: string description: Description of the product line. example: Product line for all phones parent: type: object description: >- If this product line is part of a hierarchy, the parent product line of this product line. properties: key: type: string description: System-assigned key for the parent product line. example: '28' id: type: string description: Unique identifier for the parent product line. example: Electronics href: type: string readOnly: true example: /objects/inventory-control/product-line/28 href: type: string description: product line URL example: /objects/inventory-control/product-line/25 readOnly: true status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' inventory-control-item-cross-referenceRequiredProperties: type: object required: - referenceType - item example: item: key: '649' referenceType: substitute inventory-control-item-landed-costRequiredProperties: type: object required: - distributionMethod - item - landedCostValue inventory-control-item-warehouse-standard-costRequiredProperties: type: object required: - effectiveStartDate - standardCost properties: itemWarehouse: required: - key example: itemWarehouse: key: '649' inventory-control-item-warehouse-vendorRequiredProperties: type: object required: - vendor properties: itemWarehouse: required: - key example: itemWarehouse: key: '649' inventory-control-kit-componentRequiredProperties: type: object required: - kit - component - numberOfUnits inventory-control-lot-categoryRequiredProperties: type: object required: - id - name inventory-control-lot-category: type: object description: >- Lot categories let you group a specific set of items that have something in common. properties: key: type: string description: System generated lot-category key example: '2' readOnly: true id: type: string description: The unique identifier assigned to this lot category nullable: false example: Medi-Lot maxLength: 30 name: type: string description: A meaningful descriptive name of lot category. nullable: false example: Medical Item Lot maxLength: 50 href: type: string description: Lot Category URL readOnly: true example: /objects/inventory-control/lot-category/2 inventory-control-price-listRequiredProperties: type: object required: - id - appliesTo example: id: Base Price List appliesTo: orderEntry inventory-control-price-list: type: object description: An inventory price list is a container for price list entries. properties: key: type: string description: System-assigned key for the inventory price list. readOnly: true example: '1' id: type: string description: Name or other unique identifier for the inventory price list. nullable: false example: Base Price List href: type: string description: URL for the inventory price list. readOnly: true example: /objects/inventory-control/price-list/1 startDate: type: string format: date description: >- Start date of the time period during which the price list will be effective. example: '2000-01-01' endDate: type: string format: date description: >- End date of the time period during which the price list will be effective. example: '2100-12-31' appliesTo: type: string description: >- Indicates the application that this price list applies to, which can be Purchasing or Order Entry. nullable: false enum: - purchasing - orderEntry example: orderEntry status: $ref: '#/components/schemas/status' inventory-control-price-scheduleRequiredProperties: type: object required: - id inventory-control-price-schedule: type: object description: >- Inventory price schedules are pricing groups that can be associated with price lists. properties: key: type: string description: System-assigned key for the inventory price schedule. readOnly: true id: type: string description: Name or other unique identifier for the inventory price schedule. href: type: string description: URL for the inventory price schedule. readOnly: true description: type: string description: Meaningful description of the inventory price schedule. priceList: type: object description: Price list associated with the inventory price schedule. properties: key: type: string description: System-assigned key for the inventory price list. id: type: string description: Name or other unique identifier for the inventory price list. href: type: string description: URL for the inventory price list. readOnly: true discountPercent: type: string description: Discount that will apply to assigned customers. status: $ref: '#/components/schemas/status' inventory-control-totalRequiredProperties: type: object required: - id inventory-control-total: type: object description: >- Use inventory totals to keep track of the items on hand that are available for sale. Sage Intacct is preconfigured with nine inventory totals for tracking inventory that's damaged, in transit, on hand, on hold, on order, requisitioned, or scrap and spoilage. You can also create your own inventory totals as needed. properties: key: type: string description: System-assigned key for the inventory total. readOnly: true example: '23' maxLength: 8 id: type: string description: ID of inventory total. This should be a unique value. example: SHIPPED maxLength: 30 href: type: string description: Endpoint for the inventory total. readOnly: true example: /objects/inventory-control/total/23 updateType: type: string description: >- Inventory total type, which is assigned when the total is created. All custom totals that are created are accumulative type. example: accumulative readOnly: true enum: - accumulative - perPeriod - continuous status: $ref: '#/components/schemas/status' inventory-control-txn-definitionRequiredProperties: type: object required: - id - templateType - workflowCategory - status inventory-control-txn-definition-total-detail: type: object description: >- Specify the inventory running total that will be affected by the transaction, whether to track the quantity, value, or both, and whether that amount will increase or decrease when the user saves the transaction. properties: key: type: string description: System-assigned key for the inventory transaction definition total. readOnly: true example: '23' maxLength: 8 id: type: string description: System-assigned id for the inventory transaction definition total. readOnly: true example: '23' maxLength: 8 href: type: string description: Endpoint for the inventory transaction definition total. readOnly: true example: /objects/inventory-control/txn-definition-total-detail/23 maintainType: type: string description: >- Specify the inventory running total that will be affected by the transaction, whether to track the quantity, value, or both. enum: - quantity - value - quantityAndValue example: value operation: type: string description: >- Specify if amount will increase or decrease when user saves the transaction. enum: - add - subtract example: add inventoryTotal: type: object description: Specify the inventory total properties: key: type: string description: System-assigned key for the inventory-total. example: '23' id: type: string description: Inventory total. example: ONHAND href: type: string description: Endpoint for the invtotal. readOnly: true example: /objects/inventory-control/total/23 inventoryTxnDefinition: type: object description: Inventory transaction definition properties: key: type: string description: System-assigned key for the inventory transaction definition. example: '23' id: type: string description: Document ID for the inventory transaction definition. example: Adjustment Decrease href: type: string description: URL for the inventory transaction definition. readOnly: true example: /objects/inventory-control/txn-definition/23 inventory-control-txn-definition-subtotal-detail: type: object description: >- Subtotal detail for Inventory transaction definition will hold the type of subtotal that are supported by each Transaction definition. properties: key: type: string description: >- System-assigned key for the inventory transaction definition subtotal detail. readOnly: true example: '23' maxLength: 8 id: type: string description: >- System-assigned ID for the inventory transaction definition subtotal detail. readOnly: true example: '23' maxLength: 8 href: type: string description: Endpoint for the inventory transaction definition subtotal detail. readOnly: true example: /objects/inventory-control/txn-definition-subtotal-detail/23 inventoryTxnDefinition: type: object description: >- Inventory transaction definition associated with Inventory transaction definition subtotal detail. And its required information to create inventory transaction definition Subtotal detail. properties: key: type: string description: System-assigned key for the inventory transaction definition. example: '23' maxLength: 8 id: type: string description: System-assigned ID for the inventory transaction definition. example: Adjustment Decrease maxLength: 30 href: type: string description: URL for the inventory transaction definition. readOnly: true example: /objects/inventory-control/txn-definition/23 lineNumber: type: integer description: >- Line number of subtotal on Inventory transaction definition . If not provided, the system automatically assigns a unique line number. If the user specifies the lineNumber already used, the application will push set other lines to unique numbers. The transaction definition will use the line numbers to display the order of subtotals. example: 1 maxLength: 8 description: type: string description: >- Provide a text description of the subtotal. A unique description is required to create an inventory transaction definition subtotal detail object. example: Discount maxLength: 100 subtotalType: type: string description: >- Provide subtotalType Options are Discount or Charge. And its required information to create inventory transaction definition Subtotal detail. enum: - discount - charge example: discount appliedToLineNumber: type: integer description: >- Specify the subtotal line number to which the subtotal will apply. Sage Intacct treats the initial subtotal line as line number 0. The first defined subtotal from the transaction definition is line number 1, the second defined subtotal is line number 2, and so on. The value of Applied to line is implicitly assumed to be 0. Taxes, all other charges, and discounts are computed at the line level. This fields does not apply if is set to line-level Simple Tax. example: 1 maxLength: 8 valueType: type: string description: >- Value type options are Amount or Percent. And its required information to create inventory transaction definition Subtotal detail enum: - amount - percent example: amount subtotalValue: type: string description: >- Provide a default value for the subtotal. If Value type is Amount, enter the amount of the subtotal. For example, enter 250. If Value type is Percent, enter a percentage as a whole number. For example, enter 10 for 10%. Users can override the default subtotal value in the transaction. example: '10.23' maxLength: 12 txnType: type: string description: >- Indicate whether the subtotal will debit or credit the corresponding GL account and GL offset account. enum: - '' - debit - credit example: credit glAccount: type: object description: Set the GL account to which the subtotal will post. properties: href: type: string description: Endpoint for the glaccount. readOnly: true example: /objects/general-ledger/account/10 id: type: string example: '7501' description: Id of GL Account maxLength: 96 key: type: string example: '10' description: System generated GL Account Key maxLength: 8 offsetGlAccount: type: object description: >- Offset GL account to which the subtotal will post. This field is only applicable if you are using advanced workflows. properties: href: type: string description: Endpoint for the offsetglaccount. readOnly: true example: /objects/general-ledger/account/22 id: type: string description: Id of GL Account example: '4001.04' maxLength: 96 key: type: string description: System generated GL Account Key example: '22' maxLength: 8 isTax: type: boolean description: >- Set isTax to true to create subtotal as a tax. When the transaction posts, the tax will post separately based on the items in the transaction. Set isTax to true for tax subtotal lines if your organization uses Simple Tax, Advanced Tax, or Avalara AvaTax. example: false default: false enableAvaTax: type: boolean description: >- Set isAvaTax field to true if the subtotal line item applies to AvaTax and company is subscribed to Avalara AvaTax integration. example: false default: false dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: department: title: department type: object description: >- Optional. Provide a default department for the subtotal. This setting does not apply at the top level. properties: href: type: string description: Endpoint for the dept. readOnly: true example: /objects/company-config/department/13 id: type: string description: ID of department. example: '13' maxLength: 20 key: type: string description: System generated key of department. example: '8' maxLength: 8 name: type: string description: Name of department. readOnly: true example: Finance maxLength: 40 location: type: object description: >- Optional. Provide a default location for the subtotal. This setting does not apply at the top level. properties: href: type: string description: Endpoint for the location. readOnly: true example: /objects/company-config/location/12 id: type: string description: Id for the location. example: CA maxLength: 20 key: type: string description: System generated location key. example: '12' maxLength: 8 name: type: string readOnly: true description: Name of the location. example: California maxLength: 40 inventory-control-txn-definition-source: type: object description: Document conversion detail for an Inventory transaction properties: key: type: string description: >- System-assigned key for the inventory transaction definition source document. readOnly: true example: '23' id: type: string description: >- System-assigned id for the inventory transaction definition source document. readOnly: true example: '23' href: type: string description: Endpoint for the inventory transaction definition source document. readOnly: true example: /objects/inventory-control/txn-definition-source/23 inventoryTxnDefinition: type: object description: Inventory transaction definition properties: key: type: string description: System-assigned key for the inventory transaction definition. example: '23' id: type: string description: System-assigned ID for the inventory transaction definition. example: Adjustment Decrease href: type: string description: URL for the inventory transaction definition. readOnly: true example: /objects/inventory-control/txn-definition/23 convertedFrom: type: object description: Can be converted from inventory transaction definition properties: key: type: string description: System-assigned key for the inventory transaction definition. example: '23' id: type: string description: System-assigned ID for the inventory transaction definition. example: Adjustment Increase href: type: string description: URL for the inventory transaction definition. readOnly: true example: /objects/inventory-control/txn-definition/23 inventory-control-txn-definition-cogs-gl-detail: type: object description: >- This object holds the inventory account mapping for inventory transaction definitions that are configured to post cost of goods (COGS) adjustments to the General Ledger. For example, if a transaction definition is for a cost of goods (COG) adjustment that accounts for spoilage, you might debit the spoilage account and credit the Inventory account. properties: key: type: string description: System-assigned key for the inventory-txn-definition-cogs-gl-detail. readOnly: true example: '23' maxLength: 8 id: type: string description: Inventory transaction definition GL mapping ID. readOnly: true example: '23' maxLength: 8 href: type: string description: Endpoint for the inventory-txn-definition-cogs-gl-detail. readOnly: true example: /objects/inventory-control/txn-definition-cogs-gl-detail/23 txnType: type: string description: Indicate whether debit or credit the corresponding GL account. enum: - debit - credit example: debit moduleType: type: string description: >- Readonly Module type will be always inventory since COGS account will be linked to Inventory Transaction Definition. readOnly: true example: inventory enum: - subledger - inventory lineNumber: type: integer description: >- Line number of cogs-gl detail on Inventory transaction definition . If not provided, the system automatically assigns a unique line number. If the user specifies the lineNumber already used, the application will push set other lines to unique numbers. Once user posts the information system will use the line numbers to post the GL in the order provided. example: 1 maxLength: 8 glAccount: type: object description: >- Set the GL account to which this transaction posts for the specified account mapping (itemGLGroup and warehouse). properties: key: type: string description: System-assigned key for the account. example: '384' maxLength: 8 id: type: string description: User-assigned number for the account. example: '1501.04' maxLength: 96 href: type: string readOnly: true description: Endpoint for the gl-account. example: /objects/general-ledger/account/384 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Set the default location against which the line item will be recorded. The location is only applicable if user override for location has not been enabled. This setting is not applicable at the top level. properties: key: type: string description: >- System-assigned unique key for the location. Used to identify the location in URLs or JSON bodies for all operations on the location. example: '22' maxLength: 8 id: type: string description: ID of location. example: CA maxLength: 20 name: type: string description: Name of the location. readOnly: true example: California maxLength: 40 href: type: string description: Endpoint for the location. readOnly: true example: /objects/company-config/location/22 department: type: object description: >- Set the default department against which the line item will be recorded. The deparment is only applicable if user override for department has not been enabled. This setting is not applicable at the top level. properties: key: type: string description: System generated key of department. example: '28' maxLength: 8 id: type: string description: ID of department. example: Finance maxLength: 20 name: type: string description: Name of department. readOnly: true example: Finance maxLength: 40 href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/28 warehouse: type: object description: >- The Item GL group and Warehouse together form the criteria set for the account mapping. For example, you could have the Maintenance item GL group, Warehouse 13, and Hardware Customer GL group mapped to a COGS account and Inventory account, and the Maintenance item GL group, Warehouse 13, and Software Customer GL group mapped to a different COGS account and Inventory account. properties: key: type: string description: System genrated Key of selected warehouse. example: '21' maxLength: 8 id: type: string description: ID of selected warehouse. example: ARZ maxLength: 40 href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/21 itemGLGroup: type: object description: >- The Item GL group and Warehouse together form the criteria set for the account mapping. For example, you could have the Maintenance item GL group, Warehouse 13, and Hardware Customer GL group mapped to a COGS account and Inventory account, and the Maintenance item GL group, Warehouse 13, and Software Customer GL group mapped to a different COGS account and Inventory account. properties: key: type: string description: System-assigned key for the item GL group. example: '13' maxLength: 8 id: type: string description: Name of the item GL group. example: Inventory- Computers and parts maxLength: 80 href: type: string description: Endpoint for the itemglgroup. readOnly: true example: /objects/inventory-control/item-gl-group/13 inventoryTxnDefinition: type: object description: Inventory Transaction Definition related to COGS Gl Account mapping. properties: key: type: string description: System-assigned key for the inventory transaction definition. example: '12' maxLength: 8 id: type: string description: ID for the inventory transaction definition. example: Inventory Shipper maxLength: 30 href: type: string description: URL for the inventory transaction definition. readOnly: true example: /objects/inventory-control/txn-definition/23 inventory-control-txn-definition-entity-detail: type: object description: >- This object contains details about which entities can create transactions and also includes settings for each entity, such as numbering sequences and document templates. These details and settings are applicable to transaction definitions that are configured to create transactions at the "Top level or entity" or "Entity only" level. properties: key: type: string description: >- System-assigned key for the inventory transaction definition entity detail. readOnly: true example: '23' maxLength: 8 id: type: string description: Document parameters entity property ID. readOnly: true example: '23' maxLength: 8 href: type: string description: Endpoint for the inventory transaction definition entity detail. readOnly: true example: /objects/inventory-control/txn-definition-entity-detail/23 txnNumbering: type: object properties: preserveSequenceNumbering: type: boolean description: >- If true then preserve sequence numbering. Ensures that numbers are never skipped. Enabling this option can affect performance when a large volume of transactions is entered at the same time. This field is not required if you do not specify a sequenceNumber. example: false default: false inheritSourceDocumentNumber: type: boolean description: >- Inherit source document number. For example, if you convert transfer out TO-001 into a transfer in, the number for the transfer in will be TO-001 if the transfer in is set to inherit the source transaction number. example: false default: false sequenceNumber: type: object description: >- Select the numbering sequence to use to automatically number transactions for the corresponding entity. properties: key: type: string description: Document sequence Key example: '13' maxLength: 8 href: type: string description: Endpoint for the seqnum. example: /objects/company-config/document-sequence/13 id: type: string description: The ID of the numbering sequence. example: Adjustment Decrease maxLength: 20 documentTemplate: type: object description: >- Provide printed document template to use as the default for printed output (PDFs) for the corresponding entity. Inventory transaction definition document template is used if you not provide this field. properties: key: type: string description: The system generated key document template. example: '65' maxLength: 8 id: type: string description: The name of document template. example: Intacct Inventory transfer sample maxLength: 100 entity: type: object description: The entity to associate with the transaction definition. properties: href: type: string description: Endpoint for the entityloc. readOnly: true example: /objects/company-config/entity/1 key: type: string description: >- System-assigned unique key for the entity. Used to identify the entity in URLs or JSON bodies for all operations involving the entity. example: '1' maxLength: 8 id: type: string description: >- Unique identifier of the entity. 20 characters max. The ID cannot be changed after the entity has been created. example: 1-us maxLength: 20 inventoryTxnDefinition: type: object description: >- Header Inventory transaction definition level details and its required to create new entity settings. properties: key: type: string description: >- System-assigned key for the inventory transaction definition entity detail. example: '233' maxLength: 8 id: type: string description: >- System-assigned ID for the inventory transaction definition entity detail. example: Adjustment Decrease maxLength: 20 href: type: string description: URL for the inventory transaction definition. readOnly: true example: /objects/inventory-control/txn-definition/233 inventory-control-txn-definition: type: object description: >- An inventory transaction definition includes the accounting rules, workflow settings, security settings, and other characteristics for a transaction. properties: key: type: string description: System-assigned key for the inventory transaction definition. readOnly: true example: '23' maxLength: 8 id: type: string description: >- Unique name for Inventory transaction definition. Required on create and cannot be modifed. example: Adjustment Decrease maxLength: 30 href: type: string description: URL for the inventory-txn-definition. readOnly: true example: /objects/inventory-control/txn-definition/23 templateType: type: string description: >- Template type Determines whether certain fields appear on the transaction (for example, Expiration date versus Ship Date). Other areas in Intacct where you use the Template type include - 1) You associate document templates (used for printed output) to transactions by Template type. Learn more about document templates in help section. 2) In Salesforce integrations, the integration groups the related list of Intacct objects by transaction definition Template type. 3) In Avalara AvaTax integrations, the integration uses the transaction definition Template type to determine if a transaction is positive or negative. example: adjustment enum: - quote - order - list - invoice - adjustment - other default: quote description: type: string description: >- A meaningful description of the transaction definition. The description appears in the transaction definition list. example: Adjustment Decrease (Quantity Only) maxLength: 100 workflowCategory: type: string description: >- Workflow category associates the transaction with the appropriate icon on the Overview page and with the applicable transaction menu grouping in the Inventory Control menu. example: receipt enum: - receipt - transfer - adjustment - shipping default: adjustment 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: inventoryAdjustment default: null enum: - null - inventoryAdjustment - buildKits - disassembleKits - inventoryDamagedGoods - inventoryReceipt - inventoryScrapOrSpoilage - inventoryShipper - warehouseTransfer nullable: true status: $ref: '#/components/schemas/status' txnNumbering: type: object properties: numberingSequence: type: object description: >- Use numbering sequence to automatically number transactions. Leave this field blank to number transactions manually. properties: key: type: string description: Numbering sequence key. example: '23' maxLength: 8 id: type: string description: Numbering sequence ID. example: Adjustment Decrease maxLength: 20 href: type: string description: URL for the document sequence number. readOnly: true example: /objects/company-config/document-sequence/23 preserveSequenceNumbers: type: boolean description: >- Ensures that numbers 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 inheritSourceDocumentNumber: type: boolean description: >- For example, if you convert transfer out TO-001 into a transfer in, the number for the transfer in will be TO-001 if the transfer in is set to inherit the source transaction number. example: false default: false inventoryControl: type: object description: Provide values to only if company subscribes to Inventory Control. properties: enableWarnOnLowQty: type: boolean description: >- Warn user if item on hand quantity falls below 0. Alerts the user if the quantity needed is greater than the ONHAND total in the selected warehouse. The warning also shows the ONORDER and ONHOLD totals. The warning appears when the user tabs out of the Quantity field in the transaction. example: true default: true updatesInventory: type: string description: >- System will assing depending on Inventory Totals provided in transaction definition. If Inventory Total is affecting both qunatity and value then value will be quantityAndValue. example: value readOnly: true enum: - 'no' - quantity - value - quantityAndValue default: 'no' updatesCost: type: boolean description: >- System will assing depending on Inventory Totals provided in transaction definition. System will set this to true if this transaction will update costing. example: false readOnly: true default: false increaseOrDecreaseInventory: type: string description: >- Increases or decreases inventory. System will auto assign depending on Inventory totals selected and if its adding quantity/value or decrease the quantity/value. readOnly: true example: increase enum: - increase - decrease default: increase warehouseSelectionMethod: type: string description: >- Determines how warehouses are presented to the user in the warehouse dropdown list in the transaction. example: sortByID enum: - sortByID - sortByName - warehouseWithAvailableInventory - useTheDefaultWarehouse default: sortByID defaultWarehouse: type: object description: >- Set this only when the Warehouse selection method is Use the default warehouse. A user's Default warehouse setting in their user preferences overrides this selection. properties: key: type: string description: Default warehouse key. example: '20' maxLength: 8 id: type: string description: Default warehouse id. example: Warehouse-001 maxLength: 20 href: type: string description: URL for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/20 accounting: type: object properties: txnPosting: type: string description: >- Specify whether the transaction post process creates a GL entry if so the transaction posts directly to the General Ledger. If you set to do not post the transaction post process will not create a GL entry. If you set to post to General Ledger, at least one debit and credit inventory account mapping should be selected. example: postToGeneralLedger enum: - postToGeneralLedger - doNotPost default: postToGeneralLedger isSubTotalsEnabled: type: boolean description: >- Enable subtotals allows users to specify standard subtotals, such as tax or a discount, for this transaction. When you set this field to true, you must add at least one subtotal detail. example: false default: false conversionType: type: string description: >- Indicates how the system processes transactions that are partially completed. Leave transaction open will converts the transaction to another transaction type, the system leaves the original transaction open until the all items are completed. Close transaction will converts this transaction to another transaction type, the system closes this transaction regardless of whether the transaction is complete. example: closeTxn enum: - leaveTxnOpen - closeTxn default: closeTxn pricingAndTerms: type: object description: Pricing and terms properties: initialPriceList: type: object description: >- Set the initial price list if desired. If you are using layered price lists, this indicates the first price list the system will evaluate when determining a suggested transaction price. properties: key: type: string description: Initial price list key. example: '12' maxLength: 8 id: type: string description: Initial price list. example: Base Price List maxLength: 40 href: type: string description: URL for the initial price list. readOnly: true example: /objects/inventory-control/price-list/12 specialPriceList: type: object description: >- If you are 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: key: type: string description: Special price list key. example: '13' maxLength: 8 id: type: string description: Special price list. example: Discount Price List maxLength: 40 href: type: string description: URL for the special price list. readOnly: true example: /objects/inventory-control/price-list/13 print: type: object description: Print properties: documentTemplate: type: string description: >- Provide printed document template to use for printed output (PDFs). example: Adjustment_US_Template maxLength: 50 defaultText: type: string description: >- If you do not set print Document template, enter any text that you want to appear on every document printed from this transaction. example: Document template is not selected. maxLength: 4000 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: false default: false userOverrides: type: object description: User Overrides properties: allowDepartmentOverride: type: boolean description: >- Set to true to allow users to override the department set for the transaction. 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 documentPermissions: type: object description: Document permissions properties: editPolicy: type: string description: >- Sets the edit permission for this transaction type. If No edit is selected user cannot edit this transaction after it is created. If Before Printing is selected user can edit this transaction until it has been printed to PDF. After it has been printed, the transaction cannot be edited. If Edit in Draft Only is selected user The user can edit this transaction until it has been posted. After it has been posted, the transaction cannot be edited. If All is selected user can edit this transaction as allowed by the transaction's condition example: all enum: - noEdit - beforePrinting - editInDraftOnly - all default: all deletePolicy: type: string description: >- Sets the delete permission for this transaction type. If No delete is selected user cannot delete this transaction after it is created. If Before Printing is selected the user can delete this transaction until it has been printed to PDF. After it has been printed, the transaction cannot be deleted. If All is selected the user can delete this transaction as allowed by the transaction’s condition. example: all enum: - noDelete - beforePrinting - deleteInDraftOnly - all default: all createPolicy: type: string description: >- Sets the create permissions for this transaction type. If New document or Convert is selected the user can create this transaction as a standalone transaction or the user can create this transaction by converting the previous transaction in the workflow. If Convert only is selected the user can can only create this document by converting the previous transaction in the workflow. example: newDocumentOrConvert enum: - newDocumentOrConvert - convertOnly default: newDocumentOrConvert multiEntityRuleForTxn: type: string description: >- Sets the context for where users can create transactions from this transaction definition within a multi-entity, shared environment. example: topLevelOrEntity enum: - topLevelOrEntity - topLevelOnly - entityOnly default: topLevelOrEntity inventoryTotalDetail: type: array description: Related inventory transaction definition totals. items: $ref: '#/components/schemas/inventory-control-txn-definition-total-detail' subtotalDetail: type: array description: Related inventory transaction subtotals items: $ref: '#/components/schemas/inventory-control-txn-definition-subtotal-detail' sourceDocumentDetail: type: array description: Related inventory transaction definition converted. items: $ref: '#/components/schemas/inventory-control-txn-definition-source' inventoryAccountMapping: type: array description: >- Related inventory transaction definition GL account mappings by item GL group. If transaction posting is General Ledger, enter applicable inventory account mapping here. For example, if the transaction definition is for an adjustment that accounts for spoilage, you might debit the spoilage account and credit the Inventory account. items: $ref: '#/components/schemas/inventory-control-txn-definition-cogs-gl-detail' entitySettingDetail: type: array description: Related inventory transaction definition Entity detail items: $ref: '#/components/schemas/inventory-control-txn-definition-entity-detail' audit: $ref: '#/components/schemas/audit' inventory-control-txn-definition-sourceRequiredProperties: type: object required: - inventoryTxnDefinition - convertedFrom example: inventoryTxnDefinition: key: '173' convertedFrom: key: '172' inventory-control-txn-definition-cogs-gl-detailRequiredProperties: type: object required: - inventoryTxnDefinition - txnType - glAccount inventory-control-txn-definition-entity-detailRequiredProperties: type: object required: - inventoryTxnDefinition - entity inventory-control-txn-definition-subtotal-detailRequiredProperties: type: object required: - inventoryTxnDefinition - subtotalType - valueType - description inventory-control-txn-definition-total-detailRequiredProperties: type: object required: - maintainType - operation - inventoryTxnDefinition - inventoryTotal example: inventoryTxnDefinition: key: '172' inventoryTotal: key: '51' maintainType: quantity operation: subtract inventory-control-warehouse-groupRequiredProperties: type: object required: - id - name - groupType inventory-control-warehouse-group-member: type: object description: Member warehouses of the warehouse group properties: key: type: string description: System-assigned key for the warehouse-group member. readOnly: true example: '10' id: type: string description: Unique identifier for the warehouse group member. readOnly: true example: '10' href: type: string description: Warehouse group member URL. readOnly: true example: /objects/inventory-control/warehouse-group-member/10 warehouseGroup: type: object description: Warehouse group that this warehouse is a member of. properties: key: type: string description: System-assigned key for the warehouse group. example: '4' id: type: string description: Unique identifier for the warehouse group. example: EastCoastWarehouses href: type: string description: URL for the warehouse group. readOnly: true example: /objects/inventory-control/warehouse-group/4 warehouse: type: object description: Member warehouse of the warehousegroup. properties: key: type: string description: Key of the associated warehouse object. example: '9' id: type: string description: ID of the associated warehouse object. example: MCOM name: type: string description: Name of the associated warehouse object. readOnly: true example: Mobile Components href: type: string description: URL of the associated warehouse object. readOnly: true example: /objects/inventory-control/warehouse/9 status: title: status type: string description: Warehouse status enum: - active - inactive example: active sortOrder: type: integer description: >- Sort Order of the warehouse within the warehouse group startting from 0. example: 1 audit: $ref: '#/components/schemas/audit' inventory-control-warehouse-group: type: object description: >- A warehouse group categorizes warehouse dimension records, mainly for the purpose of structuring financial reporting. properties: key: type: string description: System-assigned key for the warehouse group. readOnly: true example: '4' id: type: string description: Unique identifier for the warehouse group. example: EastCoastWarehouses href: type: string description: Warehouse group URL. readOnly: true example: /objects/inventory-control/warehouse-group/4 name: type: string description: Name of the warehouse group. example: EastCoast Warehouses description: type: string description: Description of the warehouse group. example: Warehouses on the east coast groupType: type: string description: >- Group membership type. The group type and related fields that you set determine which warehouses are added to the group. * `all` - All items that match the `memberFilter` criteria. If ‘all’ is selected, 'memberFilter' is required. * `specific` - Specify the items to include and their order in the `groupMembers` array. If ‘specific’ is selected, 'groupMembers' is required. example: all enum: - all - specific sortField: type: string description: >- Warehouse field to sort on. Only applicable when `groupType` = `all`. example: warehouseId default: warehouseId enum: - createdAtEntityId - location - managerId - parentWarehouse - status - warehouseId sortOrder: type: string description: >- Sort order for warehouse that match the `memberFilter`. Only applicable when `groupType` = `all`. example: ascending enum: - ascending - descending default: ascending maxMatches: type: integer description: >- The maximum number of warehouses that match the memberFilter to include in the warehouse group. Only applicable when `groupType` = `all`. example: 100 createDimensionComponents: type: boolean description: >- Set to 'true' to create a dimension structure that enables the group to be used on the rows and columns of financial reports. If this field is set to false, the group can only be used for filtering. default: false example: true glAccountGroup: type: object description: >- General ledger (GL) account group associated with the warehouse group. properties: key: type: string readOnly: true example: '23' id: type: string description: ID for the gl-account-group. readOnly: true example: EastCoastWarehouses href: type: string description: URL for the gl-account-group. readOnly: true example: /objects/general-ledger/gl-account-group/23 memberFilter: type: array description: >- One or more filters to select the warehouses to include in the warehouse group. nullable: true items: title: memberFilter properties: field: type: string description: Warehouse field to filter on. enum: - createdAtEntityId - location - managerId - parentWarehouse - status - warehouseId example: status operator: type: string description: Operator to filter the group. enum: - equals - doesNotEqual - isGreaterThan - isLessThan - isOneOf - isNotOneOf - isEmpty - isNotEmpty - contains - isCurrentUser example: equals value: type: string description: Value to use to filter the group. example: active conditionType: type: string description: >- Whether multiple memberFilter are treated as 'and', 'or', or as a complex expression. example: and enum: - and - or - expression default: and expression: type: string description: >- Expression for combining multiple filters. Only applicable if the 'conditionType' is 'expression'. example: (1 AND 2) OR 3 groupMembers: type: array description: The members of the warehouse group. items: $ref: '#/components/schemas/inventory-control-warehouse-group-member' audit: $ref: '#/components/schemas/audit' inventory-control-cycleRequiredProperties: type: object required: - id inventory-control-cycle: type: object description: Inventory cycle information. properties: key: type: string description: System generated Key example: 1 readOnly: true id: type: string description: >- Unique identifier for the inventory cycle. The face ID cannot be modified. example: Monthly Cycle description: type: string description: Description for the inventory cycle example: Monthwise inventory cycle href: type: string description: inventory-cycle url example: /objects/inventory-control/cycle/3 readOnly: true status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' inventory-control-documentRequiredProperties: type: object required: - transactionDate properties: lines: type: array items: required: - unit - unitQuantity - unitCost properties: dimensions: required: - item - warehouse - location example: >- { "item": { "id": "1" }, "warehouse": { "id": "1" }, "location" : { "id": "1" }} inventory-control-document-line-detail: type: object description: >- List of warehouse inventory details including serial number, aisle, bin, and row per item properties: key: type: string description: System-assigned key for the Inventory Control document line detail readOnly: true example: '55' id: type: string description: Inventory Control document line details ID readOnly: true example: '55' href: type: string description: Endpoint for the Inventory Control document line detail readOnly: true example: /objects/inventory-control/document-line-detail/55 quantity: type: string format: decimal-precision-10 description: >- The quantity in base units for the combination of the tracking attributes specified in this line detail example: '10' serialNumber: type: string description: Serial number of the item example: S1001 lotNumber: type: string description: The lot number of the item(s) example: L1001 expirationDate: type: string description: The expiration date of the item(s) format: date nullable: true example: '2023-04-04' aisle: type: object description: Aisle associated with the line details properties: href: type: string description: Endpoint for the aisle readOnly: true example: /objects/inventory-control/aisle/10 key: type: string description: System-assigned key for the aisle example: '10' id: type: string description: Aisle ID example: AISLE1 bin: type: object description: The bin associated with the line details properties: href: type: string description: Endpoint for the bin. readOnly: true example: /objects/inventory-control/bin/20 key: type: string description: System-assigned key for the bin example: '20' id: type: string description: Bin ID example: BIN1 row: type: object description: The row associated with the line details properties: href: type: string description: Endpoint for the row readOnly: true example: /objects/inventory-control/row/15 key: type: string description: System-assigned key for the row example: '15' id: type: string description: Row ID example: ROW1 item: type: object description: Item associated with the line details properties: key: type: string description: System-assigned key for the item example: '10' id: type: string description: Item ID example: Battery href: type: string description: URL for the item readOnly: true example: /objects/inventory-control/item/10 componentItem: type: object description: Component item associated with the line details properties: key: type: string description: System-assigned key for the component item example: '10' id: type: string description: Component item Id example: Battery href: type: string description: URL for the component item readOnly: true example: /objects/inventory-control/item/10 audit: $ref: '#/components/schemas/audit' inventoryDocumentLine: type: object description: Inventory document line information readOnly: true properties: key: type: string description: System-assigned key for the Inventory document line readOnly: true example: '23' id: type: string description: ID for the document line item readOnly: true example: '23' documentType: type: string description: Type of the Inventory document line readOnly: true example: Beginning Balance href: type: string description: URL for the Inventory document readOnly: true example: /objects/inventory-control/document-line::Beginning%20Balance/23 inventory-control-document-line: type: object description: >- Line information for Inventory transactions including opening balances and adjustments. properties: key: type: string description: System-assigned key for the Inventory document line item readOnly: true example: '23' id: type: string description: System-assigned ID for the Inventory document line item readOnly: true example: '23' href: type: string description: URL for the Inventory document line item readOnly: true example: /objects/inventory-control/document-line::Beginning%20Balance/23 documentType: type: string description: The type of transaction example: Beginning Balance readOnly: true memo: type: string description: Line item memo example: Starting quantity of fuel pumps lineDescription: type: string description: Line item description example: High efficiency pump unitOfMeasure: type: object description: The unit of measure for this line properties: key: type: string description: The unit of measure Key example: '38' maxLength: 8 id: type: string description: The unit of measure Id example: Each maxLength: 20 href: type: string description: Unit of measure URL. readOnly: true example: /objects/inventory-control/unit-of-measure/38 unitQuantity: type: string format: decimal-precision-10 description: Unit quantity associated with this line item example: '100' quantity: type: string format: decimal-precision-10 description: Base unit quantity associated with this line item readOnly: true example: '100' quantityConverted: type: string format: decimal-precision-10 description: >- Quantity of the item converted to a downstream document from the original quantity entered readOnly: true example: '5' quantityRemaining: type: string format: decimal-precision-10 description: Quantity remaining after a partial conversion of this transaction readOnly: true example: '5' cost: type: string format: decimal-precision-10 description: The cost per base unit example: '1.00' readOnly: true unitCost: type: string format: decimal-precision-10 description: Unit cost associated with this line item example: '1.00' extendedCost: type: string format: decimal-precision-10 description: Extended total cost example: '1.00' totalCost: type: string format: decimal-precision-10 description: Total cost readOnly: true example: '1.0000000000' lineNumber: type: integer description: Line number of the document line readOnly: true example: 15 costMethod: type: string description: Item cost method readOnly: true default: null nullable: true example: standard enum: - null - average - standard - FIFO - LIFO txnCurrency: type: string description: Transaction currency example: USD baseCurrency: type: string description: Transaction base currency example: USD conversionType: type: string description: Transaction conversion type enum: - quantity - price default: quantity example: quantity trackingDetail: type: array description: >- List of warehouse inventory details including serial number, aisle, bin, and row per item. items: $ref: '#/components/schemas/inventory-control-document-line-detail' documentHeader: type: object properties: href: type: string description: URL for the inventory-document. readOnly: true example: /objects/inventory-control/document::Beginning%20Balance/23 key: type: string description: System-assigned unique key of the Inventory document example: '23' id: type: string description: Inventory document ID example: Beginning Balance-ADJINC0001 documentNumber: type: string description: Document header number example: ADJINC0001 documentType: type: string description: Type of the Inventory document readOnly: true example: Beginning Balance dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: title: location type: object description: Location associated with the document line properties: key: type: string description: System-assigned location key example: '22' id: type: string description: Location ID example: LOC-22 href: type: string description: Location URL readOnly: true example: /objects/company-config/location/23 department: type: object description: Department associated with the document line title: department properties: key: type: string description: System-assigned department key readOnly: true example: '9' id: type: string description: Department ID example: Sales href: type: string description: Department URL readOnly: true example: /objects/company-config/department/9 warehouse: title: warehouse description: Warehouse associated with the document line type: object properties: key: type: string description: System-assigned warehouse key example: '6' id: type: string description: Warehouse ID example: WH01 href: type: string description: Warehouse URL readOnly: true example: /objects/inventory-control/warehouse/6 project: title: project description: Project associated with the document line type: object properties: key: type: string description: System-assigned project key example: '2' id: type: string description: Project ID example: NET-XML30-2 href: type: string readOnly: true description: Project URL example: /objects/projects/project/2 task: title: task description: Task associated with the document line type: object properties: id: type: string description: Task ID example: TSK01 key: type: string description: System-assigned task key example: '1' href: type: string description: Task readOnly: true example: /objects/projects/task/1 sourceDocument: type: object description: Parent or source document properties: href: type: string description: Inventory-document URL readOnly: true example: /objects/inventory-control/document::Beginning%20Balance/23 id: type: string description: Source inventory document ID example: BB-193 documentType: type: string description: Source inventory document type example: Beginning Balance readOnly: true key: type: string description: System assigned inventory document key example: '23' sourceDocumentLine: type: object description: Source document line properties: href: type: string description: URL for the Inventory document line readOnly: true example: /objects/inventory-control/document-line::Beginning%20Balance/23 id: type: string description: Source document line ID. example: '23' key: type: string description: Source document line key. example: '23' documentType: type: string description: Type of the Inventory document line readOnly: true example: Beginning Balance audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true status: $ref: '#/components/schemas/status' inventory-control-document-history: type: object description: >- History of workflow conversions associated with the Inventory transaction properties: key: type: string description: System-assigned key for the Inventory document history readOnly: true example: '11' id: type: string description: System-assigned ID for the Inventory document history readOnly: true example: '11' href: type: string description: Endpoint for the Inventory document history readOnly: true example: /objects/inventory-control/document-history/11 convertedFrom: type: object description: >- When an inventory document is the result of a conversion, this field shows the transaction from which the document was converted. readOnly: true properties: key: type: string description: System-assigned key for the Inventory document readOnly: true example: '22' id: type: string description: System-assigned ID for the Inventory document readOnly: true example: SYS-Warehouse Transfer Out-WHXFER-000028-doc-Out documentType: type: string description: Type of the Inventory document readOnly: true example: SYS-Warehouse Transfer Out href: type: string description: URL for the Inventory document readOnly: true example: >- /objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/22 convertedTo: type: object description: >- When an inventory document is the result of a conversion, this field shows the transaction to which the document was converted. readOnly: true properties: key: type: string description: System-assigned key for the Inventory document readOnly: true example: '14' id: type: string description: System-assigned ID for the Inventory document readOnly: true example: SYS-Warehouse Transfer In-WHXFER-000028-doc-In documentType: type: string description: Type of the Inventory document readOnly: true example: SYS-Warehouse Transfer In href: type: string description: URL for the Inventory document readOnly: true example: >- /objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/14 inventoryDocument: type: object description: >- The Inventory document with which the history information is associated readOnly: true properties: key: type: string description: System-assigned key for the Inventory document. readOnly: true example: '23' id: type: string description: Name or other unique identifier for the Inventory document. readOnly: true example: '23' documentType: type: string description: Type of the Inventory document readOnly: true example: SYS-Warehouse Transfer Out href: type: string description: Endpoint for the document. readOnly: true example: >- /objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/23 inventory-control-document-subtotal: type: object description: Details of Subtotals, taxes, discounts, charges etc for the transaction. properties: key: type: string description: System-assigned key for the inventory document subtotal. readOnly: true example: '23' id: type: string description: ID for the inventory document subtotal. readOnly: true example: '23' href: type: string description: Endpoint for the inventory document subtotal. readOnly: true example: /objects/inventory-control/document-subtotal/23 description: type: string description: Description about subtotal. example: Freight percentValue: type: string format: decimal-precision-10 description: >- Percentage value that is calculated on the total of all line items of the document. example: '5.0000000000' absoluteValue: type: string format: decimal-precision-2 description: >- Non negative base amount calculated across all other lines of the document. example: '1.20' txnAbsoluteValue: type: string format: decimal-precision-2 description: >- Non negative transaction amount calculated across all other lines of the document. readOnly: true example: '1.20' isValueEditable: type: boolean description: Indicates whether the absoluteValue is editable. readOnly: true example: false enum: - false - true default: false isPercentEditable: type: boolean description: Indicates whether the percentValue is editable. readOnly: true example: false enum: - false - true default: false total: type: string format: decimal-precision-14 readOnly: true description: The computed base amount for the subtotal. example: '1.20000000000000' txnTotal: type: string format: decimal-precision-14 readOnly: true description: The computed transaction amount for the subtotal. example: '1.20000000000000' documentLine: type: object description: The Inventory document line associated with the subtotal. readOnly: true properties: href: type: string description: Endpoint for the Inventory document line. readOnly: true example: >- /objects/inventory-control/document-line::Inventory%20Receipt/62991 key: type: string description: System-assigned key for the inventory document line. readOnly: true example: '62991' id: type: string description: System-assigned ID for the inventory document line. readOnly: true example: '62991' documentType: type: string description: Type of the Inventory Control document example: Inventory Receipt readOnly: true dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: title: location description: Location associated with the subtotal line. type: object properties: key: type: string description: System-assigned key for the location. example: '22' id: type: string description: Identifier for the location. example: LOC-22 href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/22 department: title: department type: object description: >- A dimension that allows you to create a hierarchy of departments to reflect how your company is organized. properties: key: type: string description: System-assigned key for the department. readOnly: true example: '9' id: type: string description: Unique identifier of the department. example: Accounting href: type: string readOnly: true description: URL for the department. example: /objects/company-config/department/9 documentHeader: type: object description: Inventory document header. readOnly: true properties: href: type: string description: URL for the inventory-document. readOnly: true example: /objects/inventory-control/document::Inventory%20Receipt/7808 key: type: string description: Document header number. readOnly: true example: '7808' documentType: type: string description: Type of the order entry document. example: Inventory Receipt readOnly: true id: type: string readOnly: true example: Inventory Receipt-IR-000253 audit: $ref: '#/components/schemas/audit' inventory-control-document: type: object description: >- Header information for Inventory Control transactions including opening balances and adjustments properties: key: type: string description: System-assigned key for the Inventory document readOnly: true example: '23' id: type: string description: Inventory document ID readOnly: true example: Beginning Balance-ADJINC0001 documentNumber: type: string description: >- Document number; if the transaction definition does not have a numbering sequence configured, provide a number to identify the transaction. example: ADJINC0001 documentType: type: string description: The type of transaction example: Beginning Balance isPrinted: type: boolean description: Indicates whether the document has been printed readOnly: true enum: - true - false default: false example: false subTotal: type: string format: decimal-precision-2 description: Subtotal of the document in base currency example: '1.00' readOnly: true total: type: string format: decimal-precision-2 description: The sum of values across all lines in the document example: '1.00' readOnly: true subtotalInTxnCurrency: type: string format: decimal-precision-2 description: Subtotal of the document in transaction currency example: '1.00' readOnly: true totalInTxnCurrency: type: string format: decimal-precision-2 description: Total in the transaction currency example: '1.00' readOnly: true state: type: string description: Document state example: pending default: draft enum: - draft - pending - closed - inProgress - converted - partiallyConverted - convertedByLine - partiallyConvertedByLine - exception referenceNumber: type: string description: Reference number example: INV-1002 memo: type: string description: Text printed on the Inventory document example: Transfer CA to AZ exchangeRate: type: object description: Exchange rate details used to calculate the base amount properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction; either the current date, the date the transaction was issued, or the date the transaction will be paid rate: type: string format: decimal-precision-4 description: >- Exchange rate used to calculate the base amount from the transaction amount example: '1.0789' typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount example: '1' typeName: type: string description: The name of exchange rate type example: Intacct Daily Rate transactionDate: type: string format: date description: Transaction date example: '2023-01-01' lastPrintedDate: type: string format: date description: Last printed date. example: '2023-01-01' nullable: true isAdjustmentDocument: type: boolean description: is this an Adjustment Document. example: false default: false baseCurrency: type: string description: Base currency for the transaction. example: USD txnCurrency: type: string description: Currency used for the transaction. example: USD txnDefinition: type: object properties: href: type: string description: URL for the inventory transaction definition. readOnly: true example: /objects/inventory-control/txn-definition/23 key: type: string description: Transaction definition key. example: '23' id: type: string description: Transaction definition id. example: Beginning Balance documentType: type: string description: Type of transaction. example: Beginning Balance txnDefinitionTemplateClass: type: string description: Transaction definition template class. readOnly: true example: INVOICE updatesInventory: type: string description: Affects inventory. example: quantityAndValue enum: - 'no' - quantity - value - quantityAndValue increaseOrDecreaseInventory: type: string description: Increases or decreases inventory. example: increase enum: - increase - decrease sourceDocument: type: object properties: key: type: string description: Source document key. example: '23' id: type: string description: The source from which the order entry document was created. example: Beginning Balance-Doc0001 href: type: string description: URL for the inventory-document. readOnly: true example: /objects/inventory-control/document/23 attachment: type: object description: Supporting document for this Inventory transaction properties: key: type: string example: '23' id: type: string example: Beginning Balance attachment href: type: string description: URL for the inventory-document. readOnly: true example: /objects/company-config/attachment/23 printedBy: type: object description: The last user who printed this document properties: href: type: string description: URL for the user readOnly: true example: /objects/company-config/user/23 key: type: string description: Last printed by example: '23' id: type: string description: Last printed by example: John Smith warehouse: type: object properties: key: type: string description: Warehouse Key example: '23' id: type: string description: Warehouse ID example: WH-0001 defaultWarehouse: type: string description: Default warehouse. example: DF-WH-0001 href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 href: type: string description: URL for the inventory-document. readOnly: true example: /objects/inventory-control/document/23 entity: $ref: '#/components/schemas/entity-ref' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true lines: type: array description: Lines of the order entry document. items: $ref: '#/components/schemas/inventory-control-document-line' history: type: array description: Lines of the Inventory document history items: $ref: '#/components/schemas/inventory-control-document-history' subtotals: type: array description: Lines of the inventory document subtotal. items: $ref: '#/components/schemas/inventory-control-document-subtotal' postingSummary: type: object description: Information about the journal entries associated with this document readOnly: true properties: key: type: string description: Record number of Inventory Control posting summary example: '23' id: type: string description: Inventory Control posting summary ID example: '23' href: type: string description: URL for the Inventory Control posting summary example: /objects/inventory-control/posting-summary/23 journalEntry: type: object description: The journal entries associated with this document readOnly: true properties: key: type: string description: Record number of Journal Entry example: '23' id: type: string description: Journal Entry ID example: '23' href: type: string description: URL for the Journal Entry example: /objects/journal-entry/23 inventory-control-item-groupRequiredProperties: type: object required: - id - name - groupType inventory-control-item-group-member: type: object description: Member items of an item group properties: key: type: string description: System-assigned key for the item-group member. readOnly: true example: '41' id: type: string description: Unique identifier for the Item group member. readOnly: true example: '41' href: type: string description: item group member URL. readOnly: true example: /objects/inventory-control/item-group-member/41 itemGroup: type: object description: Item group that this item is a member of. properties: key: type: string description: System-assigned key for the item group. example: '16' id: type: string description: Unique identifier for the Item group. example: 1st Level Items href: type: string description: URL for the item group. readOnly: true example: /objects/inventory-control/item-group/16 item: type: object description: reference of the member item. properties: key: type: string description: key of the associated Item object. example: '16' id: type: string description: ID of the associated Item object. example: C001 name: type: string description: Name of the associated Item object. readOnly: true example: Printers-HP status: title: status type: string readOnly: true description: Item status enum: - active - inactive example: active href: type: string description: URL of the associated item object. readOnly: true example: /objects/inventory-control/item/16 sortOrder: type: integer description: Sort Order of the item within the item group. example: 1 audit: $ref: '#/components/schemas/audit' inventory-control-item-group: type: object description: >- An item group categorizes item dimension records, mainly for the purpose of structuring financial reporting. properties: key: type: string description: System-assigned key for the item-group. readOnly: true example: '23' id: type: string description: Unique identifier for the Item group. example: 1st Level Items href: type: string description: item group URL. readOnly: true example: /objects/inventory-control/item-group/23 name: type: string description: Name of the item group. example: Level 1 Items description: type: string description: Description about the item group. example: Level 1 Items groupType: type: string description: >- Group membership type. Set the group type to filter from the whole set of dimension groups. * `all` - All items that match the `memberFilter` criteria. If ‘all’ is selected, 'memberFilter' is required. * `specific` - Specify the items to include and their order in the `groupMembers` array. If ‘specific’ is selected, 'groupMembers' is required. example: all enum: - all - specific sortField: type: string description: Item field to sort on.Only applicable when `groupType` = `all`. example: itemId default: itemId enum: - area - brand - catalogReference - category - color - condition - costMethod - createdAtEntityId - dateLastReceived - dateLastSold - defaultWarehouse - density - durometer - ean13 - enableStartAndEndDates - engineeringAlert - extendedDescription - glGroup - height - innerDiameter - inventoryCycle - itemId - itemTaxGroup - itemType - length - maximumThickness - minimumThickness - name - netWeight - note - numberOfPeriods - outerDiameter - periodsMeasuredIn - primaryCountryOfOrigin - productLineId - productType - replenishmentMethod - shippingWeight - size1 - size2 - specification1 - specification2 - specification3 - standardCost - status - style - subBrand - subCategory - substituteItem - taxable - taxCode - thickness - uomForArea - uomForDensity - uomForDiameter - uomForLengthWidthAndHeight - uomForThickness - uomForVolume - uomForWeight - upc - upc12 - unitOfMeasureGroup - volume - webLongDescription - webName - webShortDescription - width sortOrder: type: string description: >- Sort order for the items that match the `memberFilter`. Only applicable when `groupType` = `all`. example: ascending enum: - ascending - descending default: ascending maxMatches: type: integer description: >- The maximum number of items to fetch after sorting on the SortField as per the sort order (ascending or decending). Only applicable when `groupType` = `all` example: 100 createDimensionComponents: type: boolean description: >- Set to 'true' to create a dimension structure that enables the group to be used on the rows and columns of financial reports. If this field is set to false, the group can only be used for filtering. default: false example: true glAccountGroup: type: object description: General ledger (GL) account group associated with the item group. properties: key: type: string example: '23' id: type: string description: ID for the gl-account-group. example: 1st Level Items href: type: string description: URL for the gl-account-group. readOnly: true example: /objects/inventory-control/gl-account-group/23 memberFilter: type: array description: >- One or more filters to select the items to include in the item group. nullable: true items: properties: field: type: string description: Item field to filter on. example: status enum: - area - brand - catalogReference - category - color - condition - costMethod - createdAtEntityId - dateLastReceived - dateLastSold - defaultWarehouse - density - durometer - ean13 - enableStartAndEndDates - engineeringAlert - extendedDescription - glGroup - height - innerDiameter - inventoryCycle - itemId - itemTaxGroup - itemType - length - maximumThickness - minimumThickness - name - netWeight - note - numberOfPeriods - outerDiameter - periodsMeasuredIn - primaryCountryOfOrigin - productLineId - productType - replenishmentMethod - shippingWeight - size1 - size2 - specification1 - specification2 - specification3 - standardCost - status - style - subBrand - subCategory - substituteItem - taxable - taxCode - thickness - uomForArea - uomForDensity - uomForDiameter - uomForLengthWidthAndHeight - uomForThickness - uomForVolume - uomForWeight - upc - upc12 - unitOfMeasureGroup - volume - webLongDescription - webName - webShortDescription - width operator: type: string description: Operator to filter the group. enum: - equals - doesNotEqual - isGreaterThan - isLessThan - isOneOf - isNotOneOf - isEmpty - isNotEmpty - contains - isCurrentUser example: equals value: type: string description: Value to use to filter the group. example: active conditionType: type: string description: >- Whether multiple memberFilter are treated as 'and', 'or', or as a complex expression. example: and enum: - and - or - expression default: and expression: type: string description: >- Expression for combining multiple filters. Only applicable if the 'conditionType' is 'expression'. example: (1 AND 2) OR 3 groupMembers: type: array description: The members of the item group. items: $ref: '#/components/schemas/inventory-control-item-group-member' audit: $ref: '#/components/schemas/audit' 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 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' order-entry-documentRequiredProperties: type: object required: - transactionDate properties: customer: required: - id example: IBN lines: type: array items: required: - unit - unitQuantity - unitPrice properties: dimensions: required: - item - warehouse - location example: >- { "item": { "id": "1" }, "warehouse": { "id": "1" }, "location": { "id": "1" }} order-entry-document-line-detail: type: object description: >- List of warehouse inventory details including serial number, aisle, bin, and row per item. properties: key: type: string description: System-assigned key for the Order Entry document line detail. readOnly: true example: '55' id: type: string description: Order Entry document line details ID. readOnly: true example: '55' href: type: string description: Endpoint for the Order Entry document line detail. readOnly: true example: /objects/order-entry/document-line-detail/55 quantity: type: string format: decimal-precision-10 description: >- The quantity of the units being built for the combination of the tracking attributes specified for the line. example: '10' serialNumber: type: string description: Serial number of the line item. example: S1001 lotNumber: type: string description: >- The lot numbers for the units being built and the quantity being built for each lot example: L1001 expirationDate: type: string description: >- The expiration date for the units being built and the quantity being built. format: date example: '2023-04-04' aisle: type: object description: Aisle associated with the line details. properties: href: type: string description: Endpoint for the aisle. readOnly: true example: /objects/inventory-control/aisle/10 key: type: string description: System-assigned key for the aisle. example: '10' id: type: string description: Aisle ID. example: AISLE1 bin: type: object description: The bin associated with the line details. properties: href: type: string description: Endpoint for the bin. readOnly: true example: /objects/inventory-control/bin/20 key: type: string description: System-assigned key for the bin. example: '20' id: type: string description: Bin ID. example: BIN1 row: type: object description: The row associated with the line details. properties: href: type: string description: Endpoint for the row. readOnly: true example: /objects/inventory-control/row/15 key: type: string description: System-assigned key for the row. example: '15' id: type: string description: Row ID. example: ROW1 item: type: object description: Item associated with the line details. properties: key: type: string description: System-assigned key for the item. example: '10' id: type: string description: Item ID. example: Battery href: type: string description: URL for the item. readOnly: true example: /objects/inventory-control/item/10 audit: $ref: '#/components/schemas/audit' orderEntryDocumentLine: type: object description: Order Entry document line information. readOnly: true properties: key: type: string description: System-assigned key for the Order Entry document line. readOnly: true example: '23' id: type: string description: ID for the document line item. readOnly: true example: '23' documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: URL for the Order Entry document. readOnly: true example: /objects/order-entry-document-line::Sales%20Order/23 order-entry-document-line: description: >- Line items in an Order Entry document that represent Order Entry transactions. type: object properties: key: type: string description: System-assigned key for the Order Entry document line item. readOnly: true example: '44' id: type: string description: ID for the for the Order Entry document line item. readOnly: true example: '44' href: type: string description: URL for the Order Entry document line item. readOnly: true example: /objects/order-entry/document-line::Sales%20Invoice/44 documentType: type: string description: The type of transaction document. readOnly: true example: Sales Invoice lineNumber: type: integer description: Line number for the document line. readOnly: true example: 1 item: type: object description: Item associated with the document line. properties: key: type: string description: System-assigned key for the item. example: '10' id: type: string description: ID for the item. readOnly: true example: MX001 href: type: string description: URL for the item. readOnly: true example: /objects/inventory-control/item/10 itemAlias: type: object description: Alternative name for the Item for a specific customer. properties: key: type: string description: System-assigned key for the item alias. example: '10' id: type: string description: ID for the item alias. example: IXN href: type: string description: URL for the item alias. readOnly: true example: /objects/accounts-receivable/customer-item-cross-reference/10 memo: type: string description: Memo about the document line item. example: Payment ACH priceCalculationMemo: type: string description: Memo about price calculation used for the document line item. example: Fair value price list unit: type: string description: Unit associated with this document line item. example: Each quantity: type: string format: decimal-precision-10 readOnly: true description: Quantity associated with this document line item. example: '40.10' unitQuantity: type: string format: decimal-precision-10 description: Unit quantity associated with this document line item. example: '10.10' unitPrice: type: string format: decimal-precision-10 description: Unit price associated with this line item. example: '10.50' price: type: string format: decimal-precision-10 readOnly: true description: The price is computed based on unit factor. example: '33.66' quantityConverted: type: string format: decimal-precision-10 readOnly: true description: >- Quantity of item/s converted to a downstream document from the original quantity entered. example: '5.10' retailPrice: type: string format: decimal-precision-10 readOnly: true description: Suggested price for the item. example: '10.44' audit: $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' costMethod: type: string description: Cost method associated with the document line item. readOnly: true enum: - null - standard - average - FIFO - LIFO default: null nullable: true example: average discountPercent: type: string format: decimal-precision-2 description: Discount percentage for the document line item. example: '10.50' multiplier: type: number description: Multiplier example: 1 sourceDocument: type: object description: Parent/Source document properties: key: type: string description: System-assigned key for the Order Entry document. example: '77' id: type: string description: >- The source transaction from which the Order Entry document was created. example: Sales Order-SO0022 documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: Endpoint for the Order Entry document. readOnly: true example: /objects/order-entry-document::Sales%20Order/77 sourceDocumentLine: type: object description: Parent/Source document line that needs to be converted. properties: key: type: string description: System-assigned key for the Order Entry document line item. example: '2234' id: type: string description: ID for the for the Order Entry document line item. example: '2234' documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: URL for the Order Entry document line item. readOnly: true example: /objects/order-entry/document-line::Sales%20Order/2234 isPriceProrated: type: boolean description: Indicates whether the price is prorated. example: true default: true discountMemo: type: string description: Discount memo for any discounts taken. example: Festival discount baseCurrency: type: string description: Base currency for the transaction. readOnly: true example: USD txnCurrency: type: string description: Currency used for the transaction. readOnly: true example: CAD priceInTxnCurrency: type: string format: decimal-precision-10 readOnly: true description: Transaction price. example: '10.00' isBillable: type: boolean description: Indicates whether the line is billable. example: true default: true isBilled: type: boolean description: Indicates whether the line has been billed. readOnly: true example: true default: true taxRate: type: string format: decimal-precision-2 description: Tax rate for the document line item. example: '10.05' taxInBaseCurrency: type: string format: decimal-precision-2 description: The line level tax amount in base currency. readOnly: true example: '10.50' taxInTxnCurrency: type: string format: decimal-precision-2 description: The line level tax amount in transaction currency. readOnly: true example: '40.50' discountPercentage: type: string format: decimal-precision-2 description: Discount applied to the line item. example: '10.25' enableTax: type: boolean description: Indicates whether the line item is taxable. default: false example: false quantityRemaining: type: string format: decimal-precision-10 description: Quantity of the item remaining. readOnly: true example: '10.10' conversionType: type: string description: Conversion type used for the transaction. enum: - quantity - price default: quantity example: quantity dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: title: location type: object description: Location associated with the document line. properties: key: type: string description: System-assigned key for the location. example: '22' id: type: string description: Identifier for the location. example: LOC-22 href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/22 department: type: object description: >- A dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string description: System-assigned key for the department. readOnly: true example: '9' id: type: string description: Unique identifier of the department. example: Sales href: type: string description: URL for the department. readOnly: true example: /objects/company-config/department/9 warehouse: title: warehouse description: Warehouse associated with the document line. type: object properties: key: type: string description: System-assigned key for the warehouse. example: '6' id: type: string description: Unique identifier for the warehouse. example: WH01 href: type: string description: URL for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/6 project: title: project description: Project associated with the document line. type: object properties: key: type: string description: System-assigned key for the associated project. example: '2' id: type: string description: ID for the associated project. example: NET-XML30-2 href: type: string readOnly: true description: URL for the project. example: /objects/projects/project/2 task: title: task description: Task associated with the document line. type: object properties: id: type: string description: Identifier for the associated task. example: TSK01 key: type: string description: System-assigned key for the associated task. example: '1' href: type: string description: URL for the task. readOnly: true example: /objects/projects/task/1 itemRenewalTemplate: type: object description: The template used for renewal schedules. properties: key: type: string description: The key of renewal template. example: '45' id: type: string description: The ID of renewal template. example: Sales Renewal Template href: type: string description: URL for the order-entry-renewal-template. readOnly: true example: /objects/order-entry/renewal-template/45 revenueRecognitionStartDate: type: string description: >- The date on which the either revenue recognition schedule and/or renewal schedule get started. format: date example: '2023-04-04' revenueRecognitionEndDate: type: string description: >- The date on which the either revenue recognition schedule and/or renewal schedule ends. format: date example: '2023-04-04' requestedShippingDate: type: string description: >- The date the customer requests the goods to arrive on their premises. The default is the due date. format: date example: '2023-04-04' shipByDate: type: string description: >- The date the goods should be shipped so they arrive when the customer needs them. format: date example: '2023-04-04' pickTicketPrintedDate: type: string description: The date on which the pick ticket is printed. format: date example: '2023-04-04' cancelAfterDate: type: string description: Indicates the date after which the order can be canceled. format: date example: '2023-04-04' doNotShipBeforeDate: type: string description: Do not ship before this date. format: date example: '2023-04-04' doNotShipAfterDate: type: string description: Do not ship after this date. format: date example: '2023-04-04' shippedDate: type: string description: The date that the order was shipped. format: date example: '2023-04-04' allowDropship: type: boolean description: Indicates whether dropship is allowed for the line. default: false example: true allowBuyToOrder: type: boolean description: Indicates whether buy-to-order is allowed for the line. default: false example: true buyToOrderContact: type: object description: Contacts for delivering the buy-to-order. properties: key: type: string description: System-assigned key for the contact. readOnly: true example: '13' id: type: string description: Identifier for the contact. example: contact trackingDetail: type: array description: >- List of warehouse inventory details including serial number, aisle, bin, and row per item. items: $ref: '#/components/schemas/order-entry-document-line-detail' documentHeader: type: object description: Header lever details for the document line items. properties: key: type: string description: System-assigned key for the order entry document. example: '55' id: type: string description: ID for the order entry document. example: Sales Invoice-SO0066 documentType: type: string description: Type of the order entry document. example: Sales Invoice readOnly: true href: type: string description: URL for the order entry document. readOnly: true example: /objects/order-entry-document::Sales%20Invoice/55 order-entry-document-subtotal: type: object description: Details of Subtotals, taxes, discounts, charges etc for the transaction. properties: key: type: string description: System-assigned key for the Order Entry document subtotal. readOnly: true example: '12' id: type: string description: ID for the Order Entry document subtotal. readOnly: true example: '12' href: type: string description: Endpoint for the Order Entry document subtotal. readOnly: true example: /objects/order-entry/document-subtotal/12 description: type: string description: Description about the subtotal. example: Tax percentValue: type: string format: decimal-precision-2 description: >- Percentage value that is calculated on the total of all line items of the document. example: '10.50' absoluteValue: type: string format: decimal-precision-2 description: >- Non negative base amount calculated across all other lines of the document. readOnly: true example: '40.50' txnAbsoluteValue: type: string format: decimal-precision-2 description: >- Non negative transaction amount calculated across all other lines of the document. example: '44.78' isValueEditable: type: boolean description: >- Indicates whether the percent value or the transaction absolute value is editable. readOnly: true enum: - false - true example: true default: false isPercentEditable: type: boolean description: Indicates whether the percent is editable. readOnly: true enum: - false - true example: true default: false total: type: string format: decimal-precision-2 readOnly: true description: The computed base amount for the subtotal. example: '500.10' txnTotal: type: string format: decimal-precision-2 readOnly: true description: The computed transaction amount for the subtotal. example: '400.10' documentLine: type: object description: The Order Entry document line associated with the subtotal. readOnly: true properties: key: type: string description: System-assigned key for the Order Entry document line. readOnly: true example: '10' documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true id: type: string description: System-assigned ID for the Order Entry document line. readOnly: true example: '10' href: type: string description: Endpoint for the Order Entry document line. readOnly: true example: /objects/order-entry-document-line::Sales%20Order/10 audit: $ref: '#/components/schemas/audit' dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: title: location description: Location associated with the subtotal line. type: object properties: key: type: string description: System-assigned key for the location. example: '22' id: type: string description: Identifier for the location. example: LOC-22 href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/22 department: title: department type: object description: >- A dimension that allows you to create a hierarchy of departments to reflect how your company is organized. properties: key: type: string description: System-assigned key for the department. readOnly: true example: '9' id: type: string description: Unique identifier of the department. example: Accounting href: type: string readOnly: true description: URL for the department. example: /objects/company-config/department/9 documentHeader: type: object description: Order entry document header. readOnly: true properties: key: type: string description: System-assigned key for the Order Entry document. readOnly: true example: '23' id: type: string description: ID for the Order Entry document. readOnly: true example: '23' documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: Endpoint for the Order Entry document. readOnly: true example: /objects/order-entry-document::Sales%20Order/23 order-entry-document-history: type: object description: >- History of workflow conversions associated with the Order Entry transaction. properties: key: type: string description: System-assigned key for the Order Entry document history readOnly: true example: '11' id: type: string description: System-assigned ID for the Order Entry document history readOnly: true example: '11' href: type: string description: Endpoint for the Order Entry document history. readOnly: true example: /objects/order-entry/document-history/11 convertedFrom: type: object description: >- The transaction from which the corresponding Order Entry transaction was converted readOnly: true properties: key: type: string description: System-assigned key for the Order Entry document. readOnly: true example: '22' id: type: string description: System-assigned ID for the Order Entry document. readOnly: true example: Sales Order-ORINV#0182#doc documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: URL for the Order Entry document. readOnly: true example: /objects/order-entry-document::Sales%20Order/22 convertedTo: type: object description: The associated transaction in a workflow history readOnly: true properties: key: type: string description: System-assigned key for the Order Entry document. readOnly: true example: '14' id: type: string description: System-assigned ID for the Order Entry document. readOnly: true example: Sales Invoice-SUBINV#0182#doc documentType: type: string description: Type of the order entry document. example: Sales Invoice readOnly: true href: type: string description: URL for the Order Entry document. readOnly: true example: /objects/order-entry-document::Sales%20Invoice/14 orderEntryDocument: type: object description: >- The Order Entry document with which the history information is associated with readOnly: true properties: key: type: string description: System-assigned key for the Order Entry document. readOnly: true example: '23' id: type: string description: Name or other unique identifier for the Order Entry document. readOnly: true example: Sales Order-ORINV#0182#doc documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: Endpoint for the document. readOnly: true example: /objects/order-entry-document::Sales%20Order/22 order-entry-document: type: object description: An Order Entry document contains information about sales transactions. properties: key: type: string description: System-assigned key for the Order Entry document. readOnly: true example: '55' id: type: string description: Name or other unique identifier for the Order Entry document. readOnly: true example: Sales Invoice-SI-O122 href: type: string description: URL for the Order Entry document. readOnly: true example: /objects/order-entry/document::Sales%20Invoice/55 documentNumber: type: string description: >- Document number for the Order Entry document. If the transaction definition does not have a numbering sequence configured, provide a number to identify the transaction. example: SI-O122 documentType: type: string readOnly: true description: The type of transaction document. example: Sales Invoice state: type: string description: | State of the Order Entry document. enum: - submitted - approved - partiallyApproved - declined - draft - pending - closed - inProgress - converted - partiallyConverted - convertedByLine - partiallyConvertedByLine - exception example: draft default: draft isPrinted: type: boolean description: Indicates whether the document has been printed. readOnly: true enum: - true - false default: false example: true isBackordered: type: boolean description: Indicates whether the transaction is a back order. readOnly: true enum: - true - false default: false example: false subTotal: type: string format: decimal-precision-2 readOnly: true description: Subtotal of the document in base currency. example: '50.10' subtotalInTxnCurrency: type: string format: decimal-precision-2 readOnly: true description: Subtotal of the document in transaction currency. example: '51.10' total: type: string format: decimal-precision-2 readOnly: true description: The sum of values across all lines in the document. example: '100.10' totalInTxnCurrency: type: string format: decimal-precision-2 readOnly: true description: Total in the transaction currency. example: '100.11' baseCurrency: type: string description: Base currency for the transaction. example: USD txnCurrency: type: string description: Currency used for the transaction. example: USD exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: string format: decimal-precision-10 description: >- Exchange rate used to calculate the base amount from the transaction amount. example: '1.0789' typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: '1' typeName: type: string description: The name of exchange rate type. example: Intacct Daily Rate transactionDate: type: string description: Date on the Order Entry document. format: date example: '2023-04-04' dueDate: type: string description: Due date for the Order Entry document. format: date example: '2023-04-04' isSystemGeneratedDocument: type: boolean description: Indicates whether the Order Entry document is system generated. readOnly: true example: true default: false postingDate: type: string format: date description: The date on which Order Entry document posts to the General Ledger. example: '2023-04-04' referenceNumber: type: string description: Reference number for the Order Entry document. example: SALES-100 notes: type: string description: Notes about the Order Entry document. example: Fast order memo: type: string description: Text printed on the Order Entry document. example: Lowry solutions contractID: type: string description: Sales contract ID associated with the transaction. example: CN100123 contractDescription: type: string description: Sales contract description. example: Sales & Service paymentStatus: type: string description: Payment status for the transaction. readOnly: true enum: - paid - partiallyPaid - open default: open example: paid invoiceDate: type: string description: Original invoice date. format: date example: '2023-04-04' customerPONumber: type: string description: Customer PO number associated with the transaction. example: ABOTT-1001 trackingNumber: type: string description: User-provided tracking reference number. example: TK-1002 shipByDate: type: string description: The ship-by date for the order. format: date example: '2023-04-04' shippedDate: type: string description: The date that the order was shipped. format: date example: '2023-04-04' serviceDeliveryDate: type: string description: The date on which the service is delivered. format: date example: '2023-04-04' cancelAfterDate: type: string description: Indicates the date after which the order can be canceled. format: date example: '2023-04-04' doNotShipBeforeDate: type: string description: Do not ship before this date. format: date example: '2023-04-04' doNotShipAfterDate: type: string description: Do not ship after this date. format: date example: '2023-04-04' requestedShippingDate: type: string description: >- The date the customer requests the goods to arrive on their premises. The default is the due date. format: date example: '2023-04-04' contacts: type: object description: Contacts associated with the Order Entry document. properties: primary: type: object description: Primary contact properties: key: type: string description: System-assigned key for the primary contact. readOnly: true example: '13' id: type: string description: Identifier for the primary contact. example: contact shipTo: type: object description: Ship-to contact. properties: key: type: string description: System-assigned key for the ship-to contact. readOnly: true example: '33' id: type: string description: Identifier for the ship-to contact. example: contact billTo: type: object description: Bill-to contact. properties: key: type: string description: System-assigned key for the bill-to contact. readOnly: true example: '44' id: type: string description: Identifier for the bill-to contact. example: contact shippingMethod: type: object description: Shipping method for the order. properties: key: type: string description: System-assigned key for the shipping method. example: '77' id: type: string description: Identifier for the shipping method. example: Air href: type: string description: URL for the shipping method. example: /objects/accounts-receivable/shipping-method/77 printedByUser: type: object description: User who printed the document. readOnly: true properties: key: type: string description: User name. readOnly: true example: '21' id: type: string description: Identifier for the user. readOnly: true example: John href: type: string readOnly: true description: URL for the user. example: /objects/company-config/user/21 txnDefinition: type: object description: Transaction definition that is associated with this transaction. properties: key: type: string description: System-assigned key for the transaction definition. example: '11' id: type: string description: Name for the Order Entry transaction definition. example: Sales Invoice href: type: string description: Endpoint for the Order Entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/11 sourceDocument: type: object description: Parent/Source document properties: key: type: string description: System-assigned key for the Order Entry document. example: '44' id: type: string description: >- The source transaction from which the Order Entry document was created. example: Sales Order-SO0022 documentType: type: string description: Type of the order entry document. example: Sales Order readOnly: true href: type: string description: Endpoint for the source. readOnly: true example: /objects/order-entry/document::Sales%20Order/44 customer: type: object description: Customer associated with the Order Entry document. properties: key: type: string description: System-assigned key for the customer. example: '15' id: type: string description: Customer ID example: customer href: readOnly: true description: URL for the customer. type: string example: /objects/accounts-receivable/customer/15 contract: type: object description: Contract associated with the Order Entry document. properties: key: type: string description: System-assigned key for the contract. example: '46' id: type: string description: ID of the contract. example: CNRT1001 href: type: string description: Endpoint for the contract. readOnly: true example: /objects/contracts/contract/46 paymentTerm: type: object description: >- Accounts Receivable (AR) term, which determines the expiration date for quotes and the due date for invoices. properties: href: type: string description: Endpoint for the term. readOnly: true example: /objects/term/75 key: type: string description: System-assigned key for the AR term. example: '75' id: type: string description: The name of AR term. example: 10 Days audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Date and time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true taxSolution: type: object description: >- The associated tax solution for the transaction. Tax solutions are available for different countries, for example Australia GST or South Africa VAT. properties: key: type: string description: System-assigned key for the tax solution. example: '44' id: type: string description: ID for the tax solution. example: Avalara href: type: string description: URL for the tax solution. readOnly: true example: /objects/taxsolution/44 taxCalculationMethod: type: string description: Calculation method used for the tax solution. nullable: true default: null example: noTax enum: - null - noTax - simpleTax - advancedTax - avaTax - VAT showMultilineTax: type: boolean description: Indicates whether to show multiple taxes per line. readOnly: true example: true default: true lines: type: array description: Lines of the Order Entry document. items: $ref: '#/components/schemas/order-entry-document-line' subtotals: type: array description: Lines of the Order Entry document subtotal. items: $ref: '#/components/schemas/order-entry-document-subtotal' history: type: array description: Lines of the Order Entry document history. items: $ref: '#/components/schemas/order-entry-document-history' order-entry-document-lineRequiredProperties: type: object required: - unit - unitQuantity - unitPrice properties: dimensions: required: - item - warehouse - location example: >- { "item": { "id": "1" }, "warehouse": { "id": "1" }, "location": { "id": "1" }} documentHeader: required: - key example: '22' order-entry-txn-definitionRequiredProperties: type: object required: - id order-entry-txn-definition-cogs-gl-detail: type: object description: GL account mappings for costing for Order Entry transaction definitions. properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-cogs-gl-detail. readOnly: true example: '23' id: type: string description: Order Entry transaction definition COGS accounts ID. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-cogs-gl-detail. readOnly: true example: /objects/order-entry/txn-definition-cogs-gl-detail/23 isOffset: type: boolean description: If true, then the line will be marked as offset. example: true default: false txnType: type: string description: Debit or credit type. enum: - debit - credit example: debit moduleType: type: string description: Module type. example: subledger enum: - subledger - inventory - additional lineNumber: type: integer description: Line no. example: 1 maxLength: 8 glAccount: type: object properties: key: type: string description: System-assigned key for the account. example: '384' id: type: string description: User-assigned number for the account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/384 location: type: object properties: href: type: string description: Endpoint for the location. readOnly: true example: /objects/company-config/location/23 key: type: string description: >- System-assigned unique key for the location. Used to identify the location in URLs or JSON bodies for all operations on the location. example: '3345' id: type: string description: Location. example: Arizona department: type: object properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/23 key: type: string description: Department key example: '28' id: type: string description: Department. example: Sales itemGLGroup: type: object properties: href: type: string description: Endpoint for the itemglgroup. readOnly: true example: /objects/itemglgroup/23 key: type: string description: System-assigned key for the item GL group. example: '13' id: type: string description: Name or other unique identifier for the item GL group. example: Stockable Kit warehouse: type: object properties: href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 key: type: string description: Default warehouse key. example: '23' id: type: string description: Unique identifier for the warehouse. example: Warehouse-001 customerGLGroup: type: object description: Customer GL Group properties: id: type: string description: Customer GL group name. example: Group 1 status: $ref: '#/components/schemas/status' order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-ar-direct-gl-detail: type: object description: >- Account Receivable or direct GL account detail for Order Entry transaction. properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-ar-direct-gl-detail. readOnly: true example: '23' id: type: string description: Order Entry transaction definition GL mapping ID. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-ar-direct-gl-detail. readOnly: true example: /objects/order-entry/txn-definition-ar-direct-gl-detail/23 isOffset: type: boolean description: If true then the line is marked as Offset. example: true default: false txnType: type: string description: Debit or credit type. enum: - debit - credit example: debit moduleType: type: string description: Module type. example: subledger enum: - subledger - inventory - additional lineNumber: type: integer description: Line no. example: 1 maxLength: 8 glAccount: type: object properties: key: type: string description: System-assigned key for the account. example: '384' id: type: string description: User-assigned number for the account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/384 location: type: object properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/23 key: type: string description: >- System-assigned unique key for the location. Used to identify the location in URLs or JSON bodies for all operations on the location. example: '3345' id: type: string description: Location. example: Arizona department: type: object properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/23 key: type: string description: Department key example: '28' id: type: string description: Department. example: Sales itemGLGroup: type: object properties: href: type: string description: Endpoint for the itemglgroup. readOnly: true example: /objects/itemglgroup/23 key: type: string description: System-assigned key for the item GL group. example: '13' id: type: string description: Name or other unique identifier for the item GL group. example: Stockable Kit warehouse: type: object properties: href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 key: type: string description: Default warehouse key. example: '23' id: type: string description: Unique identifier for the warehouse. example: Warehouse-001 customerGLGroup: type: object description: Customer GL Group properties: id: type: string description: Customer GL group name. example: Group 1 status: $ref: '#/components/schemas/status' order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-additional-gl-detail: type: object description: >- Additional GL posting account detail for Order Entry transaction transaction properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-additional-gl-detail. readOnly: true example: '23' id: type: string description: Order Entry transaction definition GL mapping ID. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-additional-gl-detail. readOnly: true example: >- /objects/order-entry/order-entry-txn-definition-additional-gl-detail/23 isOffset: type: boolean description: If true then the line is marked as offset. example: true default: false txnType: type: string description: Debit or credit type. enum: - debit - credit example: debit moduleType: type: string description: Module type. example: additional enum: - additional lineNumber: type: integer description: Line no. example: 1 maxLength: 8 glAccount: type: object properties: key: type: string description: System-assigned key for the account. example: '384' id: type: string description: User-assigned number for the account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/384 location: type: object properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/23 key: type: string description: >- System-assigned unique key for the location. Used to identify the location in URLs or JSON bodies for all operations on the location. example: '3345' id: type: string description: Location. example: Arizona department: type: object properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/23 key: type: string description: Department key example: '28' id: type: string description: Department. example: Sales itemGLGroup: type: object properties: href: type: string description: Endpoint for the itemglgroup. readOnly: true example: /objects/itemglgroup/23 key: type: string description: System-assigned key for the item GL group. example: '13' id: type: string description: Name or other unique identifier for the item GL group. example: Stockable Kit warehouse: type: object properties: href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 key: type: string description: Default warehouse key. example: '23' id: type: string description: Unique identifier for the warehouse. example: Warehouse-001 customerGLGroup: type: object description: Customer GL Group properties: id: type: string description: Customer GL group name. example: Group 1 status: $ref: '#/components/schemas/status' order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-inventory-total-detail: type: object description: Inventory total detail for Order Entry transaction properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-inventory-total-detail. readOnly: true example: '23' id: type: string description: Document parameters total ID. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-inventory-total-detail. readOnly: true example: /objects/order-entry/txn-definition-inventory-total-detail/23 maintainType: type: string description: Maintain type. enum: - quantity - value - quantityAndValue example: value operation: type: string description: Add or subtract. enum: - add - subtract example: add inventoryTotal: type: object description: Inventory total properties: id: type: string description: Inventory total. example: eg order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-subtotal-detail: type: object description: Sub-total detail for Order Entry transaction properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-subtotal-detail. readOnly: true example: '23' id: type: string description: >- System-assigned ID for the order-entry-txn-definition-subtotal-detail. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-subtotal-detail. readOnly: true example: /objects/order-entry/txn-definition-subtotal-detail/23 subtotalType: type: string description: Subtotal type. example: discount enum: - null - discount - charge nullable: true default: null lineNumber: type: integer description: Line number. example: 1 maxLength: 8 description: type: string description: Description. example: Discount valueType: type: string description: Value type. example: amount enum: - null - amount - percent nullable: true default: null subtotalValue: type: string format: decimal-precision-2 description: >- Provide a default value for the subtotal. If Value type is Amount, enter the amount of the subtotal. For example, enter 250. If Value type is Percent, enter a percentage as a whole number. For example, enter 10 for 10%. Users can override the default subtotal value in the transaction. example: '10.23' maxLength: 12 isApportioned: type: boolean description: >- If true, then the discount subtotal will be apportioned across all line items in the transaction. example: true default: false glAccount: type: object description: Select the GL account to which the subtotal will post. properties: key: type: string description: System-assigned key for the general ledger account. example: '5' id: type: string description: User-assigned number for the GL account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/5 offsetGLAccount: type: object description: Select the offset GL account to which the subtotal will post properties: key: type: string description: System-assigned key for the general ledger account. example: '5' id: type: string description: Unique ID for the account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/5 txnType: type: string description: Transaction type - debit or credit. example: debit enum: - null - debit - credit nullable: true default: null appliedToLineNumber: type: integer description: >- Specify the subtotal line number to which the subtotal will apply. Sage Intacct treats the initial subtotal line as line number 0. The first defined subtotal from the transaction definition is line number 1, the second defined subtotal is line number 2, and so on. The value of Applied to line is implicitly assumed to be 0. Taxes, all other charges, and discounts are computed at the line level. This fields does not apply if is set to line-level Simple Tax. example: 1 maxLength: 8 isTax: type: boolean description: >- Flags the subtotal as a tax. When the transaction posts, the tax will post separately based on the items in the transaction. example: true default: false department: type: object description: Select a default department for the subtotal properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/23 key: type: string description: Department key example: '28' id: type: string description: Department. example: Sales location: type: object description: Select a default location for the subtotal properties: key: type: string description: System-assigned key for the location. readOnly: true example: '22' id: type: string description: Identifier for the location. readOnly: true example: Arizona href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/22 readOnly: true enableAvalaraTax: type: boolean description: If set to true then the subtotal line item applies to AvaTax. example: true default: false entity: type: object description: Sets the context where the transaction definition is created properties: href: type: string description: Endpoint for the entityloc. readOnly: true example: /objects/entityloc/23 key: type: string description: >- System-assigned unique key for the entity. Used to identify the entity in URLs or JSON bodies for all operations involving the entity. readOnly: true example: '3345' id: type: string description: Name of the location. readOnly: true example: Australia readOnly: true order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-source-document-detail: type: object description: Document conversion detail for an Order Entry transaction properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-recall-detail. readOnly: true example: '23' id: type: string description: ID. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-recall-detail. readOnly: true example: /objects/order-entry-txn-definition-recall-detail/23 sourceDocument: type: object description: >- Specify the transaction definitions from which this transaction can be converted. For example, a sales invoice can be converted from a sales order and a shipper. properties: href: type: string description: Endpoint for the sodocumentparams. readOnly: true example: /objects/sodocumentparams/23 key: type: string description: System-assigned key for the order entry transaction definition. example: '23' id: type: string description: Document id. example: Sales order isDefault: type: boolean description: Default for bulk conversion. example: true default: false order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition-entity-setting-detail: type: object description: Entity settings for order entry transaction properties: key: type: string description: >- System-assigned key for the order-entry-txn-definition-entity-setting-detail. readOnly: true example: '23' id: type: string description: Document parameters entity property ID. readOnly: true example: '23' href: type: string description: Endpoint for the order-entry-txn-definition-entity-setting-detail. readOnly: true example: /objects/order-entry/txn-definition-entity-setting-detail/23 enableNumberingSequence: type: boolean description: If true then enable sequence numbering. example: false default: false preserveNumberingSequence: type: boolean description: If true then preserve sequence numbering. example: false default: false canInheritSourceDocumentNumber: type: boolean description: Inherit source document number. example: false default: false documentTemplate: type: object description: >- Provide printed document template to use as the default for printed output (PDFs) for the corresponding entity. Order entry transaction definition document template is used if you not provide this field. properties: key: type: string description: The system generated key document template. example: '65' maxLength: 8 id: type: string description: The name of document template. example: Sales Order maxLength: 100 enableCreateTransactionRule: type: boolean description: Create transactions in. example: false default: false subtotalTemplate: type: object description: >- Specifies the template for populating the transaction subtotals table. properties: href: type: string description: Endpoint for the order entry subtotal template. readOnly: true example: /objects/order-entry/subtotal-template/23 key: type: string description: Subtotal template. example: '22' id: type: string description: Name of a order entry subtotal template. example: Subtotal template showExpandedTaxDetail: type: boolean description: Show expanded tax details. example: false default: false enableOverrideTax: type: boolean description: Line-item tax. example: false default: false enableLineLevelSimpleTax: type: boolean description: Enable line-level Simple Tax. example: false default: false entity: type: object properties: href: type: string description: Endpoint for the entityloc. readOnly: true example: /objects/entityloc/23 key: type: string description: >- System-assigned unique key for the entity. Used to identify the entity in URLs or JSON bodies for all operations involving the entity. example: '23' id: type: string description: >- Unique identifier of the entity. 20 characters max. The ID cannot be changed after the entity has been created. example: Lyon documentSequence: type: object properties: key: type: string description: Document sequence Key example: '23' href: type: string description: Endpoint for the seqnum. readOnly: true example: /objects/company-config/document-sequence/23 id: type: string description: The ID of the numbering sequence. example: Adjustment Decrease audit: $ref: '#/components/schemas/audit' order-entry-txn-definition: type: object description: Header level details. properties: key: type: string description: System-assigned key for the order-entry-txn-definition. readOnly: true example: '23' id: type: string description: System-assigned ID for the order-entry-txn-definition. readOnly: true example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 readOnly: true order-entry-txn-definition: type: object description: >- An order entry transaction definition includes the accounting rules, workflow settings, security settings, and other characteristics for a transaction. properties: key: type: string description: System-assigned key for the order entry transaction definition. readOnly: true example: '23' id: type: string description: The name for the order entry transaction definition. example: Sales Quote href: type: string description: URL for the order entry transaction definition. readOnly: true example: /objects/order-entry/txn-definition/23 docClass: type: string description: Order entry transaction template type. example: quote enum: - quote - order - list - invoice - adjustment - other default: quote workflowCategory: type: string description: Workflow category example: quote enum: - quote - order - shipping - invoice - return default: quote description: type: string description: Description about order entry transaction definition. example: Sales Return RevRec Document enableUserOrGroupPermmission: type: boolean description: >- By default, all users with the appropriate application permissions have access to transactions that use this transaction definition. To restrict access to certain users or groups, set this field to 'true'. example: true readOnly: true default: false editPolicy: type: string description: >- Sets the edit permission for this transaction type. By default, the user cannot edit the transaction after it is created. example: noEdit enum: - noEdit - beforePrinting - editInDraftOnly - all default: all deletePolicy: type: string description: >- Sets the delete permission for this transaction type. By default, a user cannot delete a transaction after it is created. example: all enum: - noDelete - beforePrinting - all default: noDelete enableNumberingSequence: type: boolean description: Enable numbering scheme for order entry transaction. example: false default: false preserveNumberingSequence: type: boolean description: If true then preserve sequence numbers for order entry transaction. example: false default: false inheritDocumentNumber: type: boolean description: >- Set to `true` if transactions should inherit source document numbers. For example, a transaction could inherit a sales invoice number. example: false default: false inventoryUpdateType: type: string description: >- Specify if inventory will be affected by the transaction and, if so, whether to track the quantity, value, or both . enum: - 'no' - quantity - value - quantityAndValue example: 'no' default: 'no' increaseOrDecreaseInventory: type: string description: >- Specify whether the inventory running total is increased or decreased by the transaction. example: increase enum: - increase - decrease default: increase txnPostingMethod: type: string description: >- Specify whether the transaction post process creates a GL entry and, if so, whether it will post directly to the GL or to the AR subledger. example: toGL enum: - toAR - toGL - noPosting default: noPosting disableTax: type: boolean description: Set to `true` to disable tax capture for the transaction. example: false default: false enableFulfillment: type: boolean description: Set to `true` to enable the transaction definition for fulfillment. example: false default: false enableReservingAndPicking: type: boolean description: Set to `true` to enable inventory items for reserving and picking. example: false default: false partialConvertMethod: type: string description: >- Specify how the system processes transactions that are partially complete. example: closeTransaction enum: - leaveTransactionOpen - closeOriginalAndCreateBackOrder - closeTransaction default: closeTransaction affectsCost: type: boolean description: If true the transaction will affect the costing of order entry. example: false default: false overrideExchangeRateType: type: boolean description: >- Indicates whether users can edit the Exchange rate and/or Exchange rate type fields of the transaction. example: false default: true showBaseCurrency: type: boolean description: >- Specifies whether the transaction amounts are displayed in both base currency and transaction currency. example: false default: false overridePrice: type: boolean description: >- Set to `true` to allow users to override line item prices on the transaction. example: false default: true trackDiscountAndSurcharge: type: boolean description: Indicates whether users can discount transaction line items. example: false default: false allowDiscountOnExtendedPrice: type: boolean description: >- Indicates whether the transaction definition can be used for contract invoices. This field is only applicable if the company is subscribed to Contracts. example: false default: false requireMemoForDiscount: type: boolean description: >- Indicates whether users must provide notes for line items being discounted before saving a transaction. example: false default: false freezeRecallValue: type: boolean description: Set to `true` to freeze recalled values example: false default: false enableSubtotals: type: boolean description: >- Set to `true` to specify standard subtotals, such as tax or a discount, for the transaction. example: false default: false showExpandedTaxDetails: type: boolean description: >- Set to `true` to show expanded tax details in the transaction user interface and in printed output. This field applies only to companies that use Avalara AvaTax or Sage Intacct Advanced Tax. example: false default: false enableOverrideTax: type: boolean description: Indicates whether users can override whether a line item is taxable. example: false default: false revrecEnablementType: type: string description: >- Specifies whether revenue recognition applies to transactions created from this definition and, if so, whether to post the revenue recognition or only display it. This field applies only to companies subscribed to Revenue Management and is applicable only to Order Entry revenue recognition. example: post enum: - post - displayOnly - none default: none renewalEnablementType: type: string description: >- Specifies whether contract renewals apply to the transaction type and, if so, whether the renewal is set up to generate when the transaction posts or the renewal fields are displayed in the transaction so users can select a renewal transaction set. example: displayOnly enum: - generate - displayOnly - none default: none enableLineItemConversion: type: boolean description: >- Set to `true` to allow users to convert a sales transaction by line item into a scheduled recurring transaction. example: false default: false allowRenewConvertedLineOnly: type: boolean description: >- This field is only applicable if `enableRenewals` is set to `Generate`. Set to `true` if the system should only renew line items that were converted in the original sales transaction. Set to `false` if all indicated line items should be renewed, regardless of conversion status. example: false default: false allowLocationOverride: type: boolean description: >- Set to 'true' to allow users to override the location set for the transaction. example: false default: false allowDepartmentOverride: type: boolean description: >- Set to `true` to allow users to override the department set for the transaction. example: false default: false xslTemplate: type: string description: Document template to use for printed output (PDFs). example: sales fixedMessage: type: string description: This message is displayed in the Print/Email document. example: >- For any inquiries or assistance, please contact our customer service. contactOneTitle: type: string description: >- Use this field to change the Bill-to labels on the transaction and on the printed document. example: Bill to default: Bill to contactTwoTitle: type: string description: >- Use this field to change the Ship-to labels on the transaction and on the printed document. example: Ship to default: Ship to printBillToContact: type: boolean description: If true then show the 'Bill to' contact in printed document. example: false default: false printShipToContact: type: boolean description: If true then show the 'Ship to' contact in printed document. example: false default: false allowEditingBillToContact: type: boolean description: >- If true then allow to change the Bill-to contact during transaction entry. example: false default: false allowEditingShipToContact: type: boolean description: >- If true then allow to change the Ship-to contact during transaction entry. example: false default: false enableWarnOnLowQuantity: type: boolean description: >- Indicates whether to alert the user if the quantity needed is greater than the ONHAND total in the selected warehouse. The warning also shows the ONORDER and ONHOLD totals. example: false default: true enableCreditLimitCheck: type: boolean description: >- Specifies whether to enforce customer credit limit restrictions in transactions created from this definition. example: false default: false warehouseSelectionMethod: type: string description: >- Determines how warehouses are presented to the user in the warehouse list in the transaction. example: sortByID enum: - sortByID - sortByName - warehouseWithAvailableInventory - useTheDefaultWarehouse default: sortByID enablePayments: type: boolean description: >- Set to `true` to enable users to apply payments to an invoice in Order Entry and to set a recurring template to automatically charge a credit card when an invoice is generated (if the company is subscribed to Payment Services). example: false default: false latestVersionKey: type: string description: >- System-assigned version key for the order entry transaction definition. readOnly: true example: '23' postToGL: type: boolean description: If true then enable additional posting to General Ledger. example: false default: false requireSupplyOfPrices: type: boolean description: Set to `true` if a price must be supplied. example: false default: false enableCosting: type: boolean description: If true then enable costing for non-inventoried items. example: false default: false documentConversionPolicy: type: string description: Document conversion policy. example: convertOnly enum: - null - newDocumentOnly - newDocumentOrConvert - convertOnly nullable: true default: null multiEntityRuleForTransaction: type: string description: >- Sets the context for where users can create transactions from this transaction definition within a multi-entity, shared environment. example: topLevelOnly enum: - topLevelOrEntity - topLevelOnly - entityOnly default: topLevelOrEntity enableProjectActualBillings: type: boolean description: >- If true then enable display of actual billings on printed or emailed invoices. example: false default: false lineLevelSimpleTax: type: boolean description: If true then enable line-level Simple Tax. example: false default: false customerVendorEditRule: type: string description: >- Allow users to change the customer in Draft or Pending transactions if the transaction has not been converted to another transaction, the transaction date is in an open period, and the transaction's payment status is not `Paid` or `Partially paid`. By default, the users cannot edit the customer. example: always enum: - null - always - exceptConvertedDocuments - never nullable: true default: null enableRetainage: type: boolean description: Set to 'true' to enable retainage. example: false default: false enableAdditionalInformationScope: type: boolean description: >- Set to 'true' to enable identification of work that is included and excluded, the reason why, and the terms. example: false default: false enableAdditionalInformationSchedule: type: boolean description: Set to 'true' to enable identification of dates for work milestones. example: false default: false enableInternalReference: type: boolean description: >- Set to 'true' to enable identification of who authorized work internally and when they authorized the work. example: false default: false enableExternalReference: type: boolean description: >- Set to 'true' to enable identification of who authorized work externally and when they authorized the work. example: false default: false enableBond: type: boolean description: >- Set to 'true' to identify information about performance and payment bonds. example: false default: false documentChangeType: type: string description: >- Indicates whether to enable changes to the transaction definition and, if so, how to handle changes. example: enableChange enum: - noChange - enableChange - changeOrder default: noChange reportingCategory: type: string description: >- Establishes a reporting category that best reflects the purpose of the transaction definition so that similar documents can be grouped when building reports. This field is applicable for use with Interactive Custom Report Writer or Interactive Visual Explorer subscriptions only. example: salesQuotes enum: - null - salesQuotes - salesOrders - salesOrderChangeOrders - salesOrderInvoices - salesReturns - salesShippers - salesCredits - salesDebits - salesClearingShippers - contractBids - contracts - contractChangeOrders - contractInvoicePreview - contractInvoices - projectInvoices - revRecActivation - forecastRevenue - pledges - giftsAndDonations - pledgeAndGiftInvoices - grantApplications - grantAwardInvoices - eventReservations - eventConfirmations - conferencesAndGatherings - eventInvoices - membershipRegistrations - membershipInvoices - invoicePreview - invoices - tuitionRegistrations - tuitionInvoices - sponsorships - sponsorshipInvoices - subscriptions - subscriptionInvoices - reservations - pointOfSale nullable: true default: null enableContractBilling: type: boolean description: If true then enable project contract billing. example: false default: false arPostingMethod: type: string description: Update method for project contract totals. example: addition enum: - null - none - addition nullable: true default: null documentSequence: type: object description: >- Select the numbering sequence to use to automatically number transactions properties: key: type: string description: Document sequence Key example: '23' href: type: string description: Endpoint for the seqnum. readOnly: true example: /objects/company-config/document-sequence/23 id: type: string description: The ID of the numbering sequence. example: Adjustment Decrease initialPriceList: type: object description: >- The first price list the system will evaluate when determining a suggested transaction price. properties: href: type: string description: Endpoint for the pricelist. readOnly: true example: /objects/pricelist/23 key: type: string description: System-assigned key for the sales price list. example: '22' id: type: string description: ID for the initial price list. example: Initial Price List updatePriceList: type: object description: The price list that will be updated when a user saves a transaction. properties: href: type: string description: Endpoint for the updpricelist. readOnly: true example: /objects/updpricelist/23 key: type: string description: System-assigned key for the order entry price list. example: '22' id: type: string description: The name of order entry price list. example: OE Price List specialPriceList: type: object description: The special price list takes precedence over the Initial price list. properties: href: type: string description: Endpoint for the spclpricelist. readOnly: true example: /objects/spclpricelist/23 key: type: string description: System-assigned key for the order entry price list. example: '21' id: type: string description: Special price list. example: Special price list warehouse: type: object description: Default warehouse properties: key: type: string description: Default warehouse key. example: '23' href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 id: type: string description: Unique identifier for the warehouse. example: Warehouse-001 shippingMethod: type: object description: >- The default for how goods in the transaction are shipped to the customer. If a shipping method is specified for a customer, the customer shipping method takes precedence as the default in the transaction. properties: href: type: string description: Endpoint for the shipping method. readOnly: true example: /objects/shipmethod/23 key: type: string description: System-assigned key for the shipping method example: '11' id: type: string description: Name or description of the shipping method. example: FedEx subtotalTemplate: type: object description: >- Specifies the template for populating the transaction subtotals table. properties: href: type: string description: Endpoint for the order entry subtotal template. readOnly: true example: /objects/order-entry/subtotal-template/23 key: type: string description: Subtotal template. example: 22 id: type: string description: Name of a order entry subtotal template. example: Subtotal template arTerm: type: object description: >- Accounts Receivable (AR) term, which determines the expiration date for quotes and the due date for invoices. properties: href: type: string description: Endpoint for the term. readOnly: true example: /objects/term/23 key: type: string description: System-assigned key for the AR term. example: '21' id: type: string description: The name of AR term. example: 10 Days exchangeRateType: type: object properties: key: type: string description: The ID of the exchange rate type. example: '-1' id: type: string description: The name of exchange rate type. example: Intacct Daily Rate href: type: string description: Endpoint for the exchangeratetype. readOnly: true example: /objects/exchange-rate-type/-1 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' COGSGLDetail: type: array description: >- Specify the COGS GL accounts to debit and credit. For companies that do not use Inventory Control, these accounts are required when Enable costing for non-inventoried items is set to true and Transaction posting is set to Accounts Receivable. items: $ref: '#/components/schemas/order-entry-txn-definition-cogs-gl-detail' accountReceivableOrDirectGLDetail: type: array description: >- When Transaction posting is set to Accounts Receivable or General Ledger, specify the AR or GL accounts to debit and credit. items: $ref: '#/components/schemas/order-entry-txn-definition-ar-direct-gl-detail' additionalGLDetail: type: array description: >- When Transaction posting is set to Accounts Receivable and Enable additional posting is set to true, specify the GL account details for additional GL account posting. These accounts are used to reverse the previous transaction in the workflow. items: $ref: '#/components/schemas/order-entry-txn-definition-additional-gl-detail' inventoryTotalDetail: type: array description: Inventory total detail for Order Entry transaction items: $ref: '#/components/schemas/order-entry-txn-definition-inventory-total-detail' subtotalDetail: type: array description: sub-total detail for Order Entry transaction items: $ref: '#/components/schemas/order-entry-txn-definition-subtotal-detail' sourceDocumentDetail: type: array description: Document conversion detail for an Order Entry transaction items: $ref: '#/components/schemas/order-entry-txn-definition-source-document-detail' entitySettingDetail: type: array description: Entity detail for order entry transaction items: $ref: '#/components/schemas/order-entry-txn-definition-entity-setting-detail' order-entry-txn-definition-additional-gl-detailRequiredProperties: required: - id order-entry-txn-definition-ar-direct-gl-detailRequiredProperties: required: - id order-entry-txn-definition-cogs-gl-detailRequiredProperties: required: - id order-entry-txn-definition-entity-setting-detailRequiredProperties: required: - entity order-entry-txn-definition-inventory-total-detailRequiredProperties: required: - inventoryTotal - maintainType - operation order-entry-txn-definition-source-document-detailRequiredProperties: required: - sourceDocument order-entry-txn-definition-subtotal-detailRequiredProperties: required: - id - glAccount - offsetGLAccount - subtotalType - valueType - txnType - description order-entry-billing-scheduleRequiredProperties: type: object required: - id order-entry-billing-schedule: type: object description: >- This object provides order entry billing schedule information, including billing template details. properties: key: type: string description: System-assigned key for the order entry billing schedule. readOnly: true example: '23' id: type: string description: >- ID for the order entry billing schedule. This value is the same as key for this object and can be ignored. Use key for all references to this object. readOnly: true example: '23' href: type: string description: URL for the order entry billing schedule. readOnly: true example: /objects/order-entry/billing-schedule/23 billingTemplate: type: object description: Project billing template associated with the billing schedule. properties: key: type: string description: System-assigned key for the billing template. example: null id: type: string description: ID for the billing template. example: null templateId: type: string description: Short and descriptive identifier for the billing template. example: null href: type: string description: URL for the project billing template. readOnly: true example: /objects/projects/project-billing-template/23 description: type: string description: Description of the project billing template. example: null billingMethod: type: string description: >- Indicates whether to bill services by percent completed or by milestone. example: null enum: - percentCompleted - milestone calculateOn: type: string description: >- Indicates whether to calculate billing on a project basis or a task basis. example: null orderEntryDocument: type: object description: Order entry document associated with the billing schedule. properties: key: type: string description: Key for the document header. id: type: string description: Name or other unique identifier for the order entry document. example: null href: type: string description: URL for the order entry document. readOnly: true example: /objects/order-entry/document/23 sourceTransaction: type: string description: Source transaction. example: null sourceTransactionDate: type: string description: Source transaction date. example: null orderEntryDocumentLine: type: object description: Line item in the associated order entry document. properties: key: type: string description: System-assigned key for the document line item. example: null id: type: string description: ID for the document line item. example: null href: type: string description: URL for the document line item. readOnly: true example: /objects/order-entry/document-line/23 projectKey: type: string description: Project key example: null taskKey: type: string description: Task key example: null transactionValue: type: string description: Amount of the line item. example: null lineNumber: type: string description: Line number example: null status: type: string description: Status of the billing schedule. example: null enum: - notStarted - inProgress - completed - closed default: notStarted order-entry-price-scheduleRequiredProperties: type: object required: - id order-entry-price-schedule: type: object description: Sales Price Schedule properties: key: type: string description: Schedule Code readOnly: true id: type: string description: Schedule Code href: type: string readOnly: true description: type: string description: Price schedule description priceList: type: object properties: key: type: string description: Price List id: type: string description: Price List href: type: string readOnly: true discountPercent: type: string description: Discount % status: $ref: '#/components/schemas/status' order-entry-renewal-templateRequiredProperties: type: object required: - id order-entry-renewal-template: type: object description: Header information for Order Entry and contract renewal templates. properties: key: type: string description: System-assigned key for the order-entry-renewal-template. readOnly: true example: '23' id: type: string description: Order entry renewal template ID. example: Sales Renewal Template href: type: string description: URL for the order-entry-renewal-template. readOnly: true example: /objects/order-entry/renewal-template/23 description: type: string description: Description. example: description of an order entry renewal template salesTxnCreation: type: object properties: createSalesTxn: type: boolean description: Create sales transaction. example: false default: false transactionDefinition: type: object properties: href: type: string description: URL for the order-entry-txn-definition. readOnly: true example: /objects/order-entry/txn-definition/23 key: type: string description: Sales transaction key. example: '1' id: type: string description: Sales transaction type. example: Sales Invoice daysBeforeAfter: type: integer description: >- Amount of days before or after the Contract End Date for the SO transaction. example: 10 default: 10 beforeAfterContractEndDate: type: string description: After or before Contract End Date for SO transaction. example: before enum: - before - after default: before txnDateOnRenewedDocument: type: string description: Date on renewed document. example: calculatedDate enum: - calculatedDate - contractEndDate+1 default: contractEndDate+1 startDateOnRenewedDocument: type: string description: Start date of renewed contract. example: sameAsDocumentDate enum: - sameAsDocumentDate - withInheritedOffsetFromParent default: sameAsDocumentDate pricing: type: object properties: pricingType: type: string description: Pricing type. example: sameAsOriginal enum: - sameAsOriginal - defaultPricing - markup/markdown default: sameAsOriginal markup: type: string description: Pricing markup. example: percentageMarkup enum: - percentageMarkup - percentageDiscount - actualMarkup - actualDiscount default: percentageMarkup markupValue: type: string description: Pricing markup by value. example: '1.00' notifications: type: object properties: customer: type: object properties: sendToCustomer: type: boolean description: Customer email. example: false default: false contact: type: string description: Contact. example: customerContact enum: - customerContact - transactionBillToContact - transactionShipToContact default: customerContact daysBeforeAfter: type: integer description: When to send email alert to customer. example: 0 default: 0 beforeAfterContractRenewalDate: type: string description: After or before for customer for contract renewal alert. example: before enum: - before - after default: before customerEmailTemplate: type: object properties: key: type: string description: Customer email template Key. example: '1' id: type: string description: Customer email template Id. Same value as key. example: '1' href: type: string description: URL for the email template. readOnly: true example: /objects/company-config/email-template/23 internal: type: object properties: sendToInternal: type: boolean description: Internal email. example: false default: false daysBeforeAfter: type: integer description: When to send email notification. example: 10 default: 10 beforeAfterContractRenewalDate: type: string description: After or before for sales team notification. example: before enum: - before - after default: before internalEmailTemplate: type: object properties: key: type: string description: internal email template key. example: '1' id: type: string description: internal email template Id. Same value as key. example: '1' href: type: string description: URL for the email template. readOnly: true example: /objects/company-config/email-template/23 latestVersion: type: string description: Latest version key. example: '???' transactionType: type: string description: Transaction type. example: salesTransaction enum: - salesTransaction - contract - evergreen default: salesTransaction termLength: type: string description: Default renewal term length. example: '5' termPeriod: type: string description: Default renewal term period. example: months enum: - years - months - days default: months state: type: string description: Create renewal as. example: draft enum: - inProgress - draft default: inProgress status: $ref: '#/components/schemas/status' order-entry-subtotal-templateRequiredProperties: type: object required: - id order-entry-subtotal-template: type: object description: Order Entry Subtotal Template properties: key: type: string description: key readOnly: true id: type: string description: id href: type: string readOnly: true projects-projectRequiredProperties: type: object required: - name - category projects-project: type: object description: Project for work management. properties: key: type: string description: >- System-assigned unique key for the project. Use this key to refer to the project in all operations. readOnly: true example: '83' id: type: string description: Unique identifier for the project. example: P-0045 name: type: string description: Project name. example: Implementation Project description: type: string description: A brief description of the project. example: Software Implementation Project nullable: true projectCurrency: type: string description: Currency used for project budget information. example: USD nullable: true category: type: string description: Project category. Used for filtering and reporting. example: contract enum: - contract - capitalized - internalNonBillable - internalBillable default: contract projectStatus: type: object description: Project status properties: key: type: string description: Project status key. example: '1' nullable: true id: type: string description: Project status Id. example: In Progress nullable: true disableGenerateInvoice: type: boolean description: >- Whether project invoices can be generated while the project has this status. readOnly: true example: false disablePurchasingAPEntry: type: boolean description: >- Whether AP/PO entries are allowed while the project has this status. readOnly: true example: false disableExpenseEntry: type: boolean description: >- Whether expense entries are allowed while the project has this status. readOnly: true example: false disableTimesheetEntry: type: boolean description: >- Whether timesheet entries are allowed while the project has this status. readOnly: true example: false href: type: string readOnly: true example: /objects/projects/project-status/1 startDate: type: string format: date description: Date on which the project is scheduled to begin. example: '2023-01-23' nullable: true endDate: type: string format: date description: Date on which the project is scheduled to end. example: '2023-04-01' nullable: true budget: type: object description: Budget for this project. properties: id: type: string description: Unique budget identifier. example: '1' nullable: true key: type: string description: System-assigned key for the budget. example: '1' nullable: true billingAmount: type: string description: User-specified project budgeted billing amount. format: decimal-precision-2 example: '10000.00' nullable: true budgetedDuration: type: string description: User-specified project budgeted duration (in hours). format: decimal-precision-2 example: '250' nullable: true budgetedCost: type: string description: User-specified project budgeted cost. format: decimal-precision-2 example: '10000' nullable: true href: type: string readOnly: true example: /objects/general-ledger/budget/1 nullable: true contractAmount: type: string description: The contracted amount for the project for reporting purposes. format: decimal-precision-2 example: '15000.00' nullable: true progress: type: object description: Project progress readOnly: true properties: estimatedDuration: type: string description: Estimated duration (in hours) to complete the project. readOnly: true example: '200' nullable: true actualDuration: type: string description: Actual duration (in hours) currently submitted for the project. readOnly: true example: '183' nullable: true approvedDuration: type: string description: Total approved duration (in hours) for the project. readOnly: true example: '175' nullable: true remainingDuration: type: string description: >- Remaining duration (in hours) allotted for the project (difference between estimated and actual duration). readOnly: true example: '8' nullable: true percentComplete: type: string description: >- Calculated percent completed, or how complete the project is (actual duration divided by estimated duration for project tasks). readOnly: true example: '35' nullable: true observedPercentComplete: type: string description: >- Latest observed percent completed, or how complete the project is as of a specific date. readOnly: true example: '50' nullable: true billingType: type: string description: Billing type specifies how the project will be invoiced. example: timeAndMaterial enum: - null - timeAndMaterial - fixedFee - fixedFeeAndExpenses nullable: true default: null salesOrderNumber: type: string description: Sales order number for the project, for reference. example: SO-5478 nullable: true purchaseOrderNumber: type: string description: Purchase order number for the project, for reference. example: PO-7829 nullable: true purchaseOrderAmount: type: string description: Project purchase order amount, for reference. format: decimal-precision-2 example: '4500.00' nullable: true purchaseQuoteNumber: type: string description: Project purchase quote number, for reference. example: '1453' nullable: true salesforceKey: type: string description: Salesforce key readOnly: true example: '1' nullable: true documentNumber: type: string description: >- An external reference number that can be used to report on the project in custom reports. example: '1453' nullable: true parent: type: object description: >- The parent project if this project is the child of another, larger project. properties: key: type: string description: System-assigned key of the parent project. example: '10' nullable: true id: type: string description: Unique identifier of the parent project. example: P-0040 nullable: true name: type: string description: Parent project name. readOnly: true example: NET-XML30-2 nullable: true href: type: string readOnly: true example: /objects/projects/project/1 nullable: true invoiceWithParent: type: boolean description: >- Set to `true` to include the projects transactions in invoices for the parent project. example: true default: false nullable: true customer: type: object description: The customer associated with the project. properties: key: type: string description: >- System-assigned key for the customer associated with the project. example: '13' nullable: true id: type: string description: Unique identifier of the customer associated with the project. example: '113' nullable: true name: type: string description: Name of the customer associated with the project. readOnly: true example: Software company nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/customer/1 salesContact: type: object description: The sales contact employee for the project. properties: key: type: string description: System-assigned key for the sales contact employee. example: '10' nullable: true id: type: string description: Unique identifier of the sales contact employee. example: '100' nullable: true href: type: string readOnly: true example: /objects/company-config/employee/1 projectType: type: object description: Project type, used to categorize and report on projects- properties: key: type: string description: System-assigned key for the project type. example: '3' nullable: true id: type: string description: Name or ID of the project type. example: Internal nullable: true href: type: string readOnly: true example: /objects/projects/project-type/1 manager: type: object description: >- Project manager employee for the project. Project managers usually approve timesheets and expense reports. Project managers can also run and view project reports. properties: key: type: string description: System-assigned key for the project manager employee. example: '10' nullable: true id: type: string description: Unique identifier for the project manager employee. example: E10 nullable: true href: type: string readOnly: true example: /objects/company-config/employee/1 department: type: object description: >- The department associated with this project. The project department overrides any department associated with an employee on a timesheet. If a project department is not set, the employee department is used. properties: key: type: string description: System-assigned key for the department. example: '10' nullable: true id: type: string description: Unique identifier for the department. example: '20' nullable: true name: type: string description: Name for the department. readOnly: true example: Sales nullable: true href: type: string readOnly: true example: /objects/company-config/department/1 location: type: object description: >- The location associated with this project. The project location overrides any location associated with an employee on a timesheet. If a project location is not set, the employee location is used. properties: key: type: string description: System-assigned key for the project location. example: '1' nullable: true id: type: string description: Unique identifier for the project location. example: DIA nullable: true name: type: string description: Name for the project location. readOnly: true example: US nullable: true href: type: string readOnly: true example: /objects/company-config/location/1 paymentTerm: type: object description: >- The Accounts Receivable payment terms for the project. The payment terms are included on the invoice header. If project payment terms are not set, the customers terms are used. properties: key: type: string description: System-assigned key for project payment terms. example: '10' nullable: true id: type: string description: Payment term name or identifier. example: '10' nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/term/1 customerUser: type: object description: >- A Sage Intacct user assigned as a customer representative with the ability to approve timesheets for the project. properties: key: type: string description: System-assigned key for the user. example: '1' nullable: true id: type: string description: Unique identifier for the user with access to the project. example: Admin nullable: true href: type: string readOnly: true example: /objects/company-config/user/1 class: type: object description: Class dimension used to track the project. properties: key: type: string description: >- System-assigned key for a class dimension associated with the project. example: '1' nullable: true id: type: string description: >- Unique identifier for a class dimension associated with the project. example: '10' nullable: true name: type: string description: Class name associated with the project. readOnly: true example: Construction nullable: true href: type: string readOnly: true example: /objects/company-config/class/1 userRestrictions: type: string description: >- User restrictions for entering project time and expenses (overrides default user restrictions for the Projects application). example: systemDefault enum: - systemDefault - anyUser - projectUsers - projectTaskUsers default: systemDefault isBillableEmployeeExpense: type: boolean description: Set to `true` to bill employee expenses for the project. example: true default: false isBillablePurchasingAPExpense: type: boolean description: >- Set to `true` to bill project purchases entered through Accounts Payable or Purchasing. example: true default: false ratesAndPricing: type: object description: Rates and Pricing properties: laborPricing: type: string description: Billing pricing option. example: billingRate enum: - billingRate - costPlusFee default: billingRate laborMarkup: type: string description: >- Project-specific default rate to calculate labor pricing when labor pricing option is set to cost plus fee. example: '10' expensePricing: type: string description: Expense pricing option. example: billingRate enum: - billingRate - costPlusFee default: costPlusFee expenseMarkup: type: string description: >- Project-specific default rate to calculate expense pricing when expense pricing option is set to cost plus fee. example: '10' defaultRate: type: string description: >- Project-specific default rate to calculate AP/PO pricing when generating project invoices. example: '12' contacts: type: object description: Contacts associated with the project. properties: primary: type: object description: >- The person others can turn to with questions and information about the project. properties: key: type: string description: System-assigned key for the project primary contact. example: '1' nullable: true id: type: string description: Name of the project primary contact. example: '1' nullable: true name: type: string description: Name of the project primary contact. example: Dave readOnly: true nullable: true href: type: string readOnly: true example: /objects/company-config/contact/1 billTo: type: object description: >- The person or organization responsible for paying project invoices. If not set, the customer contact will be used for billing. properties: key: type: string description: System-assigned key for the bill-to contact. example: '1' id: type: string description: System-assigned ID for the bill-to contact. example: '1' name: type: string description: Name of the bill-to contact. example: Larry readOnly: true href: type: string readOnly: true example: /objects/company-config/contact/1 shipTo: type: object properties: key: type: string description: System-assigned key for the Ship-to contact example: '1' id: type: string description: >- Name of the person or organization that is the ship-to contact (blank if shipping to the customer contact). example: '1' name: type: string description: >- Name of the person or organization that is the ship-to contact (blank if shipping to the customer contact). example: Larry readOnly: true href: type: string readOnly: true example: /objects/company-config/contact/1 invoiceMessage: type: string description: Message to appear on invoices. example: Invoice for project nullable: true invoiceCurrency: type: string description: Currency to use when generating invoices for the project. example: USD nullable: true billingOverMax: type: string description: >- Billing control to prevent or warn of billings that exceed the projects budgeted billing amount. example: preventBilling enum: - doNothing - issueAWarningMessage - preventBilling default: doNothing excludeExpenses: type: boolean description: >- Set to `true` to exclude employee, Accounts Payable (AP), and purchase order expenses from the over-budget calculation example: false default: false nullable: true contract: type: object description: The contract that this project is associated with. readOnly: true properties: key: type: string description: >- System-assigned key for the contract associated with the project. readOnly: true example: '1' nullable: true id: type: string description: Unique identifier for the contract associated with the project. readOnly: true example: CON-002 nullable: true href: type: string readOnly: true example: /objects/contracts/contract/1 attachment: type: object description: >- Documents associated with the project, such as statements of work, specifications, or agreements. properties: key: type: string example: '1' nullable: true id: type: string description: Attachment example: '1' nullable: true href: type: string readOnly: true example: /objects/company-config/attachment/1 rootProject: type: object description: The top-level project that this project descends from. readOnly: true properties: key: type: string description: System-assigned key for the top parent project. readOnly: true example: '12' nullable: true id: type: string description: Unique identifier for the top parent project. readOnly: true example: '12' nullable: true name: type: string description: Name of the top parent project. readOnly: true example: PRJ-RT-0001 nullable: true href: type: string readOnly: true example: /objects/projects/project/12 grant: type: object description: Grant-related fields. properties: aln: type: string description: >- Classification in the Catalog of Assistance Listing Numbers (ALN). example: 10.555 nullable: true fundedProjectName: type: string description: External name of the project receiving the funding. example: Undergraduate Programs nullable: true agency: type: string description: Funding agency example: US government nullable: true payer: type: string description: Funding source example: federal enum: - null - federal - thirdParty nullable: true default: null otherId: type: string description: Another external identifier for the funding. example: Other nullable: true assistanceType: type: string description: >- Assistance provided to identify the type of funding (Cash or Non-Cash) example: cash enum: - null - cash - nonCash nullable: true default: null revenueRestriction: type: string description: >- Field to indicate if there is a restriction on the received grant revenue. example: time enum: - null - purpose - time - NA nullable: true default: null restrictionExpiry: type: string description: Duration of time-based restriction (in years) example: '1' nullable: true restrictionExpirationDate: type: string description: >- Date when first restriction expires on time-based restricted funding. format: date example: '2021-01-23' nullable: true isTimeSatisfactionScheduled: type: boolean description: >- Indicates that the release of restriction has been scheduled for time-based restrictions. example: false default: false nullable: true status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' projects-project-resourceRequiredProperties: type: object required: - project projects-project-resource: type: object description: Employee and billing rate for a project. properties: key: type: string description: System-assigned key for the project resource. readOnly: true example: '23' id: type: string description: >- Same as `key`. API operations should use the `key` property to refer to a project resource. readOnly: true example: '23' href: type: string description: Endpoint for the project resource. readOnly: true example: /objects/projects/project-resource/23 description: type: string description: Description of the project resource. example: Hourly resource nullable: true startDate: type: string description: Start date of the resource on the project. format: date example: '2023-04-01' nullable: true employee: type: object description: The employee resource assigned to the project. properties: href: type: string description: Endpoint for the employee. readOnly: true example: /objects/company-config/employee/23 nullable: true key: type: string description: Employee key. example: '244' nullable: true id: type: string description: Employee ID. example: jsmith nullable: true startDate: type: string format: date example: '2022-01-01' nullable: true readOnly: true endDate: type: string format: date readOnly: true example: '2023-01-01' nullable: true employeeContact: type: object description: The contact for the employee. properties: key: type: string description: System generated key for the contact. readOnly: true example: '977' id: type: string description: Unique identifier for the contact. readOnly: true example: John Smith href: type: string example: /objects/company-config/contact/973 readOnly: true readOnly: true item: type: object properties: href: type: string description: Endpoint for the item. readOnly: true example: /objects/inventory-control/item/23 nullable: true key: type: string description: Item key. example: '23' nullable: true id: type: string description: Item ID. example: B002 nullable: true name: type: string description: Item name. readOnly: true example: Monitor-Acer nullable: true pricing: type: object properties: laborPricingMethod: type: string readOnly: true description: How labor for this resource will be priced. example: billingRate enum: - billingRate - costPlusFee laborRate: type: number description: Labor rate for this resource on this project. example: 10 nullable: true expensePricingMethod: type: string readOnly: true description: How expenses will be priced for this project resource.. example: billingRate enum: - billingRate - costPlusFee expenseRate: type: number description: Expense rate. example: 120 nullable: true apPurchasingPricingMethod: type: string readOnly: true description: AP and PO pricing option. example: costPlusFee enum: - costPlusFee apPurchasingRate: type: number description: AP and PO. example: 100 nullable: true project: type: object properties: href: type: string description: Endpoint for the project. readOnly: true example: /objects/projects/project/23 key: type: string description: Project key. example: '23' id: type: string description: Project ID. example: P-0045 name: type: string description: Project name. readOnly: true example: Implementation Project audit: $ref: '#/components/schemas/audit' projects-project-statusRequiredProperties: type: object required: - id projects-project-status: type: object description: >- Project status to track project progress and optionally limit transactions. properties: key: type: string description: >- System-assigned unique key for project status. Use this key to refer to the project status in all operations. readOnly: true example: '1' id: type: string description: >- User-specified name for the project status; used to categorize and report on projects- Same value as `name` example: In Progress description: type: string description: A brief description of the purpose of the project status. example: In progress nullable: true disableTimeSheetEntry: type: boolean description: >- Indicates whether timesheet entries are allowed for projects with this status. example: false default: false disableExpenseEntry: type: boolean description: >- Indicates whether expense entries are allowed for projects with this status. example: false default: false disablePurchasingAPEntry: type: boolean description: >- Indicates whether AP/PO entries are allowed for projects with this status. example: false default: false disableGenerateInvoice: type: boolean description: >- Indicates whether invoices can be generated for projects with this status. example: false default: false status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' href: type: string description: Endpoint for this project status. readOnly: true example: /objects/projects/project-status/1 projects-project-typeRequiredProperties: type: object required: - id projects-project-type: type: object description: Project type for grouping projects for reporting properties: key: type: string description: >- System-assigned unique key for project type. Use this key to refer to the project type in all operations. readOnly: true example: '3' id: type: string description: >- User-specified name for the project type; used to categorize and report on projects- example: Internal href: type: string readOnly: true example: /objects/projects/project-type/3 parent: type: object description: >- The parent project type if you are working with a hierarchy of project types. properties: key: type: string description: System-assigned key for the parent project type. example: '10' nullable: true id: type: string description: Unique identifier (name) of the parent project type. example: Billable nullable: true href: type: string readOnly: true example: /objects/projects/project-type/1 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' projects-taskRequiredProperties: type: object required: - name - project projects-task: type: object description: Information about each task. properties: key: type: string description: >- System-assigned unique key for the task. Use this key to refer to the task in all operations. readOnly: true example: '101' id: type: string description: >- Identifier for the task. Must be unique within the project. 20 characters max. example: 01-010 name: type: string description: Task name. Must be unique within the project. example: Task 1 parent: type: object description: The parent task if this task is the child of another, larger task. properties: key: type: string description: System-assigned key of the parent task. example: '11' nullable: true id: type: string description: Parent task ID. readOnly: true example: Task-11 nullable: true name: type: string readOnly: true description: Name of the parent task. example: Window installation nullable: true href: type: string readOnly: true example: /objects/projects/task/11 project: type: object description: The project that the task is associated with. properties: key: type: string description: System-assigned key of the project. example: '114' id: type: string description: Unique identifier of the project. example: 15-GAR name: type: string description: Project name. readOnly: true example: Parking garage renovation startDate: type: string format: date description: Project begin date. readOnly: true example: '2023-01-01' nullable: true endDate: type: string format: date description: Project end date. readOnly: true example: '2023-04-01' nullable: true href: type: string readOnly: true example: /objects/projects/project/114 customer: type: object description: The customer that this task will be billed to. readOnly: true properties: key: type: string description: System-assigned key of the customer. readOnly: true example: '987' nullable: true id: type: string description: Unique identifier of the customer. readOnly: true example: 38-097 nullable: true name: type: string readOnly: true description: Customer name. example: City Parking nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/customer/987 item: type: object description: >- Work item that this task is assigned to. A task must be assigned to an item for it to be invoiced. properties: key: type: string description: System-assigned key of the item. example: '311' nullable: true id: type: string description: Unique identifier of the item. example: Project Item 1 nullable: true name: type: string readOnly: true description: Item name. example: Extension pack nullable: true href: type: string readOnly: true example: /objects/inventory-control/item/311 planned: type: object description: Planned start and end dates for the task. properties: startDate: format: date type: string description: Planned start date. example: '2023-04-01' nullable: true endDate: format: date type: string description: Planned end date. example: '2023-05-05' nullable: true actual: type: object readOnly: true description: Actual task start and end dates. properties: startDate: format: date type: string readOnly: true description: Actual start date. example: '2023-04-01' nullable: true endDate: format: date type: string readOnly: true description: Actual end date. example: '2023-05-05' nullable: true duration: type: object description: Task-related durations. properties: planned: type: number description: Task planned duration (hours). example: 100 nullable: true plannedBillable: type: number readOnly: true description: Billable task planned duration (hours). example: 10 nullable: true estimated: type: number description: Task estimated duration (hours). example: 100 nullable: true estimatedBillable: type: number readOnly: true description: Billable task estimated duration (hours). example: 10 nullable: true actual: type: number readOnly: true description: Task actual duration (hours). example: 105 nullable: true actualBillable: type: number readOnly: true description: Billable actual duration (hours). example: 15 nullable: true approved: type: number readOnly: true description: Approved duration (hours). example: 100 nullable: true approvedBillable: type: number readOnly: true description: Billable approved duration (hours). example: 15 nullable: true remaining: type: number readOnly: true description: Remaining duration (hours). example: 100 nullable: true percentComplete: type: number readOnly: true description: Calculated percentage of the task that has been completed. example: 0.25 nullable: true observedPercentComplete: type: number readOnly: true description: >- Latest user-entered value of percentage of the task that has been completed. example: 0.3 nullable: true description: type: string description: Task description. example: First task nullable: true isMilestone: type: boolean description: Set to `true` to indicate that the task is a milestone. example: true default: false isUtilized: type: boolean description: >- Set to `true` to mark this task as utilized. A utilized task is one spent making progress on a customer project or internal project. A non-utilized task is one spent not working on a customer project or internal project, for example, time spent filling in an expense report or timesheet. example: true default: false isBillable: type: boolean description: >- Set to `true` to bill the work for the task. Set to `false` to mark the task as non-billable. example: true default: false wbsCode: type: string description: Work breakdown structure code. example: '1' nullable: true priority: type: number description: A numeric value indicating the task priority. example: 2 nullable: true status: type: string description: >- Current status of the task. If the task status is Completed, employees can't enter time for the task on timesheets. enum: - notStarted - planned - inProgress - completed - onHold default: inProgress example: completed timeType: type: object description: >- Time type used when posting labor costs to the general ledger or for tracking and reporting how work time is spent. properties: key: type: string description: System-assigned key of the time type. example: '2' nullable: true id: type: string description: Unique identifier of the time type. Same as name. example: overtime nullable: true href: type: string readOnly: true example: /objects/time/time-type/2 class: type: object description: Class dimension associated with the task. properties: key: type: string description: System-assigned key of the class. example: '19' nullable: true id: type: string description: Class ID. example: DES nullable: true name: type: string readOnly: true description: Class name. example: Design nullable: true href: type: string readOnly: true example: /objects/company-config/class/19 attachment: type: object description: >- Documents associated with the task, such as statements of work, specifications, or agreements. properties: key: type: string description: System-assigned key of the attachment. example: '12' nullable: true id: type: string description: Attachment ID. example: P8-29 nullable: true href: type: string description: Link to the attachment. readOnly: true example: /objects/company-config/attachment/12 dependentOn: type: object description: Task that must be completed before this task can start. properties: key: type: string description: System-assigned key of the task that this task is dependent on. example: '1330' nullable: true id: type: string description: ID of the task that this task is dependent on. readOnly: true example: Task-1330 nullable: true name: type: string readOnly: true description: Name of the task that this task is dependent on. example: Rough framing nullable: true href: type: string readOnly: true description: Link to the task that this task is dependent on. example: /objects/link/1223 productionUnits: type: object description: Production Units properties: estimate: type: number description: Production unit estimate. example: 1200 nullable: true description: type: string description: >- Production unit description, such as "cubic yards" or "window assembly". example: linear feet siding nullable: true root: type: object readOnly: true description: The top-level task that this task descends from. properties: id: type: string readOnly: true description: >- ID of the root task. If the parent is the root, then it's the ID of the parent task. If there is no parent task, then it's the ID of the current task. example: '1334' nullable: true key: type: string readOnly: true description: >- System-assigned key of the root task. If the parent is the root, then it's the key of the parent task. If there is no parent task, then it's the key of the current task. example: '1334' nullable: true name: type: string readOnly: true description: >- Name of the root task. If the parent is the root, then it's the name of the parent task. If there is no parent task, then it's the name of the current task. example: 1295 Maple St home remodel nullable: true href: type: string readOnly: true description: Link to the root task. example: /objects/projects/task/1334 standardTask: type: object readOnly: true description: The standard task that is the template for this task. properties: id: type: string description: Standard task ID. readOnly: true example: ST-13 nullable: true key: type: string readOnly: true description: System-assigned key of the standard task. example: '13' nullable: true name: type: string readOnly: true description: Name of the standard task. example: Rough framing nullable: true href: type: string readOnly: true description: link to the standard task. example: /objects/construction/standard-task/13 href: type: string readOnly: true description: link to the task. example: /objects/projects/task/101 audit: $ref: '#/components/schemas/audit' projects-task-resourceRequiredProperties: type: object required: - project - employee projects-task-resource: type: object description: >- An employee who works on a project task, and the duration of their involvement. properties: key: type: string description: System-assigned unique key for the task resource. readOnly: true example: '23' id: type: string description: This value is the same as the `key` value for this object. readOnly: true example: '23' href: type: string description: Endpoint for the task resource. readOnly: true example: /objects/projects/task-resource/23 planned: type: object description: Task resource planned dates. properties: startDate: type: string description: Planned begin date for this resource on the task. format: date example: '2023-01-01' nullable: true endDate: type: string description: Planned end date for this resource on the task. format: date example: '2023-06-30' nullable: true actual: type: object description: Task resource actual dates. properties: startDate: type: string description: Actual begin date of this resource on the task. format: date readOnly: true example: '2023-01-08' nullable: true endDate: type: string description: Actual end date of this resource on the task. format: date readOnly: true example: '2023-04-01' nullable: true duration: type: object description: Task resource duration in hours properties: planned: type: number description: Planned duration (hours). example: 22 nullable: true estimated: type: number description: Estimated duration (hours). example: 20 nullable: true actual: type: number description: Actual duration (hours). readOnly: true example: 17 nullable: true approved: type: number description: Approved duration (hours). readOnly: true example: 18 nullable: true remaining: type: number description: Remaining estimated duration or planned duration (hours). readOnly: true example: 8 nullable: true percentComplete: type: number description: Calculated estimated percent completed or planned percent completed. readOnly: true example: 50 nullable: true description: type: string description: Description of the task resource. example: Resource of task RR-27-Q5 nullable: true isFullTime: type: boolean description: Set to `true` to mark the resource as fully booked. example: true default: false isSoftBook: type: boolean description: Set to `true` to mark the resource as soft booked. example: true default: false employee: type: object description: The employee resource assigned to the task. properties: href: type: string description: Endpoint for the employee. readOnly: true example: /objects/company-config/employee/23 key: type: string description: Employee key. example: '23' id: type: string description: Employee ID. example: jsmith startDate: type: string format: date readOnly: true example: '2023-04-01' nullable: true endDate: type: string format: date readOnly: true example: '2024-04-01' nullable: true employeeContact: type: object description: The contact for the employee. properties: key: type: string description: System generated key for the contact. readOnly: true example: '977' id: type: string description: Unique identifier for the contact. readOnly: true example: John Smith href: type: string example: /objects/company-config/contact/973 readOnly: true readOnly: true project: type: object description: The project that the task is part of. properties: href: type: string description: Endpoint for the project. readOnly: true example: /objects/projects/project/23 key: type: string description: Project key. example: '23' id: type: string description: Project ID. example: Q-Field name: type: string description: Project name. readOnly: true example: Quantum Field Repair task: type: object description: The task that the resource is assigned to. properties: href: type: string description: Endpoint for the task. readOnly: true example: /objects/projects/task/23 nullable: true key: type: string description: System-assigned key for the task. example: '23' nullable: true id: type: string description: Task identifier. example: RR-27-Q5 nullable: true name: type: string description: Task name. readOnly: true example: Adjust flux capacitor nullable: true isBillable: type: string description: Whether work on this task is billable. example: true readOnly: true nullable: true audit: $ref: '#/components/schemas/audit' company-config-employee-rate: type: object description: List of employee cost rates, including history. properties: key: type: string description: System-assigned key for the employee-rate. readOnly: true example: '23' id: type: string description: Employee rate ID. readOnly: true example: '23' href: type: string description: Endpoint for the employee-rate. readOnly: true example: /objects/projects/employee-rate/23 hourlyRate: type: string description: Hourly rate format: decimal-precision-2 example: '50' annualSalary: type: string description: Annual salary. nullable: true example: '100000' startDate: type: string format: date description: Start date of hourly rate or annual salary. example: '2023-04-01' endDate: type: string format: date description: End date of of hourly rate or annual salary. example: '2023-04-01' employee: type: object readOnly: true properties: id: type: string description: Employee ID. readOnly: true example: '111' key: type: string description: Employee Key example: '1' readOnly: true name: type: string description: Employee name readOnly: true example: John Doe href: type: string description: Endpoint for the emp. readOnly: true example: /objects/company-config/employee/23 audit: $ref: '#/components/schemas/audit' projects-position-skillRequiredProperties: type: object required: - id projects-position-skill: type: object description: List of positions and skills available to assign to employees. properties: key: type: string description: System-assigned key for the position-skill. readOnly: true example: '23' id: type: string description: Name of the position skill. example: null href: type: string description: URL for the position-skill. readOnly: true example: /objects/projects/position-skill/23 description: type: string description: Description. example: null status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' projects-project-billing-templateRequiredProperties: type: object required: - name - description projects-project-billing-template-milestone: type: object description: Project billing template milestone properties: key: type: string description: System-assigned key for the billing template milestone. readOnly: true example: '23' id: type: string description: Billing template milestone ID (same as key). readOnly: true example: '23' percentCompleted: type: string description: Percent completed value when invoicing should occur example: '.5' percentToInvoice: type: string description: >- Percent of the total that will be invoiced when the milestone is reached readOnly: true example: '.5' description: type: string description: Milestone description example: Invoice at 50% nullable: true href: type: string description: Endpoint for the billing template milestone. readOnly: true example: /objects/projects/project-billing-template-milestone/23 projectBillingTemplate: type: object readOnly: true properties: key: type: string description: System-assigned key for the billing-template. readOnly: true example: '23' id: type: string description: Billing template ID. readOnly: true example: '23' href: type: string description: Endpoint for the billing template. readOnly: true example: /objects/projects/project-billing-template/23 projects-project-billing-template: type: object description: Project billing template. properties: key: type: string description: System-assigned key for the project billing template. readOnly: true example: '23' id: type: string description: Billing template ID (same as key). readOnly: true example: '23' href: type: string description: Endpoint for the project billing template. readOnly: true example: /objects/projects/project-billing-template/23 name: type: string description: Unique name of the billing template. example: Project Estimated Hours description: type: string description: Project billing template description. example: Template for billing by estimated project hours nullable: false billingMethod: type: string description: Billing method. example: percentCompleted enum: - percentCompleted - milestone default: percentCompleted calculateOn: type: string description: Calculate on. example: project enum: - project - task default: project basedOn: type: string description: Based on. example: plannedHours enum: - plannedHours - estimatedHours - budgetedHours - observedPercentCompleted default: estimatedHours status: $ref: '#/components/schemas/status' milestones: type: array description: Line items of the billing template. items: $ref: '#/components/schemas/projects-project-billing-template-milestone' purchasing-price-listRequiredProperties: type: object required: - id purchasing-price-list: type: object description: >- Purchasing price lists contain the prices for products or services that you purchase from vendors. properties: key: type: string description: System-assigned key for the purchasing price list. readOnly: true example: '6' id: type: string description: Name or other unique identifier for the purchasing price list. example: Base Price List Purchase href: type: string description: URL for the purchasing price list. readOnly: true example: /objects/purchasing/price-list/6 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' purchasing-price-scheduleRequiredProperties: type: object required: - id purchasing-price-schedule: type: object description: >- Purchasing price schedules are pricing groups that you can assign to one or more customers. properties: key: type: string description: System-assigned key for the purchasing price schedule. readOnly: true example: '3' id: type: string description: Name or other unique identifier for the purchasing price schedule. example: ColtSched21 href: type: string description: URL for the purchasing price schedule. readOnly: true example: /objects/purchasing/price-schedule/3 description: type: string description: Description of the purchasing price schedule. example: Colt Price Schedule 2021 priceList: type: object description: Associated purchasing price list. properties: key: type: string description: System-assigned key for the purchasing price list. id: type: string description: Name or other unique identifier for the purchasing price list. href: type: string description: URL for the purchasing price list. readOnly: true discountPercent: type: string description: >- Discount percentage for all items in the associated price list. A positive value decreases prices; a negative value increases prices. example: '10' status: $ref: '#/components/schemas/status' purchasing-txn-definitionRequiredProperties: type: object required: - id purchasing-txn-definition-additional-gl-detail: type: object description: >- This object holds the GL account mapping for purchasing transaction definitions that are configured to post cost of goods (COGS) adjustments to the General Ledger. The additional GL account detail is relevant when reversing or posting ‘Cost of Goods’ for a purchasing transaction. properties: key: type: string description: >- System-assigned key for the Purchasing transaction definition addtional GL account detail. readOnly: true example: '47' maxLength: 8 id: type: string description: >- System-assigned id for the Purchasing transaction definition addtional GL account detail. readOnly: true example: '47' maxLength: 8 href: type: string description: >- Endpoint for the Purchasing transaction definition addtional GL account detail. readOnly: true example: /objects/purchasing/txn-definition-additional-gl-detail/47 isOffset: type: boolean description: If true, then the GL account will be marked as offset. example: true default: false txnType: type: string description: Indicate whether debit or credit the corresponding GL account. enum: - debit - credit example: debit moduleType: type: string description: Module type. readOnly: true example: subledger enum: - subledger - inventory - additional lineNumber: type: integer description: >- Line number of cogs-gl detail on Purchasing transaction definition. If not provided, the system automatically assigns a unique line number. If the user specifies the lineNumber already used, the application will push set other lines to unique numbers. Once user posts the information system will use the line numbers to post the GL in the order provided. example: 1 maxLength: 8 glAccount: type: object description: >- Set the GL account to which this transaction posts for the specified account mapping (itemGLGroup and warehouse). properties: key: type: string description: System-assigned key for the GL account. example: '384' id: type: string description: User-assigned number for the GL account. example: '1501.04' href: type: string description: Endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/384 location: type: object description: >- Set the default location against which the line item will be recorded. properties: href: type: string description: Endpoint for the location. readOnly: true example: /objects/company-config/location/56 key: type: string description: >- System-assigned unique key for the location. Used to identify the location in URLs or JSON bodies for all operations on the location. example: '56' id: type: string description: Location. example: AZ department: type: object description: >- Set the default department against which the line item will be recorded. properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/29 key: type: string description: Department key example: '29' id: type: string description: Department. example: Sales itemGLGroup: type: object description: >- The Item GL group and Warehouse together form the criteria set for the account mapping. properties: key: type: string description: System-assigned key for the item GL group. example: '88' id: type: string description: Name of the item GL group. example: Computers and parts href: type: string description: Endpoint for the item GL group. readOnly: true example: /objects/inventory-control/item-group/88 warehouse: type: object description: >- The Item GL group and Warehouse together form the criteria set for the account mapping. properties: key: type: string description: System genrated Key of selected warehouse. example: '77' id: type: string description: Unique identifier for the warehouse. example: ARZ href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/77 status: $ref: '#/components/schemas/status' purchasingTxnDefinition: type: object description: Purchasing Transaction Definition properties: key: type: string description: System-assigned key for the Purchasing Transaction Definition. example: '77' maxLength: 8 id: type: string description: ID for the Purchasing Transaction Definition. example: Purchase Quote maxLength: 30 href: type: string description: URL for the Purchasing Transaction Definition. readOnly: true example: /objects/purchasing/txn-definition/77 purchasing-txn-definition-ap-direct-gl-detail: type: object description: >- Account Payable or direct GL account detail for Purchasing transaction. To monitor financials, user can post entries either to the Accounts Payable or directly to the General Ledger for purchase transactions. properties: key: type: string description: >- System-assigned key for the Purchasing transaction definition GL account detail. readOnly: true example: '67' maxLength: 8 id: type: string description: >- System-assigned id for the Purchasing transaction definition GL account detail. readOnly: true example: '67' maxLength: 8 href: type: string description: >- Endpoint for the Purchasing transaction definition GL account detail. readOnly: true example: /objects/purchasing/txn-definition-ap-direct-gl-detail/67 isOffset: type: boolean description: If true then the line is mapked as Offset. example: true default: false txnType: type: string description: Indicate whether debit or credit the corresponding GL account. enum: - debit - credit example: debit moduleType: type: string description: Module type. readOnly: true example: subledger enum: - subledger - inventory - additional lineNumber: type: integer description: >- Line number of AP account detail on Purchasing transaction definition. If not provided, the system automatically assigns a unique line number. If the user specifies the lineNumber already used, the application will push set other lines to unique numbers. Once user posts the information system will use the line numbers to post the GL in the order provided. example: 1 maxLength: 8 glAccount: type: object properties: key: type: string description: System-assigned key for the account. example: '384' id: type: string description: User-assigned number for the account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/384 location: type: object properties: href: type: string description: Endpoint for the location. readOnly: true example: /objects/company-config/location/3345 key: type: string description: >- System-assigned unique key for the location. Used to identify the location in URLs or JSON bodies for all operations on the location. example: '3345' id: type: string description: Unique identifier for the location. example: AZ department: type: object properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/28 key: type: string description: department key example: '28' id: type: string description: Unique identifier for the department. example: Sales itemGLGroup: type: object properties: href: type: string description: Endpoint for the itemglgroup. readOnly: true example: /objects/inventory-control/item-group/13 key: type: string description: System-assigned key for the item GL group. example: '13' id: type: string description: Name or other unique identifier for the item GL group. example: Stockable Kit warehouse: type: object properties: href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/23 key: type: string description: Default warehouse key. example: '23' id: type: string description: Unique identifier for the warehouse. example: ARZ status: $ref: '#/components/schemas/status' purchasingTxnDefinition: type: object description: >- Purchasing Transaction Definition related to AP or direct GL Account mapping. properties: key: type: string description: System-assigned key for the Purchasing Transaction Definition. example: '77' maxLength: 8 id: type: string description: ID for the Purchasing Transaction Definition. example: Purchase Quote maxLength: 30 href: type: string description: URL for the Purchasing Transaction Definition. readOnly: true example: /objects/purchasing/txn-definition/77 purchasing-txn-definition-inventory-total-detail: type: object description: >- Specify the inventory running total that will be affected by the transaction, whether to track the quantity, value, or both, and whether that amount will increase or decrease when the user saves the transaction. properties: key: type: string description: >- System-assigned key for the transaction definition inventory total detail. readOnly: true example: '88' maxLength: 8 id: type: string description: >- System-assigned id for the transaction definition inventory total detail. readOnly: true example: '88' maxLength: 8 href: type: string description: Endpoint for the transaction definition inventory total detail. readOnly: true example: /objects/purchasing/txn-definition-inventory-total-detail/88 maintainType: type: string description: >- Specify whether to track the quantity, value, or both for the specified inventoryTotal. enum: - quantity - value - quantityAndValue example: value operation: type: string description: >- Specify if amount will increase or decrease when user saves the transaction. enum: - add - subtract example: add inventoryTotal: type: object description: >- Specify the inventory total that will be affected by the transaction. properties: key: type: string description: System-assigned key for the inventory-total. example: '45' id: type: string description: Inventory total. example: ONHAND href: type: string description: Endpoint for the invtotal. readOnly: true example: /objects/inventory-control/total/45 purchasingTxnDefinition: type: object description: Purchasing Transaction Definition. properties: key: type: string description: System-assigned key for the Purchasing Transaction Definition. example: '77' maxLength: 8 id: type: string description: ID for the Purchasing Transaction Definition. example: Purchase Quote maxLength: 30 href: type: string description: URL for the Purchasing Transaction Definition. readOnly: true example: /objects/purchasing/txn-definition/77 purchasing-txn-definition-subtotal-detail: type: object description: >- This object provides details about the type of subtotals that are supported by each transaction definition. properties: key: type: string description: >- System-assigned key for the Purchasing transaction definition subtotal detail. readOnly: true example: '23' maxLength: 8 id: type: string description: >- System-assigned id for the Purchasing transaction definition subtotal detail. readOnly: true example: '23' maxLength: 8 href: type: string description: Endpoint for the Purchasing transaction definition subtotal detail. readOnly: true example: /objects/purchasing/txn-definition-subtotal-detail/23 subtotalType: type: string description: Provide subtotalType Options are Discount or Charge example: discount enum: - null - discount - charge nullable: true default: null lineNumber: type: integer description: >- Line number of subtotal on Purchasing transaction definition. If not provided, the system automatically assigns a unique line number. If the user specifies the lineNumber already used, the application will push set other lines to unique numbers. The transaction definition will use the line numbers to display the order of subtotals. example: 1 maxLength: 8 description: type: string description: >- Provide a text description of the subtotal. A unique description is required to create an purchasing transaction definition subtotal detail object. example: Discount maxLength: 100 valueType: type: string description: Value type options are Amount or Percent. example: amount enum: - null - amount - percent nullable: true default: null subtotalValue: type: string format: decimal-precision-2 description: >- Provide a default value for the subtotal. If Value type is Amount, enter the amount of the subtotal. For example, enter 250. If Value type is Percent, enter a percentage as a whole number. For example, enter 10 for 10%. Users can override the default subtotal value in the transaction. example: '10.23' maxLength: 12 isApportioned: type: boolean description: >- If true, then the discount subtotal will be apportioned across all line items in the transaction. example: true default: false glAccount: type: object description: The GL account to which the subtotal will post. properties: key: type: string description: System-assigned key for the general ledger account. example: '5' id: type: string description: User-assigned number for the GL account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/5 offsetGLAccount: type: object description: Select the offset GL account to which the subtotal will post properties: key: type: string description: System-assigned key for the general ledger account. example: '6' id: type: string description: Unique ID for the account. example: '1501.04' href: type: string readOnly: true example: /objects/general-ledger/account/6 txnType: type: string description: Transaction type - debit or credit. enum: - null - debit - credit example: credit nullable: true default: null appliedToLineNumber: type: integer description: >- Specify the subtotal line number to which the subtotal will apply. Sage Intacct treats the initial subtotal line as line number 0. The first defined subtotal from the transaction definition is line number 1, the second defined subtotal is line number 2, and so on. The value of Applied to line is implicitly assumed to be 0. Taxes, all other charges, and discounts are computed at the line level. This field does not apply if enableLineLevelSimpleTax is set to true. example: 1 maxLength: 8 isTax: type: boolean description: >- Set this field to `true` for tax subtotal lines if your organization uses Simple Tax, Advanced Tax, or Avalara AvaTax. When the transaction posts, the tax will post separately based on the items in the transaction. example: true default: false department: type: object description: Select a default department for the subtotal properties: href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/28 key: type: string description: Department key example: '28' id: type: string description: Department. example: SL location: type: object description: Select a default location for the subtotal properties: key: type: string description: System-assigned key for the location. readOnly: true example: '22' id: type: string description: Identifier for the location. readOnly: true example: LOC-22 href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/22 readOnly: true enableAvalaraTax: type: boolean description: >- If set to true then the subtotal line item applies to AvaTax. 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 definition is created readOnly: true properties: href: type: string description: Endpoint for the entity. readOnly: true example: /objects/company-config/entity/3345 key: type: string description: >- System-assigned unique key for the entity. Used to identify the entity in URLs or JSON bodies for all operations involving the entity. readOnly: true example: '3345' id: type: string description: Name of the entity. readOnly: true example: Australia purchasingTxnDefinition: type: object description: Purchasing Transaction Definition properties: key: type: string description: System-assigned key for the Purchasing Transaction Definition. example: '77' maxLength: 8 id: type: string description: ID for the Purchasing Transaction Definition. example: Purchase Quote maxLength: 30 href: type: string description: URL for the Purchasing Transaction Definition. readOnly: true example: /objects/purchasing/txn-definition/77 purchasing-txn-definition-source-document-detail: type: object description: Document conversion detail for a Purchasing transaction properties: key: type: string description: >- System-assigned key for the transaction definition source document detail. readOnly: true example: '23' maxLength: 8 id: type: string description: >- System-assigned id for the transaction definition source document detail. readOnly: true example: '23' maxLength: 8 href: type: string description: Endpoint for the transaction definition source document detail. readOnly: true example: /objects/purchasing/txn-definition-source-document-detail/23 sourceDocument: type: object description: >- Specify the transaction definitions from which this transaction can be converted. For example, a purchase invoice can be converted from a purchase order and a receiver. properties: href: type: string description: Endpoint for the Purchasing transaction definition. readOnly: true example: /objects/purchasing/txn-definition/44 key: type: string description: System-assigned key for the Purchasing transaction definition. example: '44' id: type: string description: System-assigned id for the Purchasing transaction definition. example: Purchase order purchasingTxnDefinition: type: object description: Purchasing Transaction Definition properties: key: type: string description: System-assigned key for the Purchasing Transaction Definition. example: '77' maxLength: 8 id: type: string description: ID for the Purchasing Transaction Definition. example: Purchase Quote maxLength: 30 href: type: string description: URL for the Purchasing Transaction Definition. readOnly: true example: /objects/purchasing/txn-definition/77 purchasing-txn-definition-entity-setting-detail: type: object description: >- This object contains details about which entities can create transactions and also includes settings for each entity, such as numbering sequences and document templates. These details and settings are applicable to transaction definitions that are configured to create transactions at the "Top level or entity" or "Entity only" level. properties: key: type: string description: >- System-assigned key for the Purchasing transaction definition entity detail. readOnly: true example: '23' maxLength: 8 id: type: string description: >- System-assigned id for the Purchasing transaction definition entity detail. readOnly: true example: '23' maxLength: 8 href: type: string description: Endpoint for the Purchasing transaction definition entity detail. readOnly: true example: /objects/purchasing/txn-definition-entity-setting-detail/23 enableNumberingSequence: type: boolean description: If true then enable sequence numbering. example: false default: false preserveNumberingSequence: type: boolean description: >- If true then preserve sequence numbering. Ensures that numbers are never skipped. example: false default: false canInheritSourceDocumentNumber: type: boolean description: >- Inherit source document number. For example, if you convert transfer out TO-001 into a transfer in, the number for the transfer in will be TO-001 if the transfer in is set to inherit the source transaction number. example: false default: false documentTemplate: type: object description: >- Provide printed document template to use as the default for printed output (PDFs) for the corresponding entity. Purchasing transaction definition document template is used if you not provide this field. properties: key: type: string description: The system generated key document template. example: '65' maxLength: 8 id: type: string description: The name of document template. example: Purchasing transfer maxLength: 100 subtotalTemplate: type: object description: >- Specifies the template for populating the transaction subtotals table. properties: href: type: string description: Endpoint for the Purchasing subtotal template. readOnly: true example: /objects/purchasing/subtotal-template/22 key: type: string description: Subtotal template. example: '22' id: type: string description: Name of a Purchasing subtotal template. example: Subtotal template showExpandedTaxDetail: type: boolean description: >- Indicates whether to show expanded tax details in the user interface and in the printed output. For example, you might have State, Territory, Local, and District taxes. If you want the transaction printed output to show all taxes, set this field to true. If you want the printed output to have one tax subtotal, set this field to false. This field is only applicable to companies that use Avalara AvaTax or Advanced Tax and applies only if subtotals are enabled. example: false default: false enableOverrideTax: type: boolean description: >- Indicates whether a user can override whether an item is taxable. This field is only applicable if subtotals are enabled. example: false default: false enableLineLevelSimpleTax: type: boolean description: >- If true, allows the tax rate to be overridden at the line level when using Simple Tax. This field is only applicable if subtotals are enabled. example: false default: false entity: type: object properties: href: type: string description: Endpoint for the entityloc. readOnly: true example: /objects/company-config/entity/48 key: type: string description: >- System-assigned unique key for the entity. Used to identify the entity in URLs or JSON bodies for all operations involving the entity. example: '48' id: type: string description: >- Unique identifier of the entity. 20 characters max. The ID cannot be changed after the entity has been created. example: Lyon documentSequence: type: object description: >- Select the numbering sequence to use to automatically number transactions for the corresponding entity. properties: key: type: string description: Document sequence Key example: '11' href: type: string description: Endpoint for the seqnum. readOnly: true example: /objects/company-config/document-sequence/11 id: type: string description: The ID of the numbering sequence. example: Adjustment Decrease audit: $ref: '#/components/schemas/audit' purchasingTxnDefinition: type: object description: Purchasing Transaction Definition properties: key: type: string description: System-assigned key for the Purchasing Transaction Definition. example: '77' maxLength: 8 id: type: string description: ID for the Purchasing Transaction Definition. example: Purchase Quote maxLength: 30 href: type: string description: URL for the Purchasing Transaction Definition. readOnly: true example: /objects/purchasing/txn-definition/77 purchasing-txn-definition: type: object description: >- A purchasing transaction definition can be a purchase requisition, purchase order, receipt, vendor invoice, or adjustment. properties: key: type: string description: System-assigned key for the purchasing transaction definition. readOnly: true example: '250' maxLength: 8 id: type: string description: The name of the purchasing transaction definition. example: Purchase Order maxLength: 30 href: type: string description: Endpoint for the purchasing transaction definition. readOnly: true example: /objects/purchasing/txn-definition/250 docClass: type: string description: >- Purchasing transaction template type. Template type determines whether certain fields appear on the transaction. example: quote enum: - quote - order - list - invoice - adjustment - other default: quote workflowCategory: type: string description: Workflow category associated with a purchasing transaction. example: quote enum: - quote - order - shipping - invoice - return default: quote disableTax: type: boolean description: Set to `true` to disable tax capture for the transaction. example: false default: false 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 enableOverrideTax: type: boolean description: Indicates whether users can override whether a line item is taxable. example: false default: false enableNumberingSequence: type: boolean description: Set to `true` to enable numbering sequence for the transaction. example: false default: false preserveNumberingSequence: type: boolean description: Set to `true` to preserve sequence numbers. 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 purchase order number. example: false default: false xslTemplate: type: string description: Document template to use for printed output (PDFs). example: Purchasing description: type: string description: Description about purchasing transaction definition. example: Document used for Purchase Return 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' 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 AP subledger. example: toGL enum: - toAP - toGL - noPosting default: noPosting partialConvertMethod: type: string description: >- Specify how the system processes transactions that are partially complete. example: closeTransaction enum: - leaveTransactionOpen - closeOriginalAndCreateBackOrder - closeTransaction default: closeTransaction affectsCost: type: boolean description: >- If `true` the transaction will affect the cost of items(Average, FIFO) in the purchasing documents. This value is evaluated based on Inventory totals(ONHAND, Quantity/Quantity&Value). example: false readOnly: true default: false exchangeRateType: type: object properties: key: type: string description: The ID of the exchange rate type. example: '-1' id: type: string description: The name of exchange rate type. example: Intacct Daily Rate href: type: string description: Endpoint for the exchangeratetype. readOnly: true example: /objects/company-config/exchange-rate-type/-1 overrideExchangeRateType: type: boolean description: >- If set to true can users edit both the 'Exchange rate' and the 'Exchange rate type' fields. example: false default: true showBaseCurrency: type: boolean description: >- Specifies whether the transaction amounts are displayed in both base currency and transaction currency. example: false default: false enableCreditLimitCheck: type: boolean description: >- Specifies whether to enforce customer credit limit restrictions in transactions created from this definition. example: false default: false freezeRecallValue: type: boolean description: Set to `true` to freeze recalled values 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 enableSubtotals: type: boolean description: >- Set to `true` to specify standard subtotals, such as tax or a discount, for the transaction. When you set this field to true, you must add at least one subtotal detail. 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 allowDepartmentOverride: type: boolean description: >- Set to `true` to allow users to override the department set for the transaction. 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 requireSupplyOfPrices: type: boolean description: Set to `true` if a price must be supplied. example: false default: false fixedMessage: type: string description: This message is displayed in the Print/Email document. example: >- For any inquiries or assistance, please contact our customer service. editPolicy: type: string description: >- Sets the edit permission for this transaction type. By default, the user cannot edit the transaction after it is created. example: noEdit enum: - noEdit - beforePrinting - editInDraftOnly - all default: all deletePolicy: type: string description: >- Sets the delete permission for this transaction type. By default, a user cannot delete a transaction after it is created. example: all enum: - noDelete - beforePrinting - all default: all customerVendorEditRule: type: string description: >- Allow users to change the customer in Draft or Pending transactions if the transaction has not been converted to another transaction, the transaction date is in an open period, and the transaction's payment status is not `Paid` or `Partially paid`. By default, the users cannot edit the customer. example: always enum: - null - always - exceptConvertedDocuments - never nullable: true default: null printPayToContact: type: boolean description: >- Set to `true` to show the Pay to contact on printed purchasing transaction definitions. example: false default: false printReturnToContact: type: boolean description: >- Set to `true` to show the Return to contact on printed purchasing transaction definitions. example: false default: false printDeliverToContact: type: boolean description: >- Set to `true` to show the Deliver to contact on printed purchasing transaction definitions. example: false default: false allowEditingPayToContact: type: boolean description: >- If true then allow users to change the Pay-to contact during transaction entry. example: false default: false allowEditingReturnToContact: type: boolean description: >- If true then allow users to change the Return-to contact during transaction entry. example: false default: false allowEditingDeliverToContact: type: boolean description: >- If true then allow users to change the Deliver-to contact during transaction entry. example: false default: false contactOneTitle: type: string description: >- Use this field to change the Pay-to labels on the transaction and on the printed document. example: Pay to default: Pay to contactTwoTitle: type: string description: >- Use this field to change the Return-to labels on the transaction and on the printed document. example: Return to default: Return to contactThreeTitle: type: string description: >- Use this field to change the Deliver-to labels on the transaction and on the printed document. example: Deliver to default: Deliver to enableWarnOnLowQuantity: type: boolean description: >- Indicates whether to alert the user if the quantity needed is greater than the ONHAND total in the selected warehouse. The warning also shows the ONORDER and ONHOLD totals. example: false default: true warehouseSelectionMethod: type: string description: >- Determines how warehouses are presented to the user in the warehouse list in the transaction. example: sortByID enum: - sortByID - sortByName - warehouseWithAvailableInventory - useTheDefaultWarehouse default: sortByID postToGL: type: boolean description: >- If `true` then the Additional GL posting account mapping can be setup for this transaction definition. example: false default: false enableAllocations: type: boolean description: If true then enable `Allocations` in the transaction. example: false default: false documentConversionPolicy: type: string description: >- Specify whether transactions can be converted and added as new, standalone documents, or converted only from previous transactions in the workflow. 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: topLevelOrEntity enum: - topLevelOrEntity - topLevelOnly - entityOnly default: topLevelOrEntity subtotalTemplate: type: object description: >- Specifies the template for populating the transaction subtotals table. properties: key: type: string description: Subtotal template key. example: '120' id: type: string description: Name of a purhcasing subtotal template. example: Subtotal template href: type: string description: Endpoint for the purhcasing subtotal template. readOnly: true example: /objects/purchasing/subtotal-template/120 lineLevelSimpleTax: type: boolean description: If true then enable line-level Simple Tax. example: false default: false enableRetainage: type: boolean description: Set to 'true' to enable retainage. example: false default: false enableAdditionalInformationScope: type: boolean description: >- For companies subscribed to Construction, set to `true` to enable scoping included and excluded work. example: false default: false enableAdditionalInformationSchedule: type: boolean description: >- For companies subscribed to Construction, set to `true` to enable scheduling of work milestones. example: false default: false enableInternalReference: type: boolean description: >- For companies subscribed to Construction, set to `true` to enable identification of the internal resource who authorized the work. example: false default: false enableExternalReference: type: boolean description: >- For companies subscribed to Construction, set to `true` to enable identification of the external resource who authorized the work. example: false default: false enableBond: type: boolean description: >- For companies subscribed to Construction, set to `true` to enable addition of information about performance and payment bonds. example: false default: false documentChangeType: type: string description: >- For companies subscribed to Construction, establish whether document values can be changed and how. example: enableChange nullable: true default: null enum: - null - noChange - enableChange - changeOrder enablePrimaryDocumentWorkflow: type: boolean description: Set to 'true' to enable primary document workflow. example: false default: false increaseOrDecreaseInventory: type: string description: >- Increases or decreases inventory. System will auto assign depending on Inventory totals selected and if its adding quantity/value or decrease the quantity/value. example: increase enum: - increase - decrease default: increase 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: bidsAndQuotes enum: - null - bidsAndQuotes - purchaseOrders - purchaseOrderChangeOrders - purchaseReceivers - purchaseOrderInvoices - purchaseReturns - purchaseCredits - purchaseDebits - purchaseClearingReceivers - subcontractBids - subcontracts - subcontractChangeOrders - subcontractInvoices - internalSupplyRequisitions - purchaseRequisitions - blanketPurchaseOrdersOrVendorContracts - grantRequests - grantAwards nullable: true default: null initialPriceList: type: object description: >- The first price list the system will evaluate when determining a suggested transaction price. properties: key: type: string description: System-assigned key for the purchasing price list. example: '200' id: type: string description: ID for the initial price list. example: Initial Price List href: type: string description: Endpoint for the pricelist. readOnly: true example: /objects/purchasing/price-list/200 documentSequence: type: object description: >- Select the numbering sequence to use to automatically number transactions properties: key: type: string description: Document sequence Key example: '55' id: type: string description: The ID of the numbering sequence. example: Adjustment Decrease href: type: string description: Endpoint for the seqnum. readOnly: true example: /objects/company-config/document-sequence/55 specialPriceList: type: object description: >- When the layered price list feature is active, this signifies that a special price list has higher priority over the Initial price list. properties: key: type: string description: System-assigned key for the special price list. example: '121' id: type: string description: Special price list ID. example: Special price list href: type: string description: Endpoint for the special price list. readOnly: true example: /objects/purchasing/price-list/121 updatePriceList: type: object description: The price list that will be updated when a user saves a transaction. properties: key: type: string description: System-assigned key for the purchasing price list. example: '423' id: type: string description: The name of purchase order price list. example: PO Price List href: type: string description: Endpoint for the purchasing price list. readOnly: true example: /objects/purchasing/price-list/423 apTerm: type: object description: >- Accounts Payable (AP) term, which determines the expiration date for quotes and the due date for invoices. properties: key: type: string description: System-assigned key for the AP term. example: '223' id: type: string description: The name of AP term. example: 10 Days href: type: string description: Endpoint for the term. readOnly: true example: /objects/accounts-payable/term/223 warehouse: type: object description: Default warehouse properties: key: type: string description: Default warehouse key. example: '323' id: type: string description: Unique identifier for the warehouse. example: Warehouse-001 href: type: string description: Endpoint for the warehouse. readOnly: true example: /objects/inventory-control/warehouse/323 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' additionalGLDetail: type: array description: >- When Transaction posting is set to Accounts Payable and Enable additional posting is set to true, specify the GL account details for additional GL account posting. These accounts are used to reverse the previous transaction in the workflow. items: $ref: '#/components/schemas/purchasing-txn-definition-additional-gl-detail' accountPayableOrDirectGLDetail: type: array description: >- When Transaction posting is set to Accounts Payable or General Ledger, specify and define the AP or GL accounts to debit and credit. items: $ref: '#/components/schemas/purchasing-txn-definition-ap-direct-gl-detail' inventoryTotalDetail: type: array description: Inventory total detail for Purchase transaction items: $ref: '#/components/schemas/purchasing-txn-definition-inventory-total-detail' subtotalDetail: type: array description: subtotal detail for Purchasing transaction items: $ref: '#/components/schemas/purchasing-txn-definition-subtotal-detail' sourceDocumentDetail: type: array description: Document conversion detail for a Purchasing transaction items: $ref: '#/components/schemas/purchasing-txn-definition-source-document-detail' entitySettingDetail: type: array description: Entity detail for Purchasing transaction creation items: $ref: '#/components/schemas/purchasing-txn-definition-entity-setting-detail' purchasing-subtotal-templateRequiredProperties: type: object required: - id purchasing-subtotal-template: type: object description: Purchasing Subtotal Template properties: key: type: string description: key readOnly: true id: type: string description: id href: type: string readOnly: true purchasing-documentRequiredProperties: type: object required: - id purchasing-document-line: type: object description: Line items in a purchasing document represent purchasing transactions. properties: key: type: string description: System-assigned key for the purchasing document line item. readOnly: true id: type: string description: ID for the purchasing document line item. readOnly: true href: type: string description: URL for the purchasing document line item. readOnly: true documentType: type: string description: Type of transaction. readOnly: true bundleNumber: type: string description: Bundle number lineNumber: type: integer description: Line number item: type: object description: Item associated with the document line. properties: key: type: string description: System-assigned key for the item. id: type: string description: ID for the item. name: type: string description: Item name readOnly: true description: type: string description: Item description readOnly: true href: type: string description: URL for the item. readOnly: true warehouse: type: object description: Warehouse associated with the document line item. properties: key: type: string description: System-assigned key for the warehouse. id: type: string description: ID for the warehouse. name: type: string description: Warehouse name readOnly: true href: type: string description: URL for the warehouse. readOnly: true memo: type: string description: Memo about the document line item. priceCalculationMemo: type: string description: Memo about price calculation for the document line item. unit: type: string description: Unit associated with this document line item. quantity: type: number description: Quantity associated with this document line item. unitQuantity: type: number description: Unit quantity associated with this document line item. unitPrice: type: number description: Unit price price: type: number description: Price totalPrice: type: number description: Extended price convertedQuantity: type: number description: Quantity converted retailPrice: type: number description: Suggested price state: type: boolean description: State of the document line item. default: true audit: $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' cost: type: number description: Cost associated with the document line item. costMethod: type: string description: Cost method associated with the document line item. discountPercent: type: number description: Discount percentage for the document line item. multiplier: type: number description: Multiplier sourceDocument: type: object description: The source from which the purchasing document line was created. properties: key: type: string description: System-assigned key for the source. id: type: string description: ID for the source. href: type: string description: URL for the source. readOnly: true adjustmentDocument: type: object description: >- Adjustment document associated with the purchasing document line item. properties: key: type: string description: System-assigned key for the adjustment document. lineKey: type: integer description: System-assigned key for the adjustment document entry. href: type: string description: URL for the adjustment document. readOnly: true isPriceProrated: type: boolean description: Indicates whether the price is prorated. deferRevenue: type: string description: Defer revenue discountMemo: type: string description: Discount memo baseCurrency: type: string description: Base currency for the transaction. txnCurrency: type: string description: Currency used for the transaction. priceInTxnCurrency: type: string readOnly: true description: Transaction price exchangeRate: type: object properties: date: type: string description: Date the exchange rate is calculated. id: type: string description: Identifier for the exchange rate type. name: type: string description: Name of the exchange rate type. rate: type: number description: Exchange rate used for the transaction. isBillable: type: boolean description: Indicates whether the transaction is billable. isBilled: type: boolean description: Indicates whether the transaction has been billed. form1099: type: object properties: nameOn1099: type: string description: Name as it should appear on 1099 forms. type: type: string description: Type of form 1099. box: type: string description: Box value of form 1099. taxRate: type: number description: Tax rate for the purchasing document line item. tax: type: string description: Tax taxInTxnCurrency: type: number description: Transaction tax taxableAmount: type: number description: Taxable amount totalAmount: type: number description: Gross amount totalAmountInTxnCurrency: type: number description: Transaction gross amount discount: type: number description: Discount taxOverride: type: boolean description: Tax override (only for Avalara tax) default: false totalAmountConverted: type: number description: Total amount converted totatAmountRemaining: type: number description: Total amount remaining quantityRemaining: type: number description: Quantity remaining convertedPrice: type: number description: Price converted conversionType: type: string description: Conversion type dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: title: location type: object properties: key: type: string description: Location Key example: '22' id: type: string description: Location ID example: LOC-22 name: type: string description: Location name readOnly: true example: California requestedDate: type: string description: Need by date format: date shipByDate: type: string description: Ship by date format: date canCancelAfterDate: type: string description: Cancel after date format: date doNotShipBeforeDate: type: string description: Do Not ship before date format: date doNotShipAfterDate: type: string description: Do not ship after date format: date retainage: type: object properties: percentage: type: number description: Retainage percentage readOnly: true baseAmountRetained: type: number description: Base amount retained readOnly: true txnAmountRetained: type: number description: Transaction amount retained readOnly: true revision: type: object properties: unitQuantity: type: number description: Revised unit quantity quantity: type: number description: Revised quantity unitValue: type: string description: Revised unit value value: type: string description: Revised value valueInTxnCurrency: type: number description: Revised transaction currency price: type: number description: Revised price unitPrice: type: number description: Revised unit price priceInTxnCurrency: type: number description: Revised transaction price draft: type: object properties: unitQuantity: type: number description: Draft unit quantity change quantity: type: number description: Draft quantity change price: type: number description: Draft change price posted: type: object properties: quantity: type: number description: Posted quantity changes price: type: number description: Posted change extended price basePrice: type: number description: Posted change extended base price contacts: type: object properties: deliverTo: type: object description: Deliver to contact properties: key: type: string description: System-assigned key for the contact. id: type: string description: Identifier for the contact. href: type: string description: URL for the contact. readOnly: true deliveryDueDate: type: string description: Promised by date format: date orderConfirmationDate: type: string description: Date confirmed format: date shippedDate: type: string description: Date shipped to supplier partialExempt: type: boolean description: Indicates whether the transaction is partially exempt. default: false priceToleranceVariance: type: number description: Price tolerance variance quantityToleranceVariance: type: number description: Quantity tolerance variance fixedAsset: type: object description: Asset information for the line item. properties: nameOfAcquiredAsset: type: string description: Identified for asset acquisition name. example: ergonomic chair includeTaxInAssetCost: type: boolean description: Indicates whether the line item taxable for asset. readOnly: false example: true documentHeader: type: object description: Header lever details for the document line items. properties: key: type: string description: System-assigned key for the purchasing document. id: type: string description: ID for the purchasing document. documentType: type: string description: Type of the purchasing document. readOnly: true href: type: string description: URL for the purchasing document. readOnly: true purchasing-document: type: object properties: key: type: string description: System-assigned key for the purchasing document. readOnly: true id: type: string description: Unique identifier for the purchasing document. readOnly: true href: type: string description: URL for the purchasing document. readOnly: true documentNumber: type: string description: Number for the purchasing document. sourceDocumentId: type: string description: The source from which the purchasing document was created. state: type: string description: | State of the purchase. **Valid Values** - submitted - approved - partiallyApproved - declined - draft - pending - closed - inProgress - converted - partiallyConverted - convertedByLine - partiallyConvertedByLine - exception enum: - submitted - approved - partiallyApproved - declined - draft - pending - closed - inProgress - converted - partiallyConverted - convertedByLine - partiallyConvertedByLine - exception audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true createdDate: type: string description: Date the purchasing document was created. format: date dueDate: type: string description: Due date for the purchasing document. format: date referenceNumber: type: string description: Reference number for the purchasing document. txnName: type: string description: Type of the associated transaction. txnDefinition: type: object description: Associated transaction definition. properties: key: type: string description: System-assigned key for the transaction. id: type: string description: Identifier for the transaction. documentType: type: string description: Type of transaction. href: type: string description: URL for the transaction. readOnly: true notes: type: string description: Notes about the purchasing document. warehouseLocation: type: string description: Location of the associated warehouse. shippingMethod: type: object description: Shipping method for the order. properties: key: type: string description: System-assigned key for the shipping method. id: type: string description: Identifier for the shipping method. href: type: string description: URL for the shipping method. printedByUser: type: object description: User who printed the document. properties: id: type: string description: Identifier for the user. name: type: string description: User name. contacts: type: object description: Contacts for the order entry document. properties: primary: type: object description: Primary contact properties: key: type: string id: type: string href: type: string readOnly: true shipTo: type: object description: Ship To contact properties: key: type: string id: type: string href: type: string readOnly: true billTo: type: object description: Bill To contact properties: key: type: string id: type: string href: type: string readOnly: true deliverTo: type: object description: Deliver To contact properties: key: type: string id: type: string href: type: string readOnly: true memo: type: string description: Free text printed on document isBackordered: type: boolean description: Back ordered. Is this required for all 3 documents? readOnly: true enum: - true - false default: false subTotal: type: string readOnly: true description: Subtotal total: type: string readOnly: true description: Total baseCurrency: type: string description: Base currency subTotalInTxnCurrency: type: string readOnly: true description: Transaction subtotal totalInTxnCurrency: type: string readOnly: true description: Transaction total txnCurrency: type: string description: Transaction currency exchangeRate: type: object properties: date: type: string description: Exchange rate date format: date id: type: string description: Exchange rate type id name: type: string description: Exchange rate type rate: type: number description: Exchange rate salesContract: type: string description: Sales contract?? Is it a reference to contracts?? usedAsContract: type: string description: Used as contract ??? isSystemGeneratedDocument: type: boolean readOnly: true description: System generated postingDate: type: string format: date description: GL posting date taxsolution: type: object properties: key: type: string description: Tax solution key id: type: string description: Tax solution id href: readOnly: true type: string taxCalculationMethod: type: string description: Tax calculation method nullable: true default: null enum: - null - noTax - simpleTax - advancedTax - avaTax - VAT showMultilineTax: type: boolean requestedDeliveryDate: type: string description: Need by date format: date canCancelAfterDate: type: string description: Cancel After date format: date doNotShipBeforeDate: type: string description: Do not ship before date format: date doNotShipAfterDate: type: string description: Do Not Ship after date format: date retainagePercent: type: number description: Default retainage percent scope: type: string description: Scope ??? inclusions: type: string description: Inclusions exclusions: type: string description: Inclusions terms: type: string description: Terms scheduledStartDate: type: string description: Scheduled start date format: date scheduledCompletionDate: type: string description: Scheduled completion date format: date actualStartDate: type: string description: Actual Start date format: date actualCompletionDate: type: string description: Actual completion date format: date revisedCompletionDate: type: string description: Revised completion date format: date substantialCompletionDate: type: string description: Substantial completion date format: date noticeToProceedDate: type: string description: Notice to proceeed date format: date responseDueDate: type: string description: Response due date format: date executedOnDate: type: string description: Executed on date format: date scheduleImpactNotes: type: string description: Schedule Impact details internalReference: $ref: '#/components/schemas/internal-document-ref' externalReference: $ref: '#/components/schemas/external-document-ref' performanceBond: type: object properties: required: type: boolean description: Is Required? received: type: boolean description: Has been received amount: type: string description: Amount company: type: object properties: key: type: string description: key id: type: string description: id name: type: string description: name paymentBond: type: object properties: required: type: boolean description: Is Required? received: type: boolean description: Has been received amount: type: string description: Amount company: type: object properties: key: type: string description: key id: type: string description: id name: type: string description: name revision: type: object properties: documentHasChanged: type: boolean description: Changes have been applied readOnly: true revisedTotal: type: string description: Revised Total revistedSubTotal: type: string description: Revised Sub Total revisedTotalInTxnCurrency: type: string description: Revised Total in transaction currency revistedSubTotalInTxnCurrency: type: string description: Revised Sub Total in transaction currency changeLogNumber: type: number description: Document change log number enableDocumentChange: type: string description: | Allow changes to document ** Valid values ** - no - yes - changeOrder enum: - 'no' - 'yes' - changeOrder vendor: type: object properties: key: type: string description: Vendor key ??? Is this vendor?? id: type: string description: Vendor Id name: type: string description: Vendor Name href: readOnly: true type: string INVOICERUNKEY: type: integer description: Invoicerunkey ???? deliveryDuedate: type: string format: date description: Promised by date contractStartDate: type: string format: date description: Contract start date contractEndDate: type: string format: date description: Contract end date lines: type: array items: $ref: '#/components/schemas/purchasing-document-line' purchasing-document-lineRequiredProperties: type: object required: - id purchasing-document-subtotal: type: object description: Purchasing document subtotal properties: key: type: string description: System-assigned key for the purchasing-document-subtotal. readOnly: true example: '23' id: type: string description: Purchasing document subtotals ID. readOnly: true example: '23' href: type: string description: URL for the purchasing-document-subtotal. readOnly: true example: /objects/purchasing/document-subtotal/23 description: type: string description: Description. readOnly: true example: This is a description. absoluteValue: type: string description: Value. example: '1' percentValue: type: string description: Percent. example: '1.01' totalPrice: type: string description: Total. readOnly: true example: '1.00' isValueEditable: type: boolean description: Is value editable?. example: false enum: - false - true default: false isPercentEditable: type: boolean description: Is percent editable?. example: false enum: - false - true default: false txnValue: type: string description: Transaction value. example: '1.00' txnTotalAmount: type: string description: Transaction total. example: '1.00' overrideTax: type: boolean description: Override tax. example: false default: false isPartialExempt: type: boolean description: ITC. example: false default: false department: type: object properties: href: type: string description: URL for the department. readOnly: true example: /objects/company-config/department/23 id: type: string example: Apparel key: type: string description: Department. example: '23' location: type: object properties: href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/23 id: type: string example: Wharpley Way key: type: string description: Location. example: '23' systemTaxDetail: type: object properties: key: type: string description: System tax detail key. example: '23' id: type: string description: System tax detail ID. example: '???' txnDefinition: type: object properties: href: type: string description: URL for the purchasing-txn-definition. readOnly: true example: /objects/purchasing/txn-definition/23 key: type: string description: Document template Key. example: '23' id: type: string description: Document template ID. example: Beginning Balance txnDefinitionSubtotal: type: object properties: key: type: string description: Document subtotal number. example: '45' id: type: string description: Document subtotal number. example: '45' document: type: object properties: href: type: string description: URL for the purchasing-document. readOnly: true example: /objects/purchasing/document/23 key: type: string description: Document header number. example: '23' id: type: string example: Purchase Order-PO98375 number: type: string example: PO98375 documentLine: type: object properties: href: type: string description: URL for the purchasing-document-line. readOnly: true example: /objects/purchasing/document-line/23 key: type: string description: Document entry number. example: '23' id: type: string description: Document entry number. example: '23' status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' tax-order-entry-tax-detailRequiredProperties: type: object required: - id tax-order-entry-tax-detail: type: object properties: key: type: string description: System-assigned key for the Order Entry tax detail. example: '3' readOnly: true id: type: string description: Unique identifier of the Order Entry tax detail. example: State Tax Texas href: type: string description: URL of the Order Entry tax detail. example: /objects/tax/order-entry-tax-detail/3 readOnly: true status: $ref: '#/components/schemas/status' description: >- Indicates whether the tax detail is `active` or `inactive`. An `active` tax detail is used to calculate taxes for an order per the tax schedule map. example: inactive default: active taxUniqueId: type: string description: >- A valid identifier for Australia GST, South Africa VAT, or United Kingdom VAT compliance. Valid identifiers are predetermined by internal Sage requirements. example: GB.ECOutput_GB.ExemptGB.VAT taxRate: type: string nullable: true description: | Tax rate. **Valid values** - `standard` - Standard tax rate. - `reduced` - Reduced tax rate. - `exempt` - Exempt from tax rate. - `zero` - Zero tax rate. - `federal` - Federal tax rate. - `provincial` - Provincial tax rate. enum: - null - standard - reduced - exempt - zero - federal - provincial example: exempt amountToTax: type: string nullable: true description: | Amount to include in taxable amount. ** Valid values ** - `fullAmount` - Include the cost from zero up to the maximum taxable amount. - `amountWithinRange` - Include the amount between the minimum and maximum taxable amount. enum: - null - fullAmount - amountWithinRange example: fullAmount description: type: string description: >- The description of the Order Entry tax detail, which appears in the transaction subtotals if configured. example: Standard Rate for AU Import Services taxPercent: type: number description: Tax rate percent. example: 10 taxLimit: type: object properties: minTaxable: type: number example: 10 description: >- Minimum taxable amount. If the amount of a line item is at or below this value, tax is not applied. maxTaxable: type: number example: 2000 description: >- Maximum taxable amount. Tax is applied to line item amounts up to this value, but not over. minTax: type: number description: Minimum tax- example: 10 maxTax: type: number description: Maximum tax- example: 150 reverseCharge: type: boolean description: Reverse charge flag. example: true default: false useExpenseAccount: type: boolean description: Set to `true` to assign taxes to the expense account. example: true default: false isSystemGenerated: type: boolean description: If `true`, this is a system-generated tax detail. example: true default: false readOnly: true accountLabel: type: object description: Account label. properties: id: type: string description: Unique ID for the account label. example: Accounting Fees key: type: string description: System-generated key for the account label. example: '14' href: type: string description: URL of the account label. example: /ojbects/ar-account-label/14 readOnly: true taxAuthority: type: object properties: id: type: string description: >- Unique identifier for the legal tax authority. Useful for creating separate tax reports by jurisdictions. example: California key: type: string description: System-assigned key of the tax authority. example: '24' href: type: string description: URL of the tax authority object. example: /objects/tax/tax-authority/24 readOnly: true salesGLAccount: type: object description: GL account to which this tax is to be assigned. properties: id: type: string description: Unique identifier for the GL account. example: 00.01--Accounts Receivable - a/c label offset key: type: string description: System-assigned key for the GL account. example: '57' href: type: string description: URL of the GL account. example: /objects/general-ledger/account/57 readOnly: true taxSolution: type: object description: >- Different tax solutions are available for different countries. Examples include Australia GST, South Africa VAT, and UK VAT. properties: key: type: string description: System-assigned key for the tax solution. example: '1' id: type: string description: Unique identifier for the tax solution. example: United Kingdom - VAT href: type: string description: URL of the tax solution. example: /objects/tax/tax-authority/1 readOnly: true tax-order-entry-tax-scheduleRequiredProperties: type: object required: - id tax-order-entry-tax-schedule-detail: type: object properties: key: type: string description: System-assigned key of the Order Entry tax schedule detail. example: '7149' readOnly: true id: type: string description: Unique identifier of the Order Entry tax schedule detail. example: '7149' readOnly: true effectiveDate: type: string description: Effective date format: date example: '2022-01-08' href: type: string description: URL of the Order Entry tax schedule. example: /objects/tax/order-entry-tax-schedule-detail/7149 readOnly: true taxSchedule: type: object description: >- Tax schedules identify the tax details that are applied when the schedule is referenced by a tax schedule map. properties: key: type: string description: System-assigned key for the tax schedule. example: '1' readOnly: true id: type: string description: Unique identifier of the tax schedule. example: '1' readOnly: true name: type: string description: Tax Schedule ID. example: TaxSched-00002 href: type: string description: URL of the tax schedule object. readOnly: true example: /objects/tax/order-entry-tax-schedule/1 readOnly: true taxDetail: type: object description: >- Order Entry tax details describe a specific type of tax that applies to lines in Accounts Receivable and Order Entry transactions. 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: Alaska Tax Detail href: type: string description: URL of the tax detail object. readOnly: true example: /objects/tax/order-entry-tax-detail/1 tax-order-entry-tax-schedule: type: object properties: key: type: string description: System-assigned key for the Order Entry tax schedule. example: '7129' readOnly: true id: type: string description: Unique identifier for the Order Entry tax schedule. example: '7129' readOnly: true name: type: string description: Tax Schedule ID. example: TaxSched-00004 href: type: string description: URL of the Order Entry tax schedule. example: /objects/tax/order-entry-tax-schedule/7129 readOnly: true status: $ref: '#/components/schemas/status' description: Indicates whether this tax schedule is `active` or `inactive`. default: active example: inactive description: type: string description: The description of the Order Entry tax schedule. example: Description of the Tax Schedule isSystemGenerated: type: boolean description: If `true`, the tax schedule is a system-generated object. example: true default: false readOnly: true lines: type: array description: Tax Schedule detail. items: $ref: '#/components/schemas/tax-order-entry-tax-schedule-detail' taxSolution: type: object description: >- Different tax solutions are available for different countries. Examples include Australia GST, South Africa VAT, and UK VAT. properties: key: type: string description: System-assigned key for the tax solution. example: '1' id: type: string description: Unique identifier of the tax solution. example: United Kingdom - VAT href: type: string description: URL of the tax solution object. readOnly: true example: /objects/tax/tax-solution/1 tax-purchasing-tax-detailRequiredProperties: type: object required: - id tax-purchasing-tax-detail: type: object properties: key: type: string description: System-assigned key for the Purchasing tax detail. example: '4' readOnly: true id: type: string description: Unique identifier for the Purchasing tax detail. example: State Tax Arkansas href: type: string description: URL of the Purchasing tax detail. example: /objects/tax/purchasing-tax-detail/4 readOnly: true status: $ref: '#/components/schemas/status' description: >- Indicates whether the tax detail is `active` or `inactive`. An `active` tax detail is used to calculate taxes for a purchasing transaction per the tax schedule map. example: inactive default: active taxUniqueId: type: string description: >- A valid identifier for Australia GST, South Africa VAT, or United Kingdom VAT compliance. Valid identifiers are predetermined by internal Sage requirements. example: GB.ECOutput_GB.ExemptGB.VAT taxRate: type: string nullable: true description: | Tax rate. **Valid values** - `standard` - Standard tax rate. - `reduced` - Reduced tax rate. - `exempt` - Exempt from tax rate. - `zero` - Zero tax rate. - `federal` - Federal tax rate. - `provincial` - Provincial tax rate. enum: - null - standard - reduced - exempt - zero - federal - provincial example: exempt amountToTax: type: string nullable: true description: | Amount to include in taxable amount. ** Valid values ** - `fullAmount` - Include the cost from zero up to the maximum taxable amount. - `amountWithinRange` - Include the amount between the minimum and maximum taxable amount. enum: - null - fullAmount - amountWithinRange example: fullAmount description: type: string description: >- The description of the Purchasing tax detail, which appears in the transaction subtotals if configured. example: Standard Rate for UK Import Services taxPercent: type: number description: Tax rate percentage. For example, a value of 5 applies a tax of 5%. example: 10 taxLimit: type: object properties: minTaxable: type: number example: 10 description: >- Minimum taxable amount. If the amount of a line item is at or below this value, tax is not applied. maxTaxable: type: number example: 2000 description: >- Maximum taxable amount. Tax is applied to line item amounts up to this value, but not over. minTax: type: number description: Minimum tax- example: 10 maxTax: type: number description: Maximum tax- example: 150 reverseCharge: type: boolean description: Reverse charge flag. example: true default: false useExpenseAccount: type: boolean description: Set to `true` to assign taxes to the expense account. example: true default: false isSystemGenerated: type: boolean description: If `true`, this is a system-generated tax detail. example: true default: false readOnly: true taxAuthority: type: object properties: id: type: string description: >- Unique identifier for the legal tax authority. Useful for creating separate tax reports by jurisdictions. example: California key: type: string description: System-assigned key for the tax authority. example: '24' href: type: string description: URL of the tax authority object. readOnly: true example: /objects/tax/tax-authority/24 purchaseGLAccount: type: object description: GL account to which this tax is to be assigned. properties: id: type: string description: Unique identifier for the GL account. example: 1200.01--Accounts Receivable - a/c label offset key: type: string description: System-assigned key for the GL account. example: '57' href: type: string description: URL of the GL account. readOnly: true example: /objects/general-ledger/account/57 taxSolution: type: object description: >- Different tax solutions are available for different countries. Examples include Australia GST, South Africa VAT, and UK VAT. properties: key: type: string description: System-assigned key for the tax solution. example: '1' id: type: string description: Unique identifier for the tax solution. example: United Kingdom - VAT href: type: string description: URL of the tax solution. readOnly: true example: /objects/tax/tax-authority/1 tax-purchasing-tax-scheduleRequiredProperties: type: object required: - id tax-purchasing-tax-schedule-detail: type: object properties: key: type: string description: System-assigned key of the Purchasing tax schedule detail. example: '7149' readOnly: true id: type: string description: Unique identifier of the Purchasing tax schedule detail. example: '7149' readOnly: true effectiveDate: type: string description: Effective date format: date example: '2022-01-08' href: type: string description: URL of the Purchasing tax schedule. example: /objects/tax/purchasing-tax-schedule-detail/7149 readOnly: true taxSchedule: type: object description: >- Tax schedules identify the tax details that are applied when the schedule is referenced by a tax schedule map. properties: key: type: string description: System-assigned key for the tax schedule. example: '1' readOnly: true id: type: string description: Unique identifier of the tax schedule. example: '1' readOnly: true name: type: string description: Tax Schedule ID. example: TaxSched-00002 href: type: string description: URL of the tax schedule object. readOnly: true example: /objects/tax/purchasing-tax-schedule/1 readOnly: true taxDetail: type: object description: >- Purchasing tax details describe specific types of taxes that apply to lines in Purchasing transactions. 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: Alaska Tax Detail href: type: string description: URL of the tax detail object. readOnly: true example: /objects/tax/purchasing-tax-detail/1 tax-purchasing-tax-schedule: type: object properties: key: type: string description: System-assigned key for the Purchasing tax schedule. example: '7155' readOnly: true id: type: string description: Unique identifier for the Purchasing tax schedule. example: '7155' readOnly: true name: type: string description: Tax Schedule ID. example: TaxSched-00003 href: type: string description: URL of the Purchasing tax schedule. example: /objects/tax/purchasing-tax-schedule/7155 readOnly: true status: $ref: '#/components/schemas/status' description: Indicates whether the tax schedule is `active` or `inactive`. example: inactive default: active description: type: string description: The description of the Purchasing tax schedule. example: Description of the Tax Schedule isSystemGenerated: type: boolean description: If `true`, the tax schedule is a system-generated object. example: true default: false readOnly: true lines: type: array description: Tax Schedule detail. items: $ref: '#/components/schemas/tax-purchasing-tax-schedule-detail' taxSolution: type: object description: >- Different tax solutions are available for different countries. Examples include Australia GST, South Africa VAT, and UK VAT. properties: key: type: string description: System-assigned key for the tax solution. example: '1' id: type: string description: Unique identifier for the tax solution. example: United Kingdom - VAT href: type: string description: URL of the tax solution object. readOnly: true example: /objects/tax/tax-solution/1 tax-tax-authorityRequiredProperties: type: object required: - id tax-tax-authority: type: object description: Tax authority properties: key: type: string description: System-assigned key for the tax authority. readOnly: true example: '105' id: type: string description: Unique identifier for the tax authority. example: Texas description: type: string description: Description of the tax authority or other additional information. example: Texas tax authority href: type: string description: URL of the tax authority. readOnly: true example: /objects/tax/tax-authority/105 vendorId: type: string description: >- The unique identifier of the vendor to whom you'll pay the taxes collected for this tax authority. example: Vendor_Visa_C parent: type: object description: Parent tax authority. properties: id: type: string example: California key: type: string example: '24' href: type: string readOnly: true example: objects/tax-authority/24 tax-contact-tax-groupRequiredProperties: type: object required: - id tax-contact-tax-group: type: object description: >- Contact tax groups enable taxes to be applied to customers, vendors, and their contacts, according to their jurisdictions. Only applicable with Advanced Tax. properties: key: type: string description: System-assigned key for the Contact Tax Group. readOnly: true example: '23' id: type: string description: Unique identifier of the Contact Tax Group. example: Australian Export Customers href: type: string description: Endpoint for the Contact Tax Group. readOnly: true example: /objects/tax/contact-tax-group/23 name: type: string description: Unique identifier of the Contact Tax Group. example: Australian Export Customers groupType: type: string description: Group type. example: contact default: contact readOnly: true isSystemGenerated: type: boolean description: If `true`, this is a system generated object. example: 'true' default: false readOnly: true taxSolution: type: object description: >- Tax solution associated with this Contact Tax Group. Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK Vat. properties: key: type: string description: System-assigned key for the tax solution. example: '23' href: type: string description: Endpoint for the tax solution. readOnly: true example: /objects/taxsolution/23 id: type: string description: ID for the tax solution. example: Australia - GST audit: $ref: '#/components/schemas/audit' tax-item-tax-groupRequiredProperties: type: object required: - id tax-item-tax-group: type: object description: Item tax groups apply different tax schedules to various items. properties: key: type: string description: System-assigned key for the Item Tax Group. readOnly: true example: '23' id: type: string description: Unique identifier of the Item Tax Group. example: Acme Company Customers href: type: string description: Endpoint for the Item Tax Group. readOnly: true example: /objects/tax/item-tax-group/23 name: type: string description: Unique identifier of the Item Tax Group. example: Acme Company Customers groupType: type: string description: Group type. example: item default: item readOnly: true isSystemGenerated: type: boolean description: If `true`, this is a system generated object. example: 'true' default: false readOnly: true taxSolution: type: object description: >- Tax solution associated with this contact tax group. Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK Vat. properties: key: type: string description: System-assigned key for the tax solution. example: '23' href: type: string description: Endpoint for the tax solution. readOnly: true example: /objects/taxsolution/23 id: type: string description: ID for the tax solution. example: Australia - GST audit: $ref: '#/components/schemas/audit' tax-order-entry-tax-schedule-mapRequiredProperties: type: object required: - taxSchedule - taxSolution - contactTaxGroup - itemTaxGroup - txnDefinition tax-order-entry-tax-schedule-map: type: object properties: key: type: string description: System-assigned key of the Order Entry tax schedule map example: '7149' readOnly: true id: type: string description: Unique identifier of the Order Entry tax schedule map. example: '7149' readOnly: true href: type: string description: URL of the Order Entry tax schedule map. example: /objects/tax/order-entry-tax-schedule-map/7149 readOnly: true isSystemGenerated: type: boolean description: If `true`, this is a system generated object. example: true default: false readOnly: true taxSolution: type: object description: >- Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK VAT. The tax schedule map has to be on the same tax solution as that of tax schedule. properties: key: type: string description: System-assigned key for the tax solution. example: '1' id: type: string description: Unique identifier of the tax solution. example: United Kingdom - VAT href: type: string description: URL of the tax solution object. readOnly: true example: /objects/tax/tax-solution/1 taxSchedule: type: object description: >- Tax schedules identify the tax details that are applied when the schedule is referenced by a tax schedule map. properties: key: type: string description: System-assigned key for the tax schedule. example: '1' id: type: string description: Unique identifier of the tax schedule. example: '1' name: type: string description: Tax Schedule ID. readOnly: true example: TaxSched-00002 href: type: string description: URL of the tax schedule object. readOnly: true example: /objects/tax/order-entry-tax-schedule/1 readOnly: true itemTaxGroup: type: object description: Item tax group properties: key: type: string example: '1' id: type: string description: Unique identifier of the item tax group. example: ABC Tax Group href: type: string description: URL of the item tax group object. readOnly: true example: /objects/tax/item-tax-group/1 contactTaxGroup: type: object description: Contact tax group properties: key: type: string example: '1' id: type: string description: Unique identifier of the contact tax group. example: Auto Contact Tax href: type: string description: URL of the contact tax group object. readOnly: true example: /objects/tax/contact-tax-group/1 txnDefinition: type: object description: Order Entry transaction definition properties: key: type: string example: '1' id: type: string example: Transaction Document href: type: string description: URL of the transaction definition object. readOnly: true example: /objects/order-entry/txn-definition/1 tax-purchasing-tax-schedule-mapRequiredProperties: type: object required: - taxSchedule - taxSolution - contactTaxGroup - itemTaxGroup - txnDefinition tax-purchasing-tax-schedule-map: type: object properties: key: type: string description: System-assigned key of the Purchasing tax schedule map example: '7149' readOnly: true id: type: string description: Unique identifier of the Purchasing tax schedule map. example: '7149' readOnly: true href: type: string description: URL of the Purchasing tax schedule map. example: /objects/tax/purchasing-tax-schedule-map/7149 readOnly: true isSystemGenerated: type: boolean description: If `true`, this is a system generated object. example: true default: false readOnly: true taxSolution: type: object description: >- Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK VAT. The tax schedule map has to be on the same tax solution as that of tax schedule. properties: key: type: string description: System-assigned key for the tax solution. example: '1' id: type: string description: Unique identifier of the tax solution. example: United Kingdom - VAT href: type: string description: URL of the tax solution object. readOnly: true example: /objects/tax/tax-solution/1 taxSchedule: type: object description: >- Tax schedules identify the tax details that are applied when the schedule is referenced by a tax schedule map. properties: key: type: string description: System-assigned key for the tax schedule. example: '1' id: type: string description: Unique identifier of the tax schedule. example: '1' name: type: string description: Tax Schedule ID. readOnly: true example: TaxSched-00002 href: type: string description: URL of the tax schedule object. readOnly: true example: /objects/tax/purchasing-tax-schedule/1 readOnly: true itemTaxGroup: type: object description: Item tax group properties: key: type: string example: '1' id: type: string description: Unique identifier of the item tax group. example: ABC Tax Group href: type: string description: URL of the item tax group object. readOnly: true example: /objects/tax/item-tax-group/1 contactTaxGroup: type: object description: Contact tax group properties: key: type: string example: '1' id: type: string description: Unique identifier of the contact tax group. example: Auto Contact Tax href: type: string description: URL of the contact tax group object. readOnly: true example: /objects/tax/contact-tax-group/1 txnDefinition: type: object description: Purchasing transaction definition properties: key: type: string example: '1' id: type: string example: Transaction Document href: type: string description: URL of the transaction definition object. readOnly: true example: /objects/purchasing/txn-definition/1 tax-tax-returnRequiredProperties: type: object required: - name - taxId - recipientEmail - taxSolution tax-tax-return: type: object description: Tax return properties: key: type: string description: System-assigned unique key for the tax return. readOnly: true example: '61' id: type: string description: >- System-assigned identifier for the tax return. The value is the same as the `key` for this object. example: '61' href: type: string description: Endpoint URL for the tax return. readOnly: true example: /objects/tax/tax-return/61 name: type: string description: Name for the tax return. example: VAT Return Q1 2023 taxId: type: string description: >- Tax ID such as VAT registration number (VRN) or Australian Business Number (ABN) for the tax filing company or entity. example: '4490232727' recipientEmail: type: string description: The email address of the recipient for the tax return. example: john.doe@abcompany.com submissionPeriodStartDate: type: string description: >- The beginning date of the tax reporting period as returned by the government agency when filing. readOnly: true format: date example: '2021-01-23' submissionPeriodEndDate: type: string description: >- The ending date of the tax reporting period as returned by the government agency when filing. readOnly: true format: date example: '2021-01-23' submissionDate: type: string description: The date the tax return was submitted. format: date example: '2021-01-23' submissionType: type: string description: The manner in which the tax return was submitted. readOnly: true example: manual nullable: true default: null enum: - null - manual - electronic submittersEmail: type: string description: The email address of the person who submitted the tax return. example: john.doe@abcompany.com legalCountryCode: type: string description: Country code for the tax return. readOnly: true example: au enum: - au - gb - za - ca setEmailAddressAsDefault: type: boolean description: >- Specifies whether the recipient's email should be used for the next submission for this tax ID. example: true default: true isAdjustingCompleted: type: boolean description: >- Specifies whether the entry in the adjusting journal is completed in Sage Intacct for the tax return. example: true default: false currentStepStage: type: string description: >- Current step in the Sage Intacct process used to submit the tax return. For details about each step, see [Processing steps section](https://www.intacct.com/ia/docs/en_US/help_action/Taxes/Indirect_Tax/VAT_and_GST/Use/Submit_taxes/submit-taxes.htm?#Fielddescriptions). readOnly: true example: submit_to_government currentStepStatus: type: string description: >- Status of the current processing step, see the [Processing steps section](https://www.intacct.com/ia/docs/en_US/help_action/Taxes/Indirect_Tax/VAT_and_GST/Use/Submit_taxes/submit-taxes.htm?#Fielddescriptions) for details. readOnly: true example: completed_successfully bundleNumber: type: string description: >- Number of the bundle the tax return was part of when submitted (for UK only). readOnly: true example: '891204442498' receiptId: type: string description: >- Unique identifier that confirms receipt of the VAT return (for UK only). readOnly: true example: 4c907ee0-a76f-42a7-b582-1a3fb78ae4b8 adjustmentNotes: type: string description: Notes about an adjustment for the tax return. example: VAT return notes taxProcessingSteps: type: array description: Processing steps that have been completed for the tax return. readOnly: true items: type: object properties: stage: type: string example: prepare_tax_data status: type: string example: completed_successfully description: type: string example: 11 records eligible for submission recentActivityDate: type: string example: 03/03/2020 relatedFiles: type: array description: System-generated files related to the tax report. readOnly: true items: type: object properties: fileName: type: string description: Name for the file. example: transactions.json stage: type: string description: The processing step in which the file was generated. example: Prepare source tax data creationDate: type: string description: The date the file was created. format: date example: 03/03/2020 reportingEntity: type: object description: The entity that the tax return is filed under. properties: key: type: string description: System-assigned unique key for the reporting entity. example: '3' id: type: string description: Unique identifier for the reporting entity. example: LOC-USA-0778 href: type: string description: Endpoint URL fot the reporting entity. readOnly: true example: /objects/company-config/entity/3 taxSolution: type: object description: The tax solution used for this tax return. properties: key: type: string description: System-assigned unique key for the tax solution. example: '1' id: type: string description: Unique identifier for the tax solution. example: United Kingdom - VAT href: type: string description: Endpoint URL for the tax solution. readOnly: true example: /objects/tax/tax-solution/1 tax-tax-solutionRequiredProperties: type: object required: - id - status - taxSolutionType - taxCalculationMethod - taxSubmissionStartDate - purchaseGLAccount - salesGLAccount properties: arAdvanceOffsetGLAccount: oneOf: - required: - id - required: - key purchaseGLAccount: oneOf: - required: - id - required: - key salesGLAccount: oneOf: - required: - id - required: - key tax-tax-solution: type: object description: Definition for how taxes should be captured and reported. properties: key: type: string description: System-assigned unique key for the tax solution. readOnly: true example: '200' id: type: string description: Name for the tax solution. example: Australia - GST href: type: string description: URL endpoint for the tax solution. readOnly: true example: /objects/tax/tax-solution/200 description: type: string description: Description of the tax solution. example: Oregon sales tax status: type: string description: Tax solution status. enum: - active - inactive - notConfigured default: active example: active taxSolutionType: type: string description: Tax solution type example: standard enum: - custom - standard enableMultilineTax: type: boolean description: Enable multiple taxes per line. Turning this option on is permanent. example: false default: false taxSubmissionStartDate: type: string format: date description: Start date of first tax submission period example: '2023-01-01' taxCalculationMethod: type: string description: Tax calculation method enum: - noTax - simpleTax - advancedTax - avaTax - VAT example: simpleTax alternativeSetup: type: boolean description: >- Sets where returns to vendors and credits to customers are reported. Only for South Africa VAT. Turning this option on is permanent. example: false default: false lastUpdatedTaxDate: type: string format: date description: Last updated date for all the tax objects for this tax solution example: '2023-01-31' readOnly: true arAdvanceOffsetGLAccount: type: object description: Offset GL account for output taxes on advance. properties: key: type: string description: System-assigned unique key of the offset GL account. example: '23' id: type: string description: Unique ID of the account. example: Automobile Repairs href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/23 purchaseGLAccount: type: object description: >- The default general ledger account to which tax in Accounts Payable and Purchasing will be assigned. properties: key: type: string description: System-assigned unique key of the purchase GL account. example: '12' id: type: string description: Unique ID of the account. example: Automobile Repairs href: type: string description: URL endpoint of the purchase GL account. readOnly: true example: /objects/general-ledger/account/12 salesGLAccount: type: object description: >- The default general ledger account to which tax in Accounts Receivable and Order Entry will be assigned. properties: key: type: string description: System-assigned unique key of the sales GL account. example: '34' id: type: string description: Unique ID of the account. example: Time Type - Coding href: type: string description: URL endpoint of the sales GL account. readOnly: true example: /objects/general-ledger/account/34 tax-order-entry-tax-schedule-detailRequiredProperties: type: object required: - id tax-purchasing-tax-schedule-detailRequiredProperties: type: object required: - id time-timesheetRequiredProperties: type: object required: - beginDate time-timesheet-line: type: object description: >- A single timesheet entry, including customer, project, number of hours, billing rates, and cost rates. properties: key: type: string description: System-assigned unique key for the timesheet entry. readOnly: true example: '1411' id: type: string description: This value is the same as the 'key' value for this object. readOnly: true example: '1411' href: type: string description: Endpoint for the timesheet entry. readOnly: true example: /objects/time/timesheet-line/1411 timesheet: type: object description: The timesheet that the entry belongs to. properties: key: type: string description: The timesheet that the entry belongs to. example: '11' id: type: string description: ID of Timesheet. example: '11' href: type: string description: Endpoint of the timesheet example: /objects/time/timesheet/11 readOnly: true entryDate: type: string format: date description: Date of the timesheet entry. example: '2023-04-01' quantity: type: number description: Number of hours or quantity. example: 6 lineNumber: type: integer description: Line number to add entry to. readOnly: true example: 1 description: type: string description: Description. example: Week of 04/01/23 nullable: true notes: type: string description: Notes example: Talked to client regarding project nullable: true state: type: string description: State readOnly: true example: approved default: draft enum: - submitted - approved - partiallyApproved - declined - draft - saved - readyForApproval timeType: type: object description: Time type properties: key: type: string description: Time type key example: '1' nullable: true id: type: string description: Time type ID. example: Salaries At Root nullable: true href: type: string example: /objects/time/time-type/1 readOnly: true nullable: true isBillable: type: boolean description: Set to 'true' if time can be billed to the customer. example: true default: false isBilled: type: string description: Billed. example: 'false' enum: - 'true' - 'false' - partial default: 'false' readOnly: true statisticalJournal: type: object properties: key: type: string description: Statistical journal key. example: '7483' readOnly: true nullable: true id: type: string description: Statistical journal ID. example: TSSJ readOnly: true nullable: true href: type: string readOnly: true example: /objects/general-ledger/statistical-journal/7483 readOnly: true billableUtilizedGLAccount: type: object properties: key: type: string description: GL Account Key for Billable Utilized entry. readOnly: true example: '8293' nullable: true id: type: string description: GL Account ID for Billable Utilized entry readOnly: true example: '9293' nullable: true href: type: string readOnly: true example: /objects/general-ledger/statistical-account/8293 readOnly: true nonBillableUtilizedGLAccount: type: object properties: key: type: string description: GL Account Key for Non-Billable Utilized entry. readOnly: true example: '8294' nullable: true id: type: string description: GL Account ID for Non-Billable Utilized entry. readOnly: true example: '9294' nullable: true href: type: string readOnly: true example: /objects/general-ledger/statistical-account/8294 readOnly: true billableNonUtilizedGLAccount: type: object properties: key: type: string description: GL Account Key for Billable Non-Utilized entry. readOnly: true example: '8295' nullable: true id: type: string description: GL Account ID for Billable Non-Utilized entry. readOnly: true example: '9295' nullable: true href: type: string readOnly: true example: /objects/general-ledger/statistical-account/8295 readOnly: true nonBillableNonUtilizedGLAccount: type: object properties: key: type: string description: GL Account Key for Non-Billable Non-Utilized entry. readOnly: true example: '8296' nullable: true id: type: string description: GL Account ID for Non-Billable Non-Utilized entry. readOnly: true example: '9296' nullable: true href: type: string readOnly: true example: /objects/general-ledger/statistical-account/8296 readOnly: true hours: type: object properties: billable: type: number description: Billable hours. example: 8 readOnly: true nullable: true nonBillable: type: number description: Non-billable hours. example: 2 readOnly: true nullable: true approved: type: number description: Approved hours. example: 10 readOnly: true nullable: true approvedBillable: type: number description: Approved billable hours. example: 8 readOnly: true nullable: true approvedNonBillable: type: number description: Approved non-billable hours. example: 2 readOnly: true nullable: true utilized: type: number description: Utilized hours. example: 10 readOnly: true nullable: true nonUtilized: type: number description: Non-utilized hours. example: 4 readOnly: true nullable: true approvedUtilized: type: number description: Approved utilized hours example: 3 readOnly: true nullable: true approvedNonUtilized: type: number description: Approved non-utilized hours example: 2 readOnly: true nullable: true readOnly: true externalPayroll: type: object properties: costRate: type: number description: External cost rate example: 1 nullable: true billingRate: type: number description: External billing rate example: 1 nullable: true amount: type: string description: Labor Amount example: '90' format: decimal-precision-2 nullable: true employerTaxes: type: number description: Employer taxes example: 15 nullable: true fringes: type: number description: Fringes example: 10 nullable: true cashFringes: type: number description: Cash fringes example: 2 nullable: true laborClass: type: object description: Labor class used to track the timesheet. properties: key: type: string description: >- System-assigned key for a class dimension associated with the timesheet. readOnly: true example: '15' nullable: true id: type: string description: >- Unique identifier for a class dimension associated with the timesheet. readOnly: true example: LC001 nullable: true name: type: string description: Class name associated with the timesheet. readOnly: true example: Labor Class nullable: true href: type: string readOnly: true example: /objects/construction/labor-class/15 readOnly: true laborShift: type: object description: Labor shift to track the timesheet. properties: key: type: string description: >- System-assigned key for a labor shift associated with the timesheet. readOnly: true example: '18' nullable: true id: type: string description: >- Unique identifier for a labor shift associated with the timesheet. readOnly: true example: LS001 nullable: true name: type: string description: Labor shift associated with the timesheet. readOnly: true example: Labor Shift nullable: true href: type: string readOnly: true example: /objects/construction/labor-shift/18 readOnly: true laborUnion: type: object description: Labor union to track the timesheet. properties: key: type: string description: >- System-assigned key for a labor union associated with the timesheet. readOnly: true example: '20' nullable: true id: type: string description: >- Unique identifier for a labor union associated with the timesheet. readOnly: true example: LU001 nullable: true name: type: string description: Labor union associated with the timesheet. readOnly: true example: Labor Union nullable: true href: type: string readOnly: true example: /objects/construction/labor-union/20 readOnly: true dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object properties: key: type: string description: Location key example: '1' nullable: true id: type: string description: Location example: '1' nullable: true name: readOnly: true type: string description: Location name example: USA nullable: true href: type: string description: Endpoint for the location. readOnly: true example: /objects/company-config/location/1 department: type: object properties: key: type: string description: Department key example: '1' nullable: true id: type: string description: Department example: '1' nullable: true name: type: string description: Department name readOnly: true example: IT nullable: true href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/1 audit: $ref: '#/components/schemas/audit' time-timesheet: type: object description: Header information for timesheets. properties: key: type: string description: System-assigned unique key for the timesheet. readOnly: true example: '23' id: type: string description: This value is same as the key value for this object. readOnly: true example: '23' href: type: string readOnly: true description: Endpoint for the timesheet. example: /objects/time/timesheet/23 beginDate: type: string format: date description: Begin date of the work period. example: '2023-01-01' nullable: false endDate: type: string format: date description: End date. example: '2023-12-31' readOnly: true postingDate: type: string format: date description: GL posting date. example: '2023-01-01' state: type: string description: State. example: submitted default: draft enum: - submitted - approved - partiallyApproved - declined - draft - partiallyDeclined - saved unitOfMeasure: type: string description: Unit of measure. readOnly: true example: Hours hoursInDay: type: number description: Hours in a day. readOnly: true example: 8 description: type: string description: Timesheet description. example: Week of 2023-01-01 calculationMethod: type: string description: Calculation method. example: hourly readOnly: true nullable: true default: null enum: - null - hourly - salary postActualLaborCost: type: boolean description: Post actual labor cost. example: false readOnly: true employee: type: object description: The employee who did the work. properties: key: type: string description: Employee key. example: '973' id: type: string description: Employee ID. example: E-001 href: type: string example: /objects/company-config/employee/973 readOnly: true employeeContact: type: object description: The contact for the employee. properties: key: type: string description: System generated key for the contact. readOnly: true example: '977' id: type: string description: System generated id for the contact. readOnly: true example: John Smith firstName: type: string description: Employee First Name. readOnly: true example: John lastName: type: string description: Employee Last Name. readOnly: true example: Smith href: type: string example: /objects/company-config/contact/973 readOnly: true readOnly: true attachment: type: object description: Supporting document. properties: key: type: string description: Supporting document key. example: '8420' id: type: string description: Supporting document ID. example: Attach-01 href: type: string readOnly: true lines: type: array description: Time entries items: $ref: '#/components/schemas/time-timesheet-line' audit: $ref: '#/components/schemas/audit' time-timesheet.recall-request: description: recall request type: object properties: key: type: string description: Key of the timesheet to recall. nullable: false example: '155096' time-timesheet.recall-response: description: recall response type: object properties: key: type: string description: System-assigned unique key for the timesheet. status: type: string description: recall status example: completed errorDescription: type: string description: Error description nullable: true example: Timesheet 1552 not found. correction: type: string description: Error correction nullable: true errorCode: type: object description: Error code nullable: true time-timesheet-lineRequiredProperties: type: object required: - entryDate - quantity time-timesheet-approval-record: type: object description: Record of employee timesheet approvals. properties: key: type: string description: Timesheet approval record Key readOnly: true example: '23' id: type: string description: Timesheet approval record id readOnly: true example: '23' href: type: string readOnly: true description: Endpoint of the timesheet approval record example: /objects/time/timesheet-approval-record/23 approvalStage: type: integer description: Approval stage example: 1 readOnly: true approvalType: type: string description: Approval type example: Department Approval readOnly: true approvalLevel: type: string description: Approval level example: '2' readOnly: true comments: type: string description: Comments example: Approved by Admin nullable: true readOnly: true recordDate: type: string description: Date when the approval or decline action occurs. format: date example: '2021-01-23' readOnly: true state: type: string description: State example: submitted enum: - submitted - pendingApproval - approved - declined readOnly: true timesheet: type: object description: Timesheet properties: key: type: string description: Timesheet key example: '1' readOnly: true id: type: string description: Timesheet Id. example: '1' readOnly: true href: type: string description: Endpoint of the timesheet example: /objects/time/timesheet/1 readOnly: true readOnly: true timesheetLine: type: object description: Timesheet Line properties: key: type: string description: Timesheet entry key example: '1' readOnly: true id: type: string description: Timesheet entry Id. example: '1' readOnly: true lineNumber: type: integer description: Timesheet entry line number example: 1 readOnly: true href: type: string description: Endpoint of the timesheet line example: /objects/time/timesheet-line/1 readOnly: true readOnly: true approvedBy: type: object properties: key: type: string readOnly: true description: Approved by key example: '2' id: type: string readOnly: true description: Approved by id example: '2' href: type: string readOnly: true description: Endpoint of the approved by user example: /objects/company-config/user/2 readOnly: true approver: type: object properties: key: type: string readOnly: true description: Approver key example: '3' id: type: string readOnly: true description: Approver id example: '3' href: type: string readOnly: true description: Endpoint of the approver user example: /objects/company-config/user/3 readOnly: true completedBy: type: object properties: key: type: string readOnly: true description: Completed by key example: '4' id: type: string readOnly: true description: Completed by ID. example: '4' href: type: string readOnly: true description: Endpoint of the user completed the timesheet approval example: /objects/company-config/user/3 readOnly: true createdBy: type: object properties: key: type: string readOnly: true description: Created by key example: '5' id: type: string readOnly: true description: Created by id example: '5' href: type: string readOnly: true description: Endpoint of the user created the timesheet approval request example: /objects/company-config/user/5 readOnly: true time-typeRequiredProperties: type: object required: - id time-time-type: type: object description: List of time types. properties: key: type: string description: System-assigned key for the time-type. readOnly: true example: '23' id: type: string description: Same as name field. example: Overtime href: type: string description: Endpoint for the time-type. readOnly: true example: /objects/time/time-type/23 earningType: type: object properties: href: type: string description: Endpoint for the earningtype. readOnly: true example: /objects/company-config/earning-type/23 key: type: string description: Earning type key. example: '23' nullable: true id: type: string description: Earning type. example: Salary nullable: true glAccount: type: object properties: href: type: string description: Endpoint for the glaccount. readOnly: true example: /objects/general-ledger/account/12 key: type: string description: Time type GL account key. example: '12' nullable: true id: type: string description: Time type GL account number. example: '5001' nullable: true name: type: string description: Time type GL account name. example: Labor readOnly: true nullable: true offsetGLAccount: type: object properties: href: type: string description: Endpoint for the offsetaccount. readOnly: true example: /objects/general-ledger/account/23 key: type: string description: Time type Offset account key. example: '23' nullable: true id: type: string description: Time type Offset account number. example: '5002' nullable: true name: type: string description: Time type Offset account name. example: Labor Offset readOnly: true nullable: true status: $ref: '#/components/schemas/status' company-config-earning-type: type: object description: Earning types for employee labor costs. properties: key: type: string description: Earning Type Key id: type: string description: Earning Type Name name: type: string description: Earning Type Name audit: $ref: '#/components/schemas/audit' expenses-employee-expenseRequiredProperties: type: object required: - createdDate - employee - lines expenses-employee-expense-line: type: object description: An individual expense on an employee expense report. properties: key: type: string description: System-assigned key for the employee expense line item. readOnly: true example: '312' id: type: string description: Same as key. readOnly: true example: '312' href: type: string readOnly: true description: Endpoint for the employee expense line. example: /objects/expenses/employee-expense-line/312 entryDate: type: string format: date description: Date filed. example: '2021-01-23' nullable: true baseCurrency: type: string description: Base currency of the expense. readOnly: true example: USD baseAmount: type: string description: Amount of the expense in base currency. readOnly: true format: decimal-precision-2 example: '123.45' reimbursementCurrency: type: string description: Reimbursement currency. readOnly: true example: CAD reimbursementAmount: type: string description: Reimbursement amount. readOnly: true format: decimal-precision-2 example: '123.45' txnCurrency: type: string description: Transaction currency. For multi-currency companies. example: INR nullable: true txnAmount: type: string description: Transaction amount. format: decimal-precision-2 example: '123.45' totalSelected: type: string description: Amount selected to pay in transaction currency. readOnly: true format: decimal-precision-2 example: '123.45' totalPaid: type: string description: Amount paid in transaction currency. readOnly: true format: decimal-precision-2 example: '123.45' quantity: type: string description: Quantity for a rate-based expense, for example mileage. format: decimal-precision-2 example: '5.75' nullable: true unitRate: type: string description: Monetary amount for a rate-based expense, for example mileage. format: decimal-precision-2 example: '20.00' nullable: true paidTo: type: string description: Notes regarding to whom the amount was paid. example: Hotel Westin nullable: true paidFor: type: string description: Notes regarding what the expense was for. example: Attending conference nullable: true glAccount: type: object description: >- General ledger account associated with the line item. Used when no expense type is assigned. properties: key: type: string description: System-assigned key for the GL account. example: '158' id: type: string description: User-assigned number for the GL account. example: '6775.30' name: type: string description: Name of the GL account. readOnly: true example: Travel href: type: string description: Endpoint for the GL account object. readOnly: true example: /objects/general-ledger/account/23 expenseType: type: object description: An expense type defined in the company. properties: key: type: string description: System-assigned key for the expense type. example: '6000' id: type: string description: User-assigned label for the expense type. example: Meals href: type: string description: Endpoint for the expense type object. readOnly: true example: /objects/expense-type/34 lineNumber: type: number description: Line number of the employee expense. readOnly: true example: 1 reimburseToBaseConversion: type: object description: Details of reimbursement currency to base currency conversion. readOnly: true properties: exchangeRateDate: type: string format: date description: Date the exchange rate conversion was applied. example: '2021-01-23' readOnly: true exchangeRateTypeId: type: string description: Type of the expense line exchange rate. example: '-1' readOnly: true exchangeRate: type: string description: Value of the expense line exchange rate. readOnly: true format: decimal-precision-5 example: '1.18999' transactionToReimburseConversion: type: object description: Details of the conversion to base currency. properties: exchangeRate: type: string description: Exchange rate for the transaction. format: decimal-precision-5 example: '65.095' nullable: true exchangeRateDate: type: string format: date example: '2021-01-23' description: Date for the exchange rate. nullable: true exchangeRateTypeId: type: string description: Exchange rate type. example: '-1' nullable: true state: type: string description: Status of the employee expense report line. enum: - draft - submitted - partiallyApproved - partiallyDeclined - approved - posted - declined - reversalPending - reversed - reversal - paid - confirmed - voided - partiallyPaid - saved - null default: submitted nullable: true readOnly: true example: draft isBillable: type: boolean default: false description: Indicates whether a line item is billable. example: false isBilled: type: boolean default: false description: Indicates whether a line item is billed. readOnly: true example: false form1099: type: object description: Form 1099 information for the line item. properties: isForm1099: type: string description: If set to true, the line item amount is added to the form 1099. example: 'true' nullable: true type: type: string description: Type of form 1099. example: MISC nullable: true box: type: string description: Box value of form 1099. example: '3' nullable: true paymentType: type: object properties: key: type: string description: System-assigned key for the expense payment type. example: '23' nullable: true id: type: string description: Same as key. example: Non-reimburse nullable: true isNonReimbursable: type: boolean default: false description: Non-reimbursable expense. readOnly: true example: false href: type: string example: /objects/expenses/employee-expense-payment-type/23 readOnly: true audit: $ref: '#/components/schemas/audit' dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object properties: key: type: string description: Location key example: '1' nullable: true id: type: string description: Location example: '1' nullable: true name: readOnly: true type: string description: Location name example: USA nullable: true href: type: string readOnly: true example: /objects/company-config/location/1 department: type: object properties: key: type: string description: Department key example: '1' nullable: true id: type: string description: Department example: '1' nullable: true name: type: string description: Department name readOnly: true example: IT nullable: true href: type: string readOnly: true example: /objects/company-config/department/1 employeeExpense: type: object properties: id: type: string example: '124' key: type: string example: '124' href: type: string readOnly: true description: Endpoint for the employee expense. example: /objects/expenses/employee-expense/124 expenses-employee-expense: type: object description: Expense report for an employee. properties: key: type: string description: >- System-assigned key for the employee expense. Used to identify the employee expense in URLs or JSON bodies for all operations on the employee expense. readOnly: true example: '124' id: type: string description: >- Same as key. API operations should use the key property to refer to employee expenses- readOnly: true example: '124' createdDate: type: string format: date example: '2023-11-11' description: Date the employee expense was created. nullable: false employee: type: object description: Employee that incurred the expense. properties: key: type: string description: System-assigned unique key for the employee. example: '12345' id: type: string description: Unique ID of the employee. example: EMP-025 href: type: string readOnly: true description: Endpoint for the employee. example: /objects/company-config/employee/12345 employeeContact: type: object description: The contact for the employee. properties: key: type: string description: System generated key for the contact. readOnly: true example: '977' id: type: string description: Unique identifier for the contact. readOnly: true example: Thomas, Glenn firstName: type: string description: First name of the employee. readOnly: true example: Glenn lastName: type: string description: Last name of the employee. readOnly: true example: Thomas href: type: string example: /objects/company-config/contact/973 readOnly: true readOnly: true state: type: string description: >- Status of the employee expense. Expenses are posted to the general ledger when approved. enum: - draft - submitted - partiallyApproved - partiallyDeclined - approved - posted - declined - reversalPending - reversed - reversal - paid - confirmed - voided - partiallyPaid default: submitted example: draft basePayment: type: object description: Base payment for the employee expense report. properties: baseCurrency: type: string description: Base currency for the employee expense report. example: USD paidDate: type: string format: date example: '2023-11-12' description: Date the employee expense was fully paid. readOnly: true totalEntered: type: string description: Total transaction amount. format: decimal-precision-2 readOnly: true example: '123.45' totalPaid: type: string description: Total amount paid. format: decimal-precision-2 readOnly: true example: '123.45' totalDue: type: string description: Total amount due. format: decimal-precision-2 readOnly: true example: '123.45' totalSelected: type: string description: Amount selected for reimbursement. format: decimal-precision-2 readOnly: true example: '110.00' reimbursement: type: object description: Reimbursement properties: reimbursementCurrency: type: string description: Reimbursement currency. example: EUR totalEntered: type: string description: Total reimbursable amount. readOnly: true format: decimal-precision-2 example: '123.16' totalPaid: type: string description: Total amount paid. readOnly: true format: decimal-precision-2 example: '123.16' totalDue: type: string description: Total amount due. readOnly: true format: decimal-precision-2 example: '123.16' totalSelected: type: string description: Amount selected for reimbursement. readOnly: true format: decimal-precision-2 example: '123.16' expenseReportNumber: type: string description: Report number associated with the employee expense. example: EXP-00001 expenseSummary: type: object description: Expense summary that this expense is reported on. properties: key: type: string description: System-assigned key for the employee expense summary. example: '334' id: type: string description: Same as key. example: '334' title: type: string description: Title of the expense summary. readOnly: true example: Expenses 2023/01/31 batch postingDate: type: string format: date example: '2021-01-23' description: GL posting date. href: type: string readOnly: true description: Endpoint for the employee expense summary. example: /objects/expenses/employee-expense-summary/12345 nonReimbursable: type: object description: Non-reimbursable portion of the expense. readOnly: true properties: baseTotalEntered: type: string description: Non-reimbursable amount in base currency. readOnly: true format: decimal-precision-2 example: '123.45' reimbursementTotalEntered: type: string description: Total non-reimbursable amount in the reimbursement currency. readOnly: true format: decimal-precision-2 example: '123.45' memo: type: string description: Memo. example: Paid to employee description: type: string description: Reason for the expense. example: Supplies for customer training reclassificationNotes: type: string description: Reason for the reclassification. example: Classified as supplies, not travel expense attachment: type: object description: >- An attachment for employee expenses could be scanned or digital receipts. properties: key: type: string description: System-assigned key for the attachment. example: '1' id: type: string description: Unique ID of the attachment. example: '1' href: type: string description: Endpoint for the attachment. example: /objects/company-config/attachment/12345 readOnly: true audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true lines: type: array description: Line items of the employee expense. items: $ref: '#/components/schemas/expenses-employee-expense-line' expenses-employee-expense-lineRequiredProperties: type: object required: - txnAmount expenses-employeeExpenseSummaryRequiredProperties: type: object required: - name - postingDate expenses-employee-expense-summary: type: object description: Collection of expense transactions, grouped together for processing. properties: key: type: string description: System-assigned key for the employee expense summary. readOnly: true example: '13' id: type: string description: Same as key. readOnly: true example: '13' name: type: string description: Title of the summary. example: Expenses - Expenses (USD) Q3 Batch postingDate: type: string description: GL posting date format: date example: '2021-01-23' totalAmount: type: string description: Total amount of all employee expenses in the summary. example: '100.00' readOnly: true format: decimal-precision-2 nullable: true state: type: string enum: - open - closed description: State of the employee expense summary. example: open default: open recordType: type: string description: Record type enum: - expense - adjustment - reimbursement example: expense readOnly: true summaryCreationType: type: string description: >- If set to manual, then the summary was created by a user and if set to system, then the summary was created by Intacct based on the summary frequency. enum: - system - manual default: manual example: manual readOnly: true bankAccount: type: object description: Bank account. readOnly: true properties: key: type: string description: System-assigned key for the GL account. example: '1' readOnly: true nullable: true id: type: string description: Identifier for the GL account. example: BOA readOnly: true nullable: true href: type: string description: URL for the bankaccount. readOnly: true example: /objects/cash-management/bank-account/1 preventGLPosting: type: boolean description: Not for GL posting example: false default: false readOnly: true href: type: string description: Endpoint for the employee expense summary. readOnly: true example: /objects/expenses/employee-expense-summary/13 status: $ref: '#/components/schemas/status' expenses-employee-expense-typeRequiredProperties: type: object required: - id - description - glAccount expenses-unit-rate: type: object description: unit rate for a specific employee expense type properties: key: type: string description: System-assigned key for the unit-rate. readOnly: true example: '23' id: type: string description: System-assigned id for the unit-rate. readOnly: true example: '23' href: type: string description: Endpoint for the unit-rate. readOnly: true example: /objects/expenses/unit-rate/23 rate: type: string description: Unit rate. format: decimal-precision-4 example: '10' nullable: false startDate: type: string description: Start date. nullable: false example: '2021-01-23' format: date audit: $ref: '#/components/schemas/audit' employeeExpenseType: type: object readOnly: true properties: key: type: string readOnly: true example: '47' id: type: string readOnly: true example: '47' href: type: string description: Endpoint of the employee expense type example: /objects/employee-expense-type/47 readOnly: true expenses-employee-expense-type: type: object description: Information about an employee expense type. properties: key: type: string description: System-assigned key for the employee expense type. readOnly: true example: '47' id: type: string description: >- Name or other unique identifier for the employee expense type. Same as name. example: Travel status: $ref: '#/components/schemas/status' description: type: string description: Description of the employee expense type. example: Non-reimbursable expense for travel glAccount: type: object description: GL account assigned to the employee expense type. properties: key: type: string description: System-assigned key for the GL account. example: '5500' id: type: string description: GL account number. example: Travel expenses name: type: string description: Name of the GL account. readOnly: true example: Automobile expenses href: type: string description: Endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/23 offsetGLAccount: type: object description: >- Offset account assigned to the employee expense type or the default GL account for employee liabilities. properties: key: type: string description: System-assigned key for the offset GL account. nullable: true example: '6000' id: type: string description: Account number of the offset GL account. nullable: true example: Offset travel expenses name: type: string description: Name of the offset GL account. readOnly: true nullable: true example: Automobile expenses - offset href: type: string description: Endpoint for the offset GL account. readOnly: true example: /objects/general-ledger/account/12 item: type: object description: Defined category of expense, such as software, meals or training. properties: key: type: string description: System-assigned key for the item. nullable: true example: '1' id: type: string description: Unique identifier for the item. nullable: true example: '10' name: type: string description: Name of the item. readOnly: true nullable: true example: PC href: type: string description: Endpoint for the item. readOnly: true example: /objects/inventory-control/item/311 unitCurrency: type: string description: >- Currency of the transaction amount for multi-currency companies and rate-based expenses- nullable: true example: USD form1099: type: object description: Form 1099 information for the employee expense type. readOnly: true properties: type: type: string description: Type of form 1099. readOnly: true nullable: true example: MISC box: type: string description: Box value of form 1099. readOnly: true nullable: true example: '3' audit: $ref: '#/components/schemas/audit' unitRates: type: array description: Line items of the employee expense type. items: $ref: '#/components/schemas/expenses-unit-rate' employeeExpensePaymentTypeRequiredProperties: type: object required: - id expenses-employee-expense-payment-type: type: object description: >- User-defined payment type for a line item of an employee expense report or an expense adjustment. properties: key: type: string description: System-assigned key for the employee expense payment type. readOnly: true example: '10' id: type: string description: Employee expense payment type ID. example: Non-reimburse description: type: string description: Description of the employee expense payment type. example: Non-reimbursable payment nullable: true isNonReimbursable: type: boolean default: false description: Non-reimbursable employee expense payment type. example: true offsetGLAccount: type: object description: Offset account assigned to the employee expense payment type. properties: key: type: string description: System-assigned key for the offset GL account. example: '70' nullable: true id: type: string description: Account number of the offset GL account. example: '2420' nullable: true name: type: string description: Name of the offset GL account. readOnly: true example: EE-Office Supplies nullable: true href: type: string description: Endpoint for the offset GL account. readOnly: true example: /objects/general-ledger/account/70 href: type: string description: Endpoint for the offset employee expense payment type. readOnly: true example: /objects/expenses/employee-expense-payment-type/10 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' company-config-employeeRequiredProperties: type: object required: - primaryContact company-config-employee: type: object description: Information about an employee. properties: key: type: string description: System-assigned unique key for the employee. readOnly: true example: '3086' id: type: string description: Unique ID of the employee. example: jsmith name: type: string description: Employee contact name. example: johnsmith startDate: type: string format: date example: '2021-04-30' description: Employment start date. nullable: true jobTitle: type: string description: Job title nullable: true example: VP Sales status: type: string description: Status enum: - active - inactive example: active default: active birthDate: type: string description: Employee date of birth. format: date nullable: true example: '1984-04-13' endDate: type: string description: Employment end date. format: date nullable: true example: '2026-04-30' postActualCostWithVariance: type: boolean description: >- Set to `true` to indicate that the actual cost with variance is posted when earning type is Salary. example: false default: false mergePaymentRequests: type: boolean description: Set to `true` to indicate system can merge payment requests. example: true default: true sendAutomaticPaymentNotification: type: boolean description: >- Set to `true` to indicate system can send automatic payment notifications. example: true default: false manager: type: object description: Manager of the employee. properties: key: type: string nullable: true example: '1' id: type: string nullable: true example: jsmith href: type: string readOnly: true example: /objects/company-config/employee/1 gender: type: string description: Gender enum: - null - female - male nullable: true default: null example: female location: type: object description: >- Employee location. Required only when an employee is created at the top level in a multi-entity, multi-base-currency company. readOnly: true properties: key: type: string nullable: true example: '5' id: type: string nullable: true example: US name: type: string nullable: true readOnly: true example: USA href: type: string readOnly: true example: /objects/company-config/location/1 department: type: object description: Department that the employee is associated with. properties: key: type: string nullable: true example: '1' id: type: string nullable: true example: HR name: type: string readOnly: true nullable: true example: HR href: type: string readOnly: true example: /objects/company-config/department/1 class: type: object description: Class that the employee is associated with. properties: key: type: string nullable: true example: '1' id: type: string nullable: true example: A name: type: string readOnly: true nullable: true example: A href: type: string readOnly: true example: /objects/company-config/class/1 defaultCurrency: nullable: true type: string description: Currency example: USD primaryContact: type: object description: The contact object that represents the employee. properties: key: type: string description: System-assigned unique key of the contact. example: '12345' id: type: string nullable: true example: A name: type: string example: john nullable: true readOnly: true firstName: type: string nullable: true example: john readOnly: true lastName: type: string nullable: true example: smith readOnly: true href: type: string readOnly: true description: Endpoint for the contact. example: /objects/company-config/contact/12345 employeeType: type: object description: employeeType properties: key: type: string nullable: true example: '1' id: type: string nullable: true example: hourly href: type: string readOnly: true example: /objects/company-config/employee-type/1 earningType: type: object description: earningType properties: key: type: string nullable: true example: '1' id: type: string nullable: true example: hourly href: type: string example: /objects/company-config/earning-type/1 SSN: type: string nullable: true description: Employee social security number. Do not include dashes. example: '078051120' employeePosition: type: object description: This is a mapping for position and employee properties: key: type: string nullable: true example: '1' id: type: string nullable: true example: permanent name: type: string nullable: true readOnly: true example: permanent href: type: string readOnly: true example: /objects/company-config/employee-position/1 terminationType: type: string enum: - null - voluntary - involuntary - deceased - disability - retired description: Termination type nullable: true default: null example: voluntary form1099: type: object description: Form 1099 information for employee. properties: name: type: string description: employee name as it appears on the 1099 form. nullable: true example: John Smith type: type: string description: Type of form 1099. nullable: true example: MISC box: type: string description: Box value of form 1099. nullable: true example: '3' ach: type: object description: ACH details properties: enabled: type: boolean description: Enable ACH. example: false bankRoutingNumber: type: string nullable: true description: ACH bank routing number. example: '111111111' accountNumber: type: string nullable: true description: Account number. example: '11111111111' accountType: type: string nullable: true description: Account type. example: checkingAccount enum: - null - checkingAccount - savingsAccount remittanceType: type: string nullable: true description: Account classification. example: personalPPD enum: - null - personalPPD - businessCCD - businessCTX isPlaceholderResource: type: boolean description: Placeholder resource. example: false default: false filePaymentService: type: string nullable: true description: File payment service type. example: ach enum: - null - ach - bankFile - none default: none preferredPaymentMethod: type: string example: cash enum: - null - printedCheck - eft - cash - ach description: Preferred payment method nullable: true default: null attachmentFolder: type: object description: Attachment folder name properties: key: type: string example: '1' id: type: string nullable: true example: test href: type: string example: /objects/company-config/folder/1 employeeRates: type: array description: costRates items: $ref: '#/components/schemas/company-config-employee-rate' positionSkills: description: Array of positions and skills attached to employee object. type: array items: type: object properties: key: type: string example: '7' id: type: string example: Care giver href: type: string description: URL of the position skill example: /objects/projects/position-skill/7 readOnly: true company-config-employee-typeRequiredProperties: type: object required: - id company-config-employee-type: type: object description: Employee type properties: key: type: string description: System-assigned key for the employee type. readOnly: true example: '23' id: type: string description: Unique identifier for the employee type. example: Contractor href: type: string description: URL for the employee-type. readOnly: true example: /objects/company-config/employee-type/23 parent: type: object properties: href: type: string description: URL for the employee-type. readOnly: true example: /objects/company-config/employee-type/7 id: type: string description: Employee type of the parent reference. nullable: true example: Contractor key: type: string description: Employee type key of the parent reference. nullable: true example: '7' form1099: type: object description: Form 1099 information. readOnly: true properties: type: type: string description: Type of form 1099. readOnly: true nullable: true example: MISC box: type: string description: Box value of form 1099. readOnly: true nullable: true example: '3' status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' responses: 400error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error-response' 404error: description: Not Found content: application/json: schema: $ref: '#/components/schemas/error-response' 422error: description: Unprocessable entity content: application/json: schema: $ref: '#/components/schemas/error-response' securitySchemes: OAuth2: description: Sage Intacct OAuth 2.0 authorization code flow type: oauth2 flows: authorizationCode: authorizationUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/authorize tokenUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/token refreshUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/token scopes: {} parameters: name: name: name description: >- Object name, in the form `/`. For custom objects use `platform-apps/nsp::`. in: query schema: type: string required: true example: accounts-payable/vendor documentName: name: documentName in: path required: true schema: type: string description: Document Name OrderEntryDocumentName: name: documentName in: path required: true schema: type: string description: Document name x-tagGroups: - name: Accounts Payable tags: - Accounts_Payable_Payment providers - Accounts_Payable_Payment provider bank accounts - Accounts_Payable_Provider payment methods - Accounts_Payable_Terms - Accounts_Payable_Vendors - Accounts_Payable_Vendor types - Accounts_Payable_Vendor payment providers - Accounts_Payable_Account labels - Accounts_Payable_Adjustments - Accounts_Payable_Adjustment lines - Accounts_Payable_Adjustment summaries - Accounts_Payable_Bills - Accounts_Payable_Bill lines - Accounts_Payable_Bill summaries - Accounts_Payable_Payments - Accounts_Payable_Payment lines - Accounts_Payable_Payment details - Accounts_Payable_Summaries - Accounts_Payable_Recurring bills - Accounts_Payable_Recurring bill lines - Accounts_Payable_Vendor contacts - Accounts_Payable_Vendor email templates - Accounts_Payable_Vendor account groups - Accounts_Payable_Vendor account numbers - Accounts_Payable_Vendor bank file setups - name: Accounts Receivable tags: - Accounts_Receivable_Invoices - Accounts_Receivable_Invoice lines - Accounts_Receivable_Account labels - Accounts_Receivable_Terms - Accounts_Receivable_Customers - Accounts_Receivable_Customer types - Accounts_Receivable_Customer email templates - Accounts_Receivable_Adjustments - Accounts_Receivable_Adjustment lines - Accounts_Receivable_Advances - Accounts_Receivable_Advance lines - Accounts_Receivable_Billback templates - Accounts_Receivable_Billback template lines - Accounts_Receivable_Invoice summaries - Accounts_Receivable_Payments - Accounts_Receivable_Payment lines - Accounts_Receivable_Payment details - Accounts_Receivable_Payment summaries - Accounts_Receivable_Summaries - Accounts_Receivable_Territories - Accounts_Receivable_Territory groups - Accounts_Receivable_Territory group members - Accounts_Receivable_Customer item cross references - Accounts_Receivable_Customer contacts - Accounts_Receivable_Customer account groups - Accounts_Receivable_Recurring invoices - Accounts_Receivable_Recurring invoice lines - Accounts_Receivable_Posted overpayments - Accounts_Receivable_Posted overpayment lines - Accounts_Receivable_Revenue recognition templates - Accounts_Receivable_Revenue recognition template lines - Accounts_Receivable_Revenue recognition template milestones - name: Cash Management tags: - Cash_Management_Financial institutions - Cash_Management_Bank accounts - Cash_Management_Checking accounts - Cash_Management_Deposits - Cash_Management_Deposit lines - Cash_Management_Deposit details - Cash_Management_Other receipts - Cash_Management_Other receipts lines - Cash_Management_Credit card transaction templates - Cash_Management_Credit card transaction line templates - Cash_Management_Journal entry templates - Cash_Management_Journal entry line templates - Cash_Management_Bank transaction rule sets - Cash_Management_Bank transaction rules - Cash_Management_Bank transaction rule filter attributes - Cash_Management_Bank transaction rule group attributes - Cash_Management_Bank transaction rule maps - Cash_Management_Bank transaction rule match attributes - Cash_Management_Deposited funds - Cash_Management_Undeposited funds - name: Company and Configuration tags: - Company_and_Configuration_Attachments - Company_and_Configuration_Attachment folders - Company_and_Configuration_Classes - Company_and_Configuration_Contacts - Company_and_Configuration_Departments - Company_and_Configuration_Entities - Company_and_Configuration_Locations - Company_and_Configuration_Document sequences - Company_and_Configuration_Email templates - Company_and_Configuration_Users - Company_and_Configuration_Roles - Company_and_Configuration_Permissions - Company_and_Configuration_Role permission assignments - name: Construction tags: - Construction_Project change orders - Construction_Change requests - Construction_Change request lines - Construction_Change request types - Construction_Change request statuses - Construction_Project contracts - Construction_Project contract lines - Construction_Project contract line entries - Construction_Project contract types - Construction_project-contract-type - Construction_Project estimates - Construction_Project estimate lines - Construction_Project estimate types - Construction_Standard cost types - Construction_Cost types - Construction_Standard tasks - Construction_Accumulation types - Construction_Employee positions - Construction_Labor classes - Construction_Labor shifts - Construction_Labor unions - Construction_Rate tables - Construction_Rate table accounts payable lines - Construction_Rate table credit card lines - Construction_Rate table employee expense lines - Construction_Rate table journal lines - Construction_Rate table purchasing lines - Construction_Rate table timesheet lines - name: Contracts and Revenue Management tags: - Contracts_and_Revenue_Management_Contracts - Contracts_and_Revenue_Management_Contract lines - Contracts_and_Revenue_Management_Contract types - Contracts_and_Revenue_Management_Contract usage - Contracts_and_Revenue_Management_Billing price lists - Contracts_and_Revenue_Management_Billing price list entries - Contracts_and_Revenue_Management_Billing price list entry lines - Contracts_and_Revenue_Management_Billing price list entry line tiers - Contracts_and_Revenue_Management_Billing schedules - Contracts_and_Revenue_Management_Billing schedule lines - Contracts_and_Revenue_Management_Billing templates - Contracts_and_Revenue_Management_Billing template lines - Contracts_and_Revenue_Management_Contract expenses - Contracts_and_Revenue_Management_Contract expense templates - Contracts_and_Revenue_Management_Contract expense template lines - Contracts_and_Revenue_Management_Contract expense schedules - Contracts_and_Revenue_Management_Contract expense schedule lines - Contracts_and_Revenue_Management_MEA price lists - Contracts_and_Revenue_Management_MEA price list entries - Contracts_and_Revenue_Management_MEA price list entry lines - Contracts_and_Revenue_Management_MEA categories - Contracts_and_Revenue_Management_Revenue templates - Contracts_and_Revenue_Management_Revenue schedules - Contracts_and_Revenue_Management_Revenue schedule lines - name: Core Intacct REST API Services tags: - Core_Intacct_REST_API_Services_Composite requests - Core_Intacct_REST_API_Services_Models - Core_Intacct_REST_API_Services_Query - name: General Ledger tags: - General_Ledger_Accounts - General_Ledger_Statistical accounts - General_Ledger_Account groups - General_Ledger_Account group purposes - General_Ledger_Journals - General_Ledger_Statistical journals - General_Ledger_Journal entries - General_Ledger_Journal entry lines - General_Ledger_Budgets - General_Ledger_Budget details - General_Ledger_Reporting periods - General_Ledger_Transaction allocation templates - General_Ledger_Transaction allocation template lines - General_Ledger_Reports - name: Inventory Control tags: - Inventory_Control_Aisles - Inventory_Control_Bin faces - Inventory_Control_Bin sizes - Inventory_Control_Bins - Inventory_Control_Items - Inventory_Control_Item GL groups - Inventory_Control_Item warehouse inventory information - Inventory_Control_Rows - Inventory_Control_Unit of measure groups - Inventory_Control_Units of measure - Inventory_Control_Warehouses - Inventory_Control_Zones - Inventory_Control_Product lines - Inventory_Control_Item cross references - Inventory_Control_Item landed costs - Inventory_Control_Item vendors - Inventory_Control_Item warehouse standard costs - Inventory_Control_Item warehouse vendors - Inventory_Control_Kit components - Inventory_Control_Lot categories - Inventory_Control_Inventory price lists - Inventory_Control_Inventory price schedules - Inventory_Control_Inventory totals - Inventory_Control_Inventory transaction definitions - Inventory_Control_Inventory transaction definition sources - Inventory_Control_Inventory transaction definition COGS GL details - Inventory_Control_Inventory transaction definition entity details - Inventory_Control_Inventory transaction definition subtotal details - Inventory_Control_Inventory transaction definition total details - Inventory_Control_Warehouse groups - Inventory_Control_Inventory cycles - Inventory_Control_Inventory Control documents - Inventory_Control_Inventory documents - Inventory_Control_Inventory Control document lines - Inventory_Control_Inventory document subtotals - Inventory_Control_Item groups - name: Order Entry tags: - Order_Entry_Price lists - Order_Entry_Documents - Order_Entry_Document lines - Order_Entry_Document line details - Order_Entry_Document subtotals - Order_Entry_Document histories - Order_Entry_Transaction definitions - Order_Entry_Transaction definition additional GL posting account details - Order_Entry_Transaction definition account details - Order_Entry_Transaction definition COGS account details - Order_Entry_Transaction definition entity details - Order_Entry_Transaction definition inventory total details - Order_Entry_Transaction definition document conversion details - Order_Entry_Transaction definition subtotal details - Order_Entry_Billing schedules - Order_Entry_Price schedules - Order_Entry_Renewal templates - Order_Entry_Subtotal templates - name: Project and Resource Management tags: - Project_and_Resource_Management_Projects - Project_and_Resource_Management_Project resources - Project_and_Resource_Management_Project statuses - Project_and_Resource_Management_Project types - Project_and_Resource_Management_Tasks - Project_and_Resource_Management_Task resources - Project_and_Resource_Management_Employee rates - Project_and_Resource_Management_Position skills - Project_and_Resource_Management_Project billing templates - name: Purchasing tags: - Purchasing_Price lists - Purchasing_Price schedules - Purchasing_Purchasing transaction definitions - Purchasing_Subtotal templates - Purchasing_Documents - Purchasing_Document lines - Purchasing_Document subtotals - name: Tax tags: - Tax_Order Entry tax details - Tax_Order Entry tax schedules - Tax_Purchasing tax details - Tax_Purchasing tax schedules - Tax_Tax authorities - Tax_Contact tax groups - Tax_Item tax groups - Tax_Order Entry tax schedule maps - Tax_Purchasing tax schedule maps - Tax_Tax returns - Tax_Tax solutions - Tax_Order Entry tax schedule details - Tax_Purchasing tax schedule details - name: Time and Expenses tags: - Time_and_Expenses_Timesheets - Time_and_Expenses_Timesheet lines - Time_and_Expenses_Timesheet approval records - Time_and_Expenses_Time types - Time_and_Expenses_Earning types - Time_and_Expenses_Employee expenses - Time_and_Expenses_Employee expense lines - Time_and_Expenses_Employee expense summaries - Time_and_Expenses_Employee expense types - Time_and_Expenses_Employee expense payment types - Time_and_Expenses_Unit rates - Time_and_Expenses_Employees - Time_and_Expenses_Employee types