openapi: 3.0.3 info: title: Accounts Receivable description: "Accounts Receivable (AR) is used to manage a full AR cycle, including customers, \nreceivables transactions, and generating reports.\n" version: '1' servers: - url: https://api.intacct.com/ia/api/v1 tags: - name: 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. - name: Adjustments description: >- An adjustment is a transaction that applies a credit or debit in order to modify the amount owed by a customer. - name: Adjustment lines description: >- Line items in an adjustment represent debits or credits to modify the amount owed by a customer. Create and maintain adjustment lines from the owning [adjustment object](/openapi/ar/accounts-receivable.adjustment/tag/Adjustments). - name: Adjustment tax entries description: >- For VAT enabled transactions, an adjustment tax entry provides tax information about the adjustment line item it is associated with. Create and maintain adjustment tax entries from the owning [AR adjustment line](/openapi/ar/accounts-receivable.adjustment-line/tag/Adjustment-lines) object. - name: Advances description: >- Advances record an advance payment from a customer before creating an invoice, for example, when a customer provides a retainer. - name: Advance lines description: >- An advance line item is associated with a particular advance. Each advance can have any number of line items. Create and maintain advance lines from the owning [advance object](/openapi/ar/accounts-receivable.advance/tag/Advances). - name: Bill back 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. - name: Bill back template lines description: >- Line items in a bill back template provide the GL accounts and departments to use for line items in corresponding invoices and bills. Create and maintain bill back template lines from the owning [bill back template object](/openapi/ar/accounts-receivable.billback-template/tag/Bill-back-templates). - name: 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. - name: Customer contacts description: >- Contact information for a customer. Create and maintain customer contacts from the owning [customer object](/openapi/ar/accounts-receivable.customer/tag/Customers). - name: Customer email templates description: >- Customer email templates can be used to standardize messages sent to multiple customers. - name: 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. - name: Customer restricted departments description: >- In shared multi-entity companies, customers can be restricted to specific departments or department groups to prevent the customer from being used in the wrong entity. Create and maintain restricted departments from the owning [customer object](/openapi/ar/accounts-receivable.customer/tag/Customers). - name: Customer restricted locations description: >- In shared multi-entity companies, customers can be restricted to specific locations or location groups to prevent the customer from being used in the wrong entity. Create and maintain restricted locations from the owning [customer object](/openapi/ar/accounts-receivable.customer/tag/Customers). - name: Customer account groups description: Organize customers into account groups to simplify reporting. - name: Customer messages description: >- This object represents a message associated with a customer. The customer message field on invoices that are created for the associated customer are populated with the message contained in this object. A customer is associated with a message using the `customerMessage` property in the [customer](/openapi/ar/accounts-receivable.customer/tag/Customers) object. - name: 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. - name: Customer totals description: Provides information about the total amount due from a customer. - name: Customer groups description: >- A customer group categorizes customer dimension records, mainly for the purpose of structuring financial reporting. - name: Delivery histories description: >- History of invoices delivered to a customer by print or email. Each delivery history object represents a single delivered invoice. - name: Invoices description: >- An invoice object represents an invoice sent to a customer for goods or services provided. - name: Invoice lines description: >- Line items in an invoice represent transactions captured in that invoice. Create and maintain invoice lines from the owning [invoice object](/openapi/ar/accounts-receivable.invoice/tag/Invoices). - name: Invoice tax entries description: >- For VAT enabled transactions, an invoice tax entry provides tax information about the invoice line item it is associated with. Create and maintain adjustment tax entries from the owning [AR invoice line](/openapi/ar/accounts-receivable.invoice-line/tag/Invoice-lines) object. - name: 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. - name: Payments description: >- A payment is a transaction used to record a payment against an invoice or an adjustment/debit memo. For more information, see [Payments from customers](https://www.intacct.com/ia/docs/en_US/help_action/Default.htm#cshid=TOC_payments) in the Sage Intacct Help Center. - name: 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. Create and maintain AR payment details from the owning [payment object](/openapi/ar/accounts-receivable.payment/tag/Payments). - name: Payment lines description: > Line items in an AR payment represent charges for items or services included in an invoice or adjustment. Create and maintain AR payment lines from the owning [payment object](/openapi/ar/accounts-receivable.payment/tag/Payments). - name: 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. - name: Recurring invoices description: >- Recurring invoices are invoices that repeat at periods and durations that you define in the recurrence schedule. - name: Recurring invoice lines description: >- Line items in a recurring invoice represent transactions captured in that recurring invoice. Create and maintain recurring invoice lines from the owning [recurring invoice object](/openapi/ar/accounts-receivable.recurring-invoice/tag/Recurring-invoices). - name: Recurring invoice tax entries description: >- For VAT enabled transactions, an invoice tax entry provides tax information about the invoice line item it is associated with. Create and maintain adjustment tax entries from the owning [AR recurring invoice line](/openapi/ar/accounts-receivable.recurring-invoice-line/tag/Recurring-invoice-lines) object. - name: 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. - name: 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. - name: 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. - name: 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. - name: Shipping methods description: >- A shipping method is a specific way to transport goods, such as UPS or FedEx. - name: Manual deposits description: > Manual deposits can be used to record receipt of money that's not related to an invoice (for example, an over-the-counter cash sale). For more information, see [AR manual deposits](https://www.intacct.com/ia/docs/en_US/help_action/Default.htm#cshid=TOC_ar_deposits) in the Sage Intacct Help Center. - name: Manual deposit lines description: >- Line items in a manual deposit represent payments included in the deposit. Create and maintain AR manual deposit lines from the owning [manual deposit object](/openapi/ar/accounts-receivable.manual-deposit/tag/Manual-deposits). - name: Manual deposit summaries description: >- A manual deposit summary is a collection of payments received from customers, such as quick or manual deposit payments, grouped together for processing. Manual deposit summaries can be either opened or closed. Manual deposits can be added to open summaries. - name: Dunning levels description: "Dunning is the process of communicating with customers to collect overdue balances. Dunning levels define the levels of notices that are sent during the collection process. To learn more, see [Dunning notices](https://www.intacct.com/ia/docs/en_US/help_action/Default.htm#cshid=TOC_dunning_notices) in the Sage Intacct Help Center. \n" - name: Dunning customers description: > Information about a customer receiving a dunning notice. A dunning notice is a notification sent to customers who have overdue invoices. To learn more, see [Dunning notices](https://www.intacct.com/ia/docs/en_US/help_action/Default.htm#cshid=TOC_dunning_notices) in the Sage Intacct Help Center. Create and maintain dunning customers from the owning [dunning notice](accounts-receivable.dunning-notice) object. - name: Dunning invoices description: > Dunning invoices are part of a generated dunning notice when a customer fails to pay an invoice by the due date. To learn more, see [Dunning notices](https://www.intacct.com/ia/docs/en_US/help_action/Default.htm#cshid=TOC_dunning_notices) in the Sage Intacct Help Center. Create and maintain dunning invoices from the owning [dunning customer](accounts-receivable.dunning-customer) object. - name: Dunning notices description: "Dunning is the process of communicating with customers to collect overdue balances. A dunning notice is a notification sent to customers who have overdue invoices. To learn more, see [Dunning notices](https://www.intacct.com/ia/docs/en_US/help_action/Default.htm#cshid=TOC_dunning_notices) in the Sage Intacct Help Center. \n" paths: /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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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. tags: - 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 example: '99' get: summary: Get an account label description: Returns detailed information for a specified AR account label. tags: - 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: '68' id: Wholesale Sales description: Wholesale Sales north America glAccount: id: 000007.10.90--Check_Petty Cash key: '445' href: /objects/general-ledger/account/445 status: active offsetGLAccount: id: 000007.10.90--Check_Petty Cash key: '445' href: /objects/general-ledger/account/445 isTaxable: false isTax: true isSubtotal: true taxGroup: id: Auto Account Label Tax key: '14' href: /objects/tax/account-label-tax-group/14 taxCode: CST deferredRevenueGLAccount: id: 000007.10.90 key: '445' href: /objects/general-ledger/account/445 revenueRecognitionTemplate: id: Straight Line templateTitle: Straight Line key: '28' href: '/objects/accounts-receivable/revenue-recognition-template/28' audit: modifiedDateTime: '2024-08-02T00:00:00Z' createdDateTime: '2024-08-02T00:00:00Z' modifiedBy: '1' createdBy: '1' entity: key: null id: null name: null href: /objects/accounts-receivable/account-label/68 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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. tags: - 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: '68' id: Wholesale Sales href: /objects/accounts-receivable/account-label/68 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an account label description: Deletes an AR account label. tags: - Account labels operationId: delete-accounts-receivable-account-label-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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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. tags: - 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 adjustmentSummary: id: 'AR Summary: 2022/01/01 Batch' 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 example: '99' get: summary: Get an adjustment description: Returns detailed information for a specified adjustment. tags: - 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: '288' key: '288' txnType: ra adjustmentNumber: adj-1 state: posted customer: id: '1' key: '1' name: Power Aerospace Materials totalDue: '-17909.55' href: /objects/accounts-receivable/customer/1 documentNumber: ADJ008567 description: Adjustment 3 createdDate: '2024-09-24' entity: key: '1' id: '1' name: United States of America href: /objects/company-config/entity/1 glPostingDate: '2024-09-24' adjustmentSummary: id: 'AR Summary: 2022/01/01 Batch' key: 280 href: /objects/accounts-receivable/summary/280 baseCurrency: paidDate: '2024-07-19' currency: AUD totalAmountEntered: '-150.00' totalSelected: '0.00' totalPaid: '0.00' totalDue: '-150.00' txnCurrency: currency: AUD totalEntered: '-150.00' totalSelected: '0.00' totalPaid: '0.00' totalDue: '-150.00' exchangeRate: date: '2024-07-17' typeId: Intacct Daily Rate rate: '1' contacts: billTo: id: Power Aerospace Materials(C1) key: '152' href: /objects/company-config/contact/152 shipTo: id: Power Aerospace Materials(C1) key: '152' tax: group: id: null key: null taxId: null href: /objects/company-config/contact/152 moduleKey: 4.AR audit: createdDateTime: '2024-09-24T13:19:27Z' modifiedDateTime: '2024-09-24T14:01:12Z' createdBy: '1' modifiedBy: '1' taxSolution: key: '1' id: Australia - GST href: /objects/tax/tax-solution/1 attachment: id: null key: null lines: - id: '2686' key: '2686' arAdjustment: id: '288' key: '288' href: /objects/accounts-receivable/adjustment/288 glAccount: key: '254' id: '6103' name: Bonuses href: /objects/general-ledger/account/254 accountLabel: key: '35' id: Bonuses href: /objects/accounts-receivable/account-label/35 baseCurrency: amount: '-125' currency: AUD txnCurrency: amount: '-125' currency: AUD dimensions: department: key: null id: null name: null location: key: '4' id: '4' name: Australia href: /objects/company-config/location/4 project: key: null id: null name: null customer: key: '1' id: '1' 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 warehouse: key: null id: null name: null memo: null exchangeRate: date: null typeId: null rate: '1' lineNumber: '1' adjustmentType: ra isTax: false audit: createdDateTime: '2024-09-24T13:19:27Z' modifiedDateTime: '2024-09-24T14:01:12Z' createdBy: '1' modifiedBy: '1' taxEntries: - txnTaxAmount: '-25.00' baseTaxAmount: '-25.00' orderEntryTaxDetail: id: AUS Standard1 key: '89' href: /objects/tax/order-entry-tax-detail/89 id: '2688' key: '2688' taxRate: 20 adjustmentLine: id: '2686' key: '2686' href: '/objects/accounts-receivable/adjustment-line/2686' href: '/objects/accounts-receivable/adjustment-tax-entry/2688' href: /objects/accounts-receivable/adjustment-line/2686 href: /objects/accounts-receivable/adjustment/288 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. tags: - 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. tags: - 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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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 example: '99' get: summary: Get an adjustment line description: Returns detailed information for a specified adjustment line. tags: - 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: '2686' key: '2686' arAdjustment: id: '288' key: '288' href: /objects/accounts-receivable/adjustment/288 glAccount: key: '254' id: '6103' name: Bonuses href: /objects/general-ledger/account/254 accountLabel: key: '35' id: Bonuses href: /objects/accounts-receivable/account-label/35 baseCurrency: amount: '-125.00' currency: AUD txnCurrency: amount: '-125.00' currency: AUD dimensions: department: key: null id: null name: null location: key: '4' id: '4' name: Australia href: /objects/company-config/location/4 project: key: null id: null name: null customer: key: '1' id: '1' 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 warehouse: key: null id: null name: null memo: adjustment one exchangeRate: date: '2024-09-24' typeId: Intacct Daily Rate rate: '1' lineNumber: '1' adjustmentType: ra isTax: false audit: createdDateTime: '2024-09-24T13:19:27Z' modifiedDateTime: '2024-09-24T14:01:12Z' createdBy: '1' modifiedBy: '1' taxEntries: - id: '2688' key: '2688' adjustmentLine: id: '2686' key: '2686' href: /objects/accounts-receivable/adjustment-line/2686 baseTaxAmount: '-25.00' txnTaxAmount: '-25.00' taxRate: 20 orderEntryTaxDetail: id: AUS Standard1 key: '89' href: /objects/tax/order-entry-tax-detail/89 href: '/objects/accounts-receivable/adjustment-tax-entry/2688' href: /objects/accounts-receivable/adjustment-line/2686 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/adjustment-tax-entry: get: summary: List adjustment tax entries description: >- Returns a collection with a key, ID, and link for each adjustment tax entry. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Adjustment tax entries operationId: list-accounts-receivable-adjustment-tax-entry responses: '200': description: OK content: application/json: schema: type: object title: List of adjustment tax entry objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List adjustment tax entries: value: ia::result: - key: '8' id: '8' href: /objects/accounts-receivable/adjustment-tax-entry/8 - key: '9' id: '9' href: /objects/accounts-receivable/adjustment-tax-entry/9 - key: '10' id: '10' href: /objects/accounts-receivable/adjustment-tax-entry/10 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/adjustment-tax-entry/{key}: parameters: - name: key description: System-assigned unique key for the adjustment tax entry. in: path required: true schema: type: string example: '33' get: summary: Get an adjustment tax entry description: Returns detailed information for a specified adjustment tax entry. tags: - Adjustment tax entries operationId: get-accounts-receivable-adjustment-tax-entry-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the adjustment tax entry properties: ia::result: $ref: '#/components/schemas/accounts-receivable-adjustment-tax-entry' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an adjustment tax entry: value: ia::result: id: '2688' key: '2688' adjustmentLine: id: '2686' key: '2686' href: /objects/accounts-receivable/adjustment-line/2686 baseTaxAmount: '-25.00' txnTaxAmount: '-25.00' taxRate: 20 orderEntryTaxDetail: id: AUS Standard1 key: '89' href: /objects/tax/order-entry-tax-detail/89 href: /objects/accounts-receivable/adjustment-tax-entry/2688 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. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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 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.\nIf Accounts Receivable automatic summaries are enabled, you must include either a `financialEntity` in `paymentInformation` or a `glAccount` with an `undepositedGLAccountNumber` to successfully create an advance. \nIf the Accounts Receivable application is configured to Enable Account Labels, you must include an `accountLabel` in the items array to create an advance.\n" tags: - 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: Create an advance: value: customer: id: C-00019 paymentInformation: paymentDate: '2024-06-13' receiptDate: '2024-06-13' paymentMethod: printedCheck financialEntity: id: BOA advanceSummary: id: '511' items: - glAccount: id: '2200' accountLabel: id: Travel txnAmount: '500' dimensions: location: id: CA 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: Reference to 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 example: '757' schema: type: string get: summary: Get an advance description: Returns detailed information for a specified advance. tags: - 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: Get an advance: value: ia::result: id: '1169' key: '1169' advanceSummary: id: '300' key: '300' href: /objects/accounts-receivable/summary/300 paymentInformation: financialEntity: id: SBME paymentMethod: cash currency: baseCurrency: USD txnCurrency: USD exchangeRateDate: '2024-01-10' exchangeRateTypeId: Standard rate exchangeRate: 1 receiptDate: '2024-06-13' paymentDate: '2024-06-13' totalSelected: '0.00' txnTotalSelected: '0.00' totalPaid: '0.00' txnTotalPaid: '0.00' totalDue: '10.00' totalTxnAmountDue: '10.00' glAccount: undepositedGLAccountNumber: '1070' customer: id: Cust_ForInvoice_0021 name: Cust_ForInvoice_0021 referenceNumber: Number10 description: Advance 10 advanceNumber: Advance-001 recordType: rr state: posted totalEntered: '10.00' txnTotalEntered: '10.00' audit: createdDateTime: '2024-06-13T00:00:00Z' modifiedDateTime: '2024-06-26T05:51:05Z' createdByUser: key: '1' href: /objects/company-config/user/1 createdBy: '1' modifiedByUser: key: '1' href: /objects/company-config/user/1 modifiedBy: '1' createdDate: '2024-06-13' reconciliationGroup: cleared: 'false' clearingDate: '2024-06-13' isSystemGenerated: false attachment: id: '10' deposit: id: '234' key: '234' items: - id: '2596' key: '2596' arAdvance: id: '1169' key: '1169' recordType: rr href: /objects/accounts-receivable/advance/1169 glAccount: key: '259' id: '6254' name: Travel href: /objects/general-ledger/account/259 accountLabel: name: Travel id: '10' baseAmount: '10.00' txnAmount: '10.00' dimensions: department: key: '14' id: '77' name: Quality Assurance href: /objects/company-config/department/14 location: key: '42' id: WDH name: West Delhi href: /objects/company-config/location/42 project: key: null id: null name: 'null' nsp::jurisdiction: key: null baseLocation: name: West Delhi key: '42' href: /objects/company-config/location/42 memo: 'null' currency: exchangeRate: date: '2024-06-13' typeId: 'null' rate: 1 baseCurrency: USD txnCurrency: USD lineNumber: 1 paymentInformation: totalPaid: '0.00' txnTotalPaid: '0.00' totalSelected: '0.00' txnTotalSelected: '0.00' audit: createdDateTime: '2024-06-26T05:51:05Z' modifiedDateTime: '2024-06-26T05:51:05Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/advance-line/2596" href: /objects/accounts-receivable/advance/1169 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. Advances that have not yet been applied to an invoice can be updated. The General Ledger account book for the advance must also be open. If an advance was applied to an invoice and later unapplied, it cannot be updated. tags: - 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 state: readOnly: true examples: Update 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: Reference to 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: [] delete: summary: Delete an advance description: Deletes an advance. tags: - Advances operationId: delete-accounts-receivable-advance-key responses: '204': description: No Content '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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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. example: '41' in: path required: true schema: type: string get: summary: Get an advance line description: Returns detailed information for a specified advance line. tags: - 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: westsa baseAmount: '100.00' txnAmount: '100.00' dimensions: 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 project: key: null id: null name: null contract: key: null id: null name: null customer: key: '36' id: C-00045 name: Metro Artic, Inc. href: /objects/accounts-receivable/customer/36 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 baseLocation: id: United States of America key: '1' href: /objects/company-config/location/1 memo: New contract down payment currency: exchangeRate: date: '2024-04-25' typeId: '-1' rate: 0.04937 baseCurrency: USD txnCurrency: USD lineNumber: 1 paymentInformation: totalPaid: '100.00' txnTotalPaid: '100.00' totalSelected: '100.00' txnTotalSelected: '100.00' audit: createdDateTime: '2024-06-13T06:42:36Z' modifiedDateTime: '2024-06-13T07:31:51Z' createdByUser: key: '1' href: /objects/company-config/user/1 createdBy: '1' modifiedByUser: key: '1' href: /objects/company-config/user/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 bill back templates description: >- Returns a collection with a key, ID, and link for each bill back template. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Bill back 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 bill back templates: value: ia::result: - key: '11' id: BBT-AU2I href: /objects/accounts-receivable/billback-template/11 - key: '14' id: BBT-AU2US href: /objects/accounts-receivable/billback-template/14 - key: '25' id: BBT-FR2US 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 bill back template description: >- Creates a new bill back template. Several configuration steps must be completed before creating bill back templates. For more information, see [Set up inter-entity bill back](https://www.intacct.com/ia/docs/en_US/help_action/Default.htm#cshid=Set_up_bill_back) in the Sage Intacct Help Center. tags: - Bill back 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: Create a bill back template: value: id: BBT-FR2US description: BBT France to US enableInterEntityPostings: true lines: - invoiceGLAccount: key: '194' billGLAccount: key: '109' department: key: '9' memo: For France 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: Reference to new bill back template: value: ia::result: key: '26' id: BBT-FR2US 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 unique key for the bill back template. example: '17' in: path required: true schema: type: string get: summary: Get a bill back template description: Returns detailed information for a specified bill back template. tags: - Bill back 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: Get a bill back template: value: ia::result: key: '26' id: BBT-FR2US description: BBT France to US status: active enableInterEntityPostings: true entity: key: null id: null name: null lines: - key: '1' id: '1' billbackTemplate: id: BBT-FR2US key: '26' href: /objects/accounts-receivable/billback-template/26 lineNumber: '1' 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/26 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a bill back template description: >- Updates an existing bill back template by setting field values. Any fields not provided remain unchanged. tags: - Bill back 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: Update a bill back 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: Reference to updated bill back template: value: ia::result: key: '5' id: BBT-AU2IN 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 bill back template description: Deletes a bill back template. tags: - Bill back 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 bill back template lines description: >- Returns a collection with a key, ID, and link for each bill back template line. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Bill back 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 bill back 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 unique key for the bill back template line. in: path example: '9' required: true schema: type: string get: summary: Get a bill back template line description: Returns detailed information for a specified bill back template line. tags: - Bill back 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: Get a bill back template line: value: ia::result: key: '5' id: '5' 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/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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. tags: - 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. example: '99' get: summary: Get a customer description: Returns detailed information for a specified customer. tags: - 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: group: key: '7' id: Auto Contact Tax href: /objects/tax/contact-tax-group/7 solution: key: '7' id: Australia - GST href: /objects/tax/tax-solution/7 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: Customer 1(CCust1) 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' showInContactList: true 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: '23' href: /objects/accounts-receivable/territory/23 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 customerMessage: key: '10' id: welcome message message: Welcome to Power Aerospace Materials href: /objects/accounts-receivable/customer-message/10 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' customerRestriction: restricted 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' restrictedDepartments: - key: '1' id: Eng objectType: CUSTOMER department: key: '13' id: '3' href: /objects/company-config/department/3 departmentGroup: key: null id: null href: '/objects/accounts-receivable/customer-restricted-department/1' restrictedLocations: - key: '142' id: Nov7-02 objectType: CUSTOMER location: key: '3' id: '3' href: /objects/company-config/location/3 locationGroup: key: null id: null href: '/objects/accounts-receivable/customer-restricted-location/142' href: /objects/accounts-receivable/customer/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Get a customer with country set to France for the primary contact: value: ia::result: key: '1' id: '1' name: Power Aerospace Materials France parent: key: null id: null name: null contacts: default: electronicInvoiceDetails: legalCategory: 24 Fiduciary mainActivity: >- 10.3 Transformation and conservation of fruits and vegetables registeredCapital: 37 000 typeOfCompany: 03 Intermediate sized enterprises valueAddedTaxRegime: Monthly mailingAddress: addressLine1: 1120 Harbor Bay Pkwy addressLine2: St John's street addressLine3: Double cross road city: Paris country: France postCode: 95119-1208 state: null tax: group: key: '7' id: Auto Contact Tax href: /objects/tax/contact-tax-group/7 solution: key: null id: null href: null 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: Customer 1(CCust1) internationalTaxId: '123' 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' showInContactList: true 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: '23' href: /objects/accounts-receivable/territory/23 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 customerMessage: key: '10' id: welcome message message: Welcome to Power Aerospace Materials href: /objects/accounts-receivable/customer-message/10 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. tags: - 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. tags: - Customers operationId: delete-accounts-receivable-customer-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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. operationId: list-accounts-receivable-customer-contact tags: - 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: - 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-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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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: - 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: - 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 templateType: arInvoice href: /objects/company-config/email-template/4 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: - 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: - 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/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: - 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: - 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 example: '99' get: summary: Get a customer item cross reference description: >- Returns detailed information for a specified customer item cross reference. tags: - 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: - 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: - 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-restricted-department: get: summary: List customer restricted departments description: >- Returns a collection with a key, ID, and link for each customer restricted department. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Customer restricted departments operationId: list-accounts-receivable-customer-restricted-department responses: '200': description: OK content: application/json: schema: type: object title: List of customer-restricted-department objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List customer restricted departments: value: ia::result: - key: '76' id: '76' href: '/objects/accounts-receivable/customer-restricted-department/76' - key: '77' id: '77' href: '/objects/accounts-receivable/customer-restricted-department/77' - key: '78' id: '78' href: '/objects/accounts-receivable/customer-restricted-department/78' ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-restricted-department/{key}: parameters: - name: key description: System-assigned unique key for the customer restricted department. in: path required: true example: '77' schema: type: string get: summary: Get a customer restricted department description: >- Returns detailed information for a specified customer restricted department. tags: - Customer restricted departments operationId: get-accounts-receivable-customer-restricted-department-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the customer-restricted-department properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer-restricted-department' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a customer restricted department: value: ia::result: key: '77' id: '77' department: key: '24' id: DES href: /objects/company-config/department/24 departmentGroup: key: null id: null customer: key: '330' id: D10 href: /objects/accounts-receivable/customer/330 href: '/objects/accounts-receivable/customer-restricted-department/77' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-restricted-location: get: summary: List customer restricted locations description: >- Returns a collection with a key, ID, and link for each customer restricted location. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Customer restricted locations operationId: list-accounts-receivable-customer-restricted-location responses: '200': description: OK content: application/json: schema: type: object title: List of customer-restricted-location objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List customer restricted locations: value: ia::result: - key: '44' id: '44' href: '/objects/accounts-receivable/customer-restricted-location/44' - key: '40' id: '40' href: '/objects/accounts-receivable/customer-restricted-location/40' - key: '41' id: '41' href: '/objects/accounts-receivable/customer-restricted-location/41' ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-restricted-location/{key}: parameters: - name: key description: System-assigned unique key for the customer restricted location. in: path required: true example: '44' schema: type: string get: summary: Get a customer restricted location description: >- Returns detailed information for a specified customer restricted location. tags: - Customer restricted locations operationId: get-accounts-receivable-customer-restricted-location-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the customer-restricted-location properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer-restricted-location' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a customer restricted location: value: ia::result: key: '40' id: '40' location: key: '3' id: '3' href: /objects/company-config/location/3 locationGroup: key: null id: null customer: key: '2' id: LSM01 href: /objects/accounts-receivable/customer/2 href: '/objects/accounts-receivable/customer-restricted-location/40' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-account-group: get: summary: List customer account groups tags: - 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: - 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: Reference to 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. example: '99' get: summary: Get a customer account group tags: - 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: - 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: Reference to 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: - 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/customer-message: get: summary: List customer messages description: Returns a collection with a key, ID, and link for each customer message. tags: - Customer messages operationId: list-accounts-receivable-customer-message responses: '200': description: OK content: application/json: schema: type: object title: List of customer-message objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List customer messages: value: ia::result: - key: '1' id: Active Message href: /objects/accounts-receivable/customer-message/1 - key: '2' id: Inactive Message href: /objects/accounts-receivable/customer-message/2 - key: '3' id: Message Balance href: /objects/accounts-receivable/customer-message/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a customer message description: Creates a new customer message. tags: - Customer messages operationId: create-accounts-receivable-customer-message requestBody: description: Creates a new customer message. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-message' - $ref: '#/components/schemas/accounts-receivable-customer-messageRequiredProperties' examples: Create a customer message: value: id: New Customer Message message: We look forward to doing business with you! status: active responses: '201': description: Created content: application/json: schema: type: object title: New customer-message properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new customer message: value: ia::result: key: '1' id: New Customer Message href: /objects/accounts-receivable/customer-message/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-message/{key}: parameters: - name: key description: System-assigned unique key for the customer message. in: path example: '4' required: true schema: type: string get: summary: Get a customer message description: Returns detailed information for a specified customer message. tags: - Customer messages operationId: get-accounts-receivable-customer-message-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the customer-message properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer-message' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a customer message: value: ia::result: key: '15' id: Welcome Message message: Welcome to the company! status: active audit: createdDateTime: '2024-08-16T13:26:56Z' createdByUser: key: '1' id: Admin href: /objects/company-config/user/1 createdBy: '1' modifiedDateTime: '2024-08-16T13:26:56Z' modifiedByUser: key: '1' id: Admin href: /objects/company-config/user/1 modifiedBy: '1' href: /objects/accounts-receivable/customer-message/15 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a customer message description: >- Updates an existing customer message by setting field values. Any fields not provided remain unchanged. tags: - Customer messages operationId: update-accounts-receivable-customer-message-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-message' - type: object properties: id: readOnly: true examples: Update a customer message: value: message: Hello and welcome! responses: '200': description: OK content: application/json: schema: type: object title: Updated customer-message properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated customer message: value: ia::result: key: '15' id: Welcome Message href: /objects/accounts-receivable/customer-message/15 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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. tags: - 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. tags: - 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' entity: key: null id: null name: null 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. tags: - 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. tags: - 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-total: get: summary: List customer totals description: >- Returns a collection with a key, ID, and link for each customer total. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Customer totals operationId: list-accounts-receivable-customer-total responses: '200': description: OK content: application/json: schema: type: object title: List of customer total objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List customer totals: value: ia::result: - key: '41' id: '15' href: /objects/accounts-receivable/customer-total/41 - key: '44' id: '6' href: /objects/accounts-receivable/customer-total/44 - key: '46' id: '3' href: /objects/accounts-receivable/customer-total/46 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-total/{key}: parameters: - name: key description: System-assigned unique key for the customer total. in: path example: '42' required: true schema: type: string get: summary: Get a customer total description: Returns detailed information for a specified customer total. tags: - Customer totals operationId: get-accounts-receivable-customer-total-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the customer total properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer-total' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a customer total: value: ia::result: key: '43' customer: id: DS name: Decal Solutions key: '5' href: /objects/accounts-receivable/customer/5 entity: id: NYC name: New York City totalDue: '123.11' id: '5' href: /objects/accounts-receivable/customer-total/43 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-group: get: summary: List customer groups description: >- Returns a collection with a key, ID, and link for each customer group. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Customer groups operationId: list-accounts-receivable-customer-group responses: '200': description: OK content: application/json: schema: type: object title: List of ar-customer-group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List customer groups: value: ia::result: - key: '1' id: Active Customers href: /objects/accounts-receivable/customer-group/1 - key: '2' id: Inactive Customers href: /objects/accounts-receivable/customer-group/2 - key: '3' id: Customers Balance href: /objects/accounts-receivable/customer-group/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a customer group description: Creates a new customer group. tags: - Customer groups operationId: create-accounts-receivable-customer-group requestBody: description: Creates a new customer group. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-group' - $ref: '#/components/schemas/accounts-receivable-customer-groupRequiredProperties' examples: Create a customer group (type all): value: id: CustGroup4 name: Customer Group 4 description: Charity service customers groupType: all memberFilter: object: accounts-receivable/customer filterExpression: and filters: - $contains: id: Cust orderBy: - id: asc Create a customer group (type specific): value: id: CustGrp5 name: Customer Group 5 description: RC service customers groupType: specific groupMembers: - id: '21' - id: '22' responses: '201': description: Created content: application/json: schema: type: object title: New ar-customer-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new customer group (type all): value: ia::result: id: CustGroup4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Reference to new customer group (type specific): value: ia::result: id: CustGrp5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-group/{key}: parameters: - name: key description: System-assigned unique key for the customer group. in: path example: '25' required: true schema: type: string get: summary: Get a customer group description: Returns detailed information for a specified customer group. tags: - Customer groups operationId: get-accounts-receivable-customer-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the ar-customer-group properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a customer group: value: ia::result: key: '15' id: CustGroup8 name: Customer Group 8 description: JV service customers groupType: specific memberFilter: object: accounts-receivable/customer filterExpression: and orderBy: - id: asc audit: createdDateTime: '2025-03-16T13:26:56Z' modifiedDateTime: '2025-03-16T13:26:56Z' createdByUser: key: '1' id: Admin href: /objects/company-config/user/1 createdBy: '1' modifiedByUser: key: '1' id: Admin href: /objects/company-config/user/1 modifiedBy: '1' entity: key: null id: null name: null groupMembers: - key: '6' id: MR12 sortOrder: '0' href: /objects/accounts-receivable/customer/6 - key: '10' id: ITEC sortOrder: '1' href: /objects/accounts-receivable/customer/10 isDimensionStructure: true href: /objects/accounts-receivable/customer-group/15 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a customer group description: >- Updates an existing customer group by setting field values. Any fields not provided remain unchanged. Providing a new value for the `groupMembers` array replaces the entire array. tags: - Customer groups operationId: update-accounts-receivable-customer-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-group' - type: object properties: id: readOnly: true examples: Update a customer group: value: description: Revised JV service customers groupMembers: - id: '1' - id: '2' responses: '200': description: OK content: application/json: schema: type: object title: Updated ar-customer-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated customer group: value: ia::result: key: '6' id: CustGroup4 href: /objects/accounts-receivable/customer-group/6 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a customer group description: Deletes a customer group. tags: - Customer groups operationId: delete-accounts-receivable-customer-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/delivery-history: get: summary: List delivery histories description: >- Returns a collection with a key, ID, and link for each delivery history. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Delivery histories operationId: list-accounts-receivable-delivery-history responses: '200': description: OK content: application/json: schema: type: object title: List of delivery history objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List delivery histories: value: ia::result: - key: '1' id: '1' href: /objects/accounts-receivable/delivery-history/1 - key: '2' id: '2' href: /objects/accounts-receivable/delivery-history/2 - key: '3' id: '3' href: /objects/accounts-receivable/delivery-history/3 ia::meta: totalCount: 3 start: 1 pageSize: 3 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/delivery-history/{key}: parameters: - name: key description: System-assigned unique key for the delivery history. example: '3' in: path required: true schema: type: string get: summary: Get a delivery history description: Returns detailed information for a specified delivery history. tags: - Delivery histories operationId: get-accounts-receivable-delivery-history-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the delivery history properties: ia::result: $ref: '#/components/schemas/accounts-receivable-delivery-history' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a delivery history: value: ia::result: key: '4' id: '4' object: invoice entity: CBTI module: OE documentDate: '2025-01-31' deliveryDate: '2025-02-10' deliveryMethod: print data: "\nQA Std Co.,INC. -- Jul 28 2018,125, S Market Street125, S Market StreetSan Jose, CA095113Bill to:Berkeley Technology IncAttn: Mr. Dennis Ahern13112 Christy StSte 325San Francisco, CA094945-5000United StatesIntacct. A Better Way to Run Your Business\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tINVOICE #\n :In-10DATE:01/31/2020DUE DATE:02/11/202000:00TOTAL AMOUNT:$300.00TOTAL DUE:$300.00I N V O I C E\n\t\t\t\t\t\t\tDESCRIPTION / MEMO\n \n\t\t\t\t\t\t\tAMOUNT\n QA Std Co.,INC. -- Jul 28 2018,125, S Market Street125, S Market StreetSan Jose, CA095113United StatesCustomer Id:0BTIInvoice #:In-10Bill to:\n\t\t\t\t\t\t\t\t\tRemit to:\n Berkeley Technology IncAttn: Mr. Dennis Ahern13112 Christy StSte 325San Francisco, CA094945-5000United StatesQA Std Co.,INC. -- Jul 28 2018,0United StatesTOTAL AMOUNT:$300.00TOTAL DUE:$300.00AMOUNT ENCLOSED:00Superior financial Applications. Real-time business visibility. Open, on-demand platform.DATE:01/31/2020TERMS:DUE DATE:02/11/2020PAGE\n $300.00\n" attachment: key: '14' id: '14' href: /objects/company-config/attachment/14 href: /objects/accounts-receivable/delivery-history/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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. tags: - 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 customerMessage: id: welcome message 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 example: '99' get: summary: Get an invoice description: Returns detailed information for a specified invoice. tags: - 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: '292' key: '292' recordType: ri invoiceNumber: ADJDEC0002 state: posted customer: id: '1' key: '1' name: Power Aerospace Materials emailOption: false customerDue: '-17909.55' deliveryOptions: print href: /objects/accounts-receivable/customer/1 customerMessage: key: null id: null message: null referenceNumber: null description: nextGen Recurr documentId: null salesDocument: key: null id: null term: id: Due upon pay key: '15' href: /objects/accounts-receivable/term/15 invoiceDate: '2024-09-24' invoiceSummary: glPostingDate: '2024-09-24' id: 'Invoices: 2024/09/24 Batch' key: '199' isSummaryOpen: open isSummaryPosted: 'false' href: /objects/accounts-receivable/summary/199 discountCutOffDate: '2024-09-24' dueDate: '2024-09-24' paymentInformation: fullyPaidDate: null totalBaseAmountSelectedForPayment: '0.00' totalBaseAmountPaid: '0.00' totalTxnAmountSelectedForPayment: '0.00' totalTxnAmountPaid: '0.00' currency: baseCurrency: AUD txnCurrency: AUD exchangeRate: date: null typeId: null rate: null totalBaseAmount: '440.00' totalBaseAmountDue: '440.00' totalTxnAmount: '440.00' totalTxnAmountDue: '440.00' contacts: payTo: id: Power Aerospace Materials(C1) key: '152' returnTo: id: Power Aerospace Materials(C1) key: '152' tax: group: id: null key: null taxId: null moduleKey: accountsReceivable recurringSchedule: key: '24' isSystemGeneratedDocument: false billbackTemplate: id: null key: null audit: createdDateTime: '2024-09-24T14:18:20Z' modifiedDateTime: '2024-09-24T14:18:20Z' createdBy: '1' modifiedBy: '1' dueInDays: 3 taxSolution: key: '1' id: Australia - GST href: /objects/tax/tax-solution/1 attachment: id: atch1 key: '6' href: /objects/company-config/attachment/6 dunningCount: 0 entity: key: null id: null name: null lines: - id: '2702' key: '2702' invoice: id: '292' key: '292' href: /objects/accounts-receivable/invoice/292 glAccount: key: '254' id: '6103' name: Bonuses href: /objects/general-ledger/account/254 overrideOffsetGLAccount: key: '36' id: '1200' name: Accounts Receivable href: /objects/general-ledger/account/36 accountLabel: name: Bonuses key: '35' id: Bonuses href: /objects/accounts-receivable/account-label/35 createdDate: '2024-09-24' baseAmount: '400.00' txnAmount: '400.00' dimensions: department: key: null id: null name: null location: key: '4' id: '4' name: Australia href: /objects/company-config/location/4 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 baseLocation: name: Australia key: '4' href: /objects/company-config/location/4 memo: line 1 currency: exchangeRate: date: null typeId: null rate: 1 txnCurrency: AUD baseCurrency: AUD allocation: key: null id: null lineNumber: 1 paymentInformation: totalBaseAmountPaid: '0.00' totalTxnAmountPaid: '0.00' totalBaseAmountSelectedForPayment: '0.00' totalTxnAmountSelectedForPayment: '0.00' isSubtotal: null audit: createdDateTime: '2024-09-24T14:18:20Z' modifiedDateTime: '2024-09-24T14:18:20Z' createdBy: '1' modifiedBy: '1' taxEntries: - txnTaxAmount: '40.00' baseTaxAmount: '40.00' orderEntryTaxDetail: id: G1 Goods and Services Tax key: '20' href: /objects/tax/order-entry-tax-detail/20 id: '2704' key: '2704' taxRate: 10 invoiceLine: id: '2702' key: '2702' href: /objects/accounts-receivable/invoice-line/2702 href: '/objects/accounts-receivable/invoice-tax-entry/2704' href: /objects/accounts-receivable/invoice-line/2702 href: /objects/accounts-receivable/invoice/292 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). tags: - 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. tags: - 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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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 example: '99' get: summary: Get an invoice line description: Returns detailed information for a specified invoice line item. tags: - 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: '2702' key: '2702' invoice: id: '292' key: '292' href: /objects/accounts-receivable/invoice/292 glAccount: key: '254' id: '6103' name: Bonuses href: /objects/general-ledger/account/254 overrideOffsetGLAccount: key: '36' id: '1200' name: Accounts Receivable href: /objects/general-ledger/account/36 accountLabel: name: Bonuses key: '35' id: Bonuses href: /objects/accounts-receivable/account-label/35 createdDate: '2024-09-24' baseAmount: '400.00' txnAmount: '400.00' dimensions: department: key: null id: null name: null location: key: '4' id: '4' name: Australia href: /objects/company-config/location/4 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 baseLocation: name: Australia key: '4' href: /objects/company-config/location/4 memo: line 1 currency: exchangeRate: date: null typeId: null rate: 1 txnCurrency: AUD baseCurrency: AUD allocation: key: null id: null lineNumber: 1 paymentInformation: totalBaseAmountPaid: '0.00' totalTxnAmountPaid: '0.00' totalBaseAmountSelectedForPayment: '0.00' totalTxnAmountSelectedForPayment: '0.00' isSubtotal: null audit: createdDateTime: '2024-09-24T14:18:20Z' modifiedDateTime: '2024-09-24T14:18:20Z' createdBy: '1' modifiedBy: '1' taxEntries: - id: '2704' key: '2704' invoiceLine: id: '2702' key: '2702' href: /objects/accounts-receivable/invoice-line/2702 baseTaxAmount: '40.00' txnTaxAmount: '40.00' taxRate: 10 orderEntryTaxDetail: id: G1 Goods and Services Tax key: '20' href: /objects/tax/order-entry-tax-detail/20 href: /objects/accounts-receivable/invoice-tax-entry/2704 href: /objects/accounts-receivable/invoice-line/2702 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice-tax-entry: get: summary: List invoice tax entries description: >- Returns a collection with a key, ID, and link for each invoice tax entry. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Invoice tax entries operationId: list-accounts-receivable-invoice-tax-entry responses: '200': description: OK content: application/json: schema: type: object title: List of invoice tax entry objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List invoice tax entries: value: ia::result: - key: '8' id: '8' href: /objects/accounts-receivable/invoice-tax-entry/8 - key: '9' id: '9' href: /objects/accounts-receivable/invoice-tax-entry/9 - key: '10' id: '10' href: /objects/accounts-receivable/invoice-tax-entry/10 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice-tax-entry/{key}: parameters: - name: key description: System-assigned key for the invoice tax entry. in: path required: true schema: type: string example: '34' get: summary: Get an invoice tax entry description: Returns detailed information for a specified invoice tax entry. tags: - Invoice tax entries operationId: get-accounts-receivable-invoice-tax-entry-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the invoice tax entry properties: ia::result: $ref: '#/components/schemas/accounts-receivable-invoice-tax-entry' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an invoice tax entry: value: ia::result: id: '2704' key: '2704' invoiceLine: id: '2702' key: '2702' href: /objects/accounts-receivable/invoice-line/2702 baseTaxAmount: '40.00' txnTaxAmount: '40.00' taxRate: 10 orderEntryTaxDetail: id: G1 Goods and Services Tax key: '20' href: /objects/tax/order-entry-tax-detail/20 href: /objects/accounts-receivable/invoice-tax-entry/2704 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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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 example: '99' get: summary: Get an invoice summary description: Returns detailed information for a specified AR invoice summary. tags: - 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: 'Invoices: 2019/12/01 Batch' glPostingDate: '2019-12-01' status: active recordType: invoice totalAmount: '0' state: open parent: key: '13' id: '13' preventGLPosting: false 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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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. tags: - 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: receiptDate: '2024-03-23' txnCurrency: currency: USD baseCurrency: currency: USD paymentDetails: - arInvoice: id: '2085' txnCurrency: paymentAmount: '60.00' 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. example: '67' in: path required: true schema: type: string get: summary: Get a payment description: Returns detailed information for a specified payment. tags: - 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): 2024/10/10 Batch' receiptDate: '2024-10-10' name: 'Receipts(Bank-BOA): 2024/10/10 Batch' href: /objects/accounts-receivable/summary/281 undepositedGLAccount: key: null id: null recordType: rp financialEntity: entityId: BOA entityType: ba name: Bank of America currency: USD state: complete paymentMethod: cash customer: key: '8' entity: C100 id: C-000012 name: Gomez Manufacturers href: objects/accounts-receivable/customer/8 payerName: null documentNumber: '1567' description: Regular payment for services audit: createdDateTime: '2024-10-10T00:00:00Z' modifiedDateTime: '2024-12-12T06:51:22Z' createdByUser: key: '39' href: /objects/company-config/user/39 createdBy: '39' modifiedByUser: key: '39' href: /objects/company-config/user/39 modifiedBy: '39' paidDate: '2024-11-20' baseCurrency: currency: USD totalAmount: '250' totalSelected: '0' totalPaid: '250' totalDue: '0' txnCurrency: currency: GBP totalAmount: '250' totalSelected: '0' totalPaid: '250' totalDue: '0' exchangeRate: date: '2024-08-01' typeId: GBP-Rate rate: 3 contacts: payTo: id: Klay Vanderbilt key: '8' bankReconciliationStatus: 'false' bankReconciliationDate: null referenceNumber: null attachment: id: '123' key: '123' href: /objects/company-config/attachment/123 entity: key: '1' id: '1' name: United States of America href: /objects/company-config/entity/1 multiEntityPayment: key: '1077' id: PAY-00136 href: /objects/accounts-receivable/payment/1077 lines: - id: '1011' key: '1011' arPayment: key: '464' id: '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: GBP totalPaid: '10' totalSelected: '0' dimensions: department: key: '2' id: '9' name: Engineering location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 customer: key: '20' id: C-00013 href: /objects/accounts-receivable/customer/20 vendor: key: null id: null name: null employee: key: null id: null name: null item: key: '227' id: API3.0 name: API Usage href: /objects/inventory-control/item/227 contract: key: '61' id: '62176' name: '62176' href: /objects/contracts/contract/61 project: key: null id: null name: null class: key: null id: null name: null memo: Regular payment for services exchangeRate: date: '2024-10-10' typeId: '3' rate: 3 lineNumber: 1 recordType: rp offsetGLAccount: key: '9' id: '4000' href: /objects/general-ledger/account/9 audit: createdDateTime: '2024-12-12T06:51:21Z' modifiedDateTime: '2024-12-12T06:51:22Z' createdByUser: key: '38' href: /objects/company-config/user/38 createdBy: '38' modifiedByUser: key: '38' href: /objects/company-config/user/38 modifiedBy: '38' href: /objects/accounts-receivable/payment-line/1011 paymentDetails: - id: '127' key: '127' baseCurrency: paymentAmount: '10' inlineAmount: null postedAdvanceAmount: null postedOverPaymentAmount: null negativeInvoiceAmount: null adjustmentAmount: null txnCurrency: inlineAmount: null postedAdvanceAmount: null postedOverPaymentAmount: null negativeInvoiceAmount: null adjustmentAmount: null paymentAmount: '10.00' currency: GBP 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 arPostedOverPayment: key: null id: null arPostedOverPaymentLine: id: null key: null postedOverPayment: key: null id: null postedOverPaymentLine: id: null key: null negativeInvoice: key: null id: null negativeInvoiceLine: id: null key: null arAdjustment: key: null id: null arAdjustmentLine: id: null key: null arAdvance: key: null id: null arAdvanceLine: 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: '2024-03-20' audit: createdDateTime: '2024-12-12T06:51:21Z' modifiedDateTime: '2024-12-12T06:51:21Z' createdByUser: key: '1' href: /objects/company-config/user/1 createdBy: '1' modifiedByUser: key: '1' href: /objects/company-config/user/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: [] delete: summary: Delete a draft payment description: Deletes a draft payment. tags: - Payments operationId: delete-accounts-receivable-payment-key responses: '204': description: No Content '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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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 - key: '119' id: '119' href: /objects/accounts-receivable/payment-detail/119 ia::meta: totalCount: 3 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 unique key for the payment details. example: '119' in: path required: true schema: type: string get: summary: Get payment details description: Returns detailed information for a specified payment detail object. tags: - 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 arAdvance: key: null id: null arAdvanceLine: id: null key: null postedAdvance: key: null id: null postedAdvanceLine: id: null key: null arPostedOverPayment: key: null id: null arPostedOverPaymentLine: id: null key: null postedOverPayment: key: null id: null postedOverPaymentLine: id: null key: null negativeInvoice: key: null id: null negativeInvoiceLine: 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: '2024-11-25' baseCurrency: paymentAmount: '5.00' inlineAmount: '10.00' postedAdvanceAmount: null postedOverPaymentAmount: null negativeInvoiceAmount: null adjustmentAmount: null txnCurrency: inlineAmount: '10.00' postedAdvanceAmount: null postedOverPaymentAmount: null negativeInvoiceAmount: null adjustmentAmount: null paymentAmount: '50.00' currency: USD discountDate: null audit: createdDateTime: '2024-11-25T07:09:13Z' modifiedDateTime: '2024-11-25T07:09:13Z' createdByUser: key: '39' href: /objects/company-config/user/39 createdBy: '39' modifiedByUser: key: '39' href: /objects/company-config/user/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-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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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 unique key for the payment line. example: '28' in: path required: true schema: type: string get: summary: Get a payment line description: Returns detailed information for a specified payment line. tags: - 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: '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 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 employee: key: '3' id: Admin name: Automation Test Admin href: /objects/company-config/employee/3 contract: key: '7' id: CONTRACTAUG16MEA name: CONTRACTAUG16MEA href: /objects/contracts/contract/7 project: key: null id: null name: null class: key: '6' id: '4' name: Professional services href: /objects/company-config/class/6 memo: null, exchangeRate: date: '2024-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: '2024-04-21T12:34:02Z' modifiedDateTime: '2024-07-04T08:18:29Z' createdByUser: key: '39' href: /objects/company-config/user/39 createdBy: '39' modifiedByUser: key: '39' href: /objects/company-config/user/39 modifiedBy: '39' href: /objects/accounts-receivable/payment-line/1369 '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: - 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: '110' id: '110' href: /objects/accounts-receivable/payment-summary/110 - key: '112' id: '112' href: /objects/accounts-receivable/payment-summary/112 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a payment summary description: Creates a new payment summary. tags: - Payment summaries operationId: create-accounts-receivable-payment-summary requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-payment-summary' - $ref: '#/components/schemas/accounts-receivable-payment-summaryRequiredProperties' examples: Create a payment summary: value: name: 'Reversed Receipts(Bank-BOA): 2023/04/12 Batch' glPostingDate: '2024-06-18' status: active state: open preventGLPosting: false bankAccount: id: BOA responses: '201': description: Created content: application/json: schema: type: object title: New payment-summary properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New payment summary: value: ia::result: key: '110' id: '110' href: /objects/accounts-receivable/payment-summary/110 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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 example: '99' get: summary: Get a payment summary description: Returns detailed information for a specified payment summary. tags: - Payment summaries operationId: get-accounts-receivable-payment-summary-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the 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: '110' id: '110' name: 'Reversed Receipts(Bank-BOA): 2023/04/12 Batch' glPostingDate: '2023-04-12' status: active recordType: payment totalAmount: '200' state: open parent: key: null id: null preventGLPosting: false bankAccount: key: '1' id: BOA currency: USD href: /objects/cash-management/bank-account/1 undepositedGLAccount: id: '1070' key: '33' href: /objects/general-ledger/account/33 summaryCreationType: manual isQuickPaymentSummary: false entity: key: '1' id: '1' name: United States of America href: /objects/company-config/entity/1 audit: createdDateTime: '2024-09-09T06:35:58Z' modifiedDateTime: '2024-09-09T06:35:58Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/payment-summary/110 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a payment summary description: >- Updates an existing payment summary by setting field values. Any fields not provided remain unchanged. tags: - Payment summaries operationId: update-accounts-receivable-payment-summary requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-payment-summary' - type: object properties: id: readOnly: true examples: Update a payment summary: value: name: paybatch 02 glPostingDate: '2024-06-19' status: active state: open responses: '200': description: OK content: application/json: schema: type: object title: Updated ar-payment-batch properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated payment summary: value: ia::result: key: '110' id: '110' href: /objects/accounts-receivable/payment-summary/110 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a payment summary description: Deletes a payment summary. tags: - Payment summaries operationId: delete-accounts-receivable-payment-summary 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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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: - 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: Monthly premium subscription term: key: '25' invoiceNumber: AR-INV referenceNumber: PO1223 customer: key: '10' currency: txnCurrency: USD baseCurrency: USD payment: paymentMethod: onlineChargeCard payInFull: true accountType: bank bankAccountId: BOA schedule: startDate: '2024-03-11' repeatBy: month repeatInterval: '2' lines: - description: line 1 glAccount: key: '194' txnAmount: '250.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: Reference to 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 example: '99' get: summary: Get a recurring invoice description: Returns detailed information for a specified recurring invoice. tags: - 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: '24' key: '24' description: nextGen Recurr audit: createdDateTime: '2024-09-24T00:00:00Z' modifiedDateTime: '2024-09-24T14:18:18Z' createdBy: '1' modifiedBy: '1' term: key: '15' id: Due upon pay href: /objects/accounts-receivable/term/15 invoiceNumber: Adjustment Decrease totalEntered: '440.00' referenceNumber: null status: active customer: name: Power Aerospace Materials key: '1' id: '1' href: /objects/accounts-receivable/customer/1 scheduledOperation: id: '7' key: '7' href: /objects/core/scheduled-operation/7 contract: id: null description: null contacts: billTo: key: '128' id: Power Aerospace Materials(C1) href: /objects/company-config/contact/128 shipTo: key: '128' id: Power Aerospace Materials(C1) tax: group: id: null key: null taxId: null href: /objects/company-config/contact/128 currency: txnCurrency: AUD baseCurrency: AUD exchangeRateTypeId: '' exchangeRate: 1 txnTotalEntered: '440.00' customerMessage: key: null id: null message: null payment: paymentMethod: none payInFull: true paymentAmount: null customerCreditCard: key: null id: null creditCardType: null accountType: null bankAccountId: null undepositedFundsAccountId: null schedule: txnCount: '5' startDate: '2024-09-24' endDate: null nextExecutionDate: '2024-09-25' lastExecutionDate: '2024-09-24' repeatCount: '3' repeatBy: day repeatInterval: '1' taxSolution: key: '1' id: Australia - GST href: /objects/tax/tax-solution/1 attachment: id: atch1 key: null lines: - id: '51' key: '51' recurringInvoice: id: '24' key: '24' href: /objects/accounts-receivable/recurring-invoice/24 offsetGLAccount: key: null description: line 1 glAccount: key: '254' id: '6103' name: Bonuses href: /objects/general-ledger/account/254 amount: '400.00' dimensions: location: id: '4' name: Australia department: 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: Bonuses key: '35' href: /objects/accounts-receivable/account-label/35 currency: txnCurrency: AUD baseCurrency: AUD exchangeRateDate: null exchangeRateTypeId: null exchangeRate: 1 txnAmount: '400.00' allocation: key: null id: null isBillable: null audit: createdDateTime: '2024-09-24T14:18:18Z' modifiedDateTime: '2024-09-24T14:18:18Z' createdBy: '1' modifiedBy: '1' deferredRevenueGLAccount: key: null id: null name: null startDate: null endDate: null taxDetail: taxRate: null id: null key: null isTax: false isSubTotal: null taxEntries: - txnTaxAmount: '40.00' baseTaxAmount: '40.00' orderEntryTaxDetail: id: G1 Goods and Services Tax key: '20' href: /objects/tax/order-entry-tax-detail/20 id: '52' key: '52' taxRate: 10 href: '/objects/accounts-receivable/recurring-invoice-tax-entry/52' totalTxnAmount: '440.00' href: '/objects/accounts-receivable/recurring-invoice-line/51' href: /objects/accounts-receivable/recurring-invoice/24 entity: key: null id: null name: null 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: - 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: Renewed subscription for 2024 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: Reference to 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. If a recurring invoice is no longer in use, you can delete it instead of ending the recurring schedule. For example, if a contract with a customer is permanently canceled, you can delete the recurring invoice for that customer. tags: - 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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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 example: '99' get: summary: Get a recurring invoice line description: >- Returns detailed information for a specified line item in a recurring invoice. tags: - 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: '51' key: '51' recurringInvoice: id: '24' key: '24' href: /objects/accounts-receivable/recurring-invoice/24 offsetGLAccount: key: null description: line 1 glAccount: key: '254' id: '6103' name: Bonuses href: /objects/general-ledger/account/254 amount: '400.00' dimensions: location: id: '4' name: Australia department: 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: Bonuses key: '35' href: /objects/accounts-receivable/account-label/35 currency: txnCurrency: AUD baseCurrency: AUD exchangeRateDate: null exchangeRateTypeId: null exchangeRate: 1 txnAmount: '400.00' allocation: key: null id: null isBillable: null audit: createdDateTime: '2024-09-24T14:18:18Z' modifiedDateTime: '2024-09-24T14:18:18Z' createdBy: '1' modifiedBy: '1' deferredRevenueGLAccount: key: null id: null name: null startDate: null endDate: null taxDetail: taxRate: null id: null key: null isTax: false isSubTotal: null taxEntries: - id: '52' key: '52' recurringInvoiceLine: id: '51' key: '51' href: '/objects/accounts-receivable/recurring-invoice-line/51' baseTaxAmount: '40.00' txnTaxAmount: '40.00' taxRate: 10 orderEntryTaxDetail: id: G1 Goods and Services Tax key: '20' href: /objects/tax/order-entry-tax-detail/20 href: '/objects/accounts-receivable/recurring-invoice-tax-entry/52' href: /objects/accounts-receivable/recurring-invoice-line/51 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/recurring-invoice-tax-entry: get: summary: List recurring invoice tax entries description: >- Returns a collection with a key, ID, and link for each recurring invoice tax entry. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Recurring invoice tax entries operationId: list-accounts-receivable-recurring-invoice-tax-entry responses: '200': description: OK content: application/json: schema: type: object title: List of recurring invoice tax entry objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List recurring invoice tax entries: value: ia::result: - key: '8' id: '8' href: '/objects/accounts-receivable/recurring-invoice-tax-entry/8' - key: '9' id: '9' href: '/objects/accounts-receivable/recurring-invoice-tax-entry/9' - key: '10' id: '10' href: '/objects/accounts-receivable/recurring-invoice-tax-entry/10' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/recurring-invoice-tax-entry/{key}: parameters: - name: key description: System-assigned key for the recurring invoice tax entry. in: path required: true schema: type: string example: '36' get: summary: Get a recurring invoice tax entry description: >- Returns detailed information for a specified recurring invoice tax entry. tags: - Recurring invoice tax entries operationId: get-accounts-receivable-recurring-invoice-tax-entry-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the recurring invoice tax entry properties: ia::result: $ref: '#/components/schemas/accounts-receivable-recurring-invoice-tax-entry' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a recurring invoice tax entry: value: ia::result: id: '52' key: '52' recurringInvoiceLine: id: '51' key: '51' href: /objects/accounts-receivable/recurring-invoice-line/51 baseTaxAmount: '40.00' txnTaxAmount: '40.00' taxRate: 10 orderEntryTaxDetail: id: G1 Goods and Services Tax key: '20' href: /objects/tax/order-entry-tax-detail/20 href: '/objects/accounts-receivable/recurring-invoice-tax-entry/52' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' 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. tags: - Revenue recognition templates operationId: list-accounts-receivable-revenue-recognition-template 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 of revenue recognition templates: value: ia::result: - key: '299' id: '299' href: '/objects/accounts-receivable/revenue-recognition-template/299' - key: '294' id: '294' href: '/objects/accounts-receivable/revenue-recognition-template/294' ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a revenue recognition template description: Creates a new revenue recognition template. tags: - Revenue recognition templates operationId: create-accounts-receivable-revenue-recognition-template requestBody: description: Revenue recognition template creation. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-revenue-recognition-template' - $ref: '#/components/schemas/accounts-receivable-revenue-recognition-templateRequiredProperties' examples: Create a revenue recognition template: value: id: ProjectTaskEstimatedHours description: Project-Task Rev Rec based on Estimated Hours useStandard: false schedulePeriod: monthly postingDay: endOfPeriod totalPeriods: null recognitionMethod: percentCompleted recognitionStartDate: transactionDate postingMethod: manual status: active recognitionTerm: project resumeOption: walkforward milestoneSource: project calculation: source: task basedOn: estimatedHours responses: '201': description: Created content: application/json: schema: type: object title: New revenue recognition template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new revenue recognition template: value: ia::result: key: '19' href: '/objects/accounts-receivable/revenue-recognition-template/19' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/revenue-recognition-template/{key}: parameters: - name: key description: System-assigned unique key for the revenue recognition template. in: path required: true schema: type: string example: '99' get: summary: Get a revenue recognition templates description: >- Returns detailed information for a specified revenue recognition template. tags: - Revenue recognition templates operationId: get-accounts-receivable-revenue-recognition-template-key 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: Details of the revenue recognition templates: value: ia::result: key: '14' id: MilestoneObservedPercentComp description: Milestone Rev Rec based on Observed % Completed useStandard: false schedulePeriod: monthly postingDay: endOfPeriod totalPeriods: null recognitionMethod: milestone recognitionStartDate: transactionDate postingMethod: manual status: active latestVersion: null recognitionTerm: project resumeOption: walkforward milestoneSource: project calculation: source: task basedOn: observed%Completed audit: createdDateTime: '2016-05-04T19:23:33Z' modifiedDateTime: '2016-05-04T19:23:33Z' createdByUser: key: '1' id: Admin href: /objects/company-config/user/1 createdBy: '1' modifiedByUser: key: '1' id: Admin href: /objects/company-config/user/1 modifiedBy: '1' entity: key: null id: null name: null href: '/objects/accounts-receivable/revenue-recognition-template/14' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a revenue recognition template description: >- Updates an existing revenue recognition template by setting field values. Any fields not provided remain unchanged. tags: - Revenue recognition templates operationId: update-accounts-receivable-revenue-recognition-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-revenue-recognition-template' - type: object properties: id: readOnly: true examples: Updates a revenue recognition template: value: key: '6' id: MilestoneObservedPercentComp description: Milestone Rev Rec based on Observed percent completed postingMethod: manual responses: '200': description: OK content: application/json: schema: type: object title: updated revenue recognition template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated revenue recognition template: value: ia::result: key: '6' id: OETEMPLATE href: '/objects/accounts-receivable/revenue-recognition-template/19' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a revenue recognition template description: >- Deletes a revenue recognition template. Only templates that are not tied to a transaction can be deleted. tags: - Revenue recognition templates operationId: delete-accounts-receivable-revenue-recognition-template-key responses: '204': description: No Content '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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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: - 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: 'Invoices: 2019/12/01 Batch' glPostingDate: '2023-05-10' status: active recordType: invoice state: open preventGLPosting: false isQuickPaymentSummary: false Create a manual deposit summary: value: name: 'Quick Deposit: 2025/04/01 Batch' glPostingDate: '2025-04-01' status: active recordType: invoice state: open preventGLPosting: false isQuickPaymentSummary: true 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 example: '99' get: summary: Get a summary description: Returns detailed information for a specified AR summary. tags: - 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: 'Invoices: 2019/12/01 Batch' glPostingDate: '2019-12-01' status: active recordType: invoice totalAmount: '100' state: open parent: id: '11' key: '11' preventGLPosting: false summaryCreationType: manual isQuickPaymentSummary: false href: /objects/accounts-receivable/summary/14 entity: key: null id: null name: null 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: - 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: 'Invoices: 2019/12/01 Batch' glPostingDate: '2023-05-10' status: active recordType: invoice 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: - Summaries operationId: delete-accounts-receivable-summary-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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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: - 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: id: 2-10 Net 30 description: N30 with discount due: days: 30 from: fromInvoiceDate discount: days: 4 amount: 2 from: fromInvoiceDate calculateOn: lineItemsTotal unit: percentage graceDays: 10 penalty: cycle: weekly amount: 1 unit: percentage graceDays: 20 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: Reference to new AR term: value: ia::result: key: '18' id: 2-10 Net 30 href: /objects/accounts-receivable/term/18 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/term/{key}: parameters: - name: key description: System-assigned unique key for the term. in: path required: true schema: type: string example: '99' get: summary: Get a term description: Returns detailed information for a specified term. tags: - 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: 2-10 Net 30 description: N30 with discount status: active key: '18' due: days: 30 from: fromInvoiceDate discount: days: 4 from: fromInvoiceDate amount: 2 unit: percentage graceDays: 10 calculateOn: lineItemsTotal penalty: cycle: weekly amount: 1 unit: percentage graceDays: 20 audit: modifiedDateTime: '2024-03-06T09:23:41Z' createdDateTime: '2024-03-06T09:23:41Z' modifiedBy: '1' createdBy: '1' href: /objects/accounts-receivable/term/18 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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: - 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 single value: value: description: NA customer 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: Reference to updated term: value: ia::result: key: '18' id: N30 href: /objects/accounts-receivable/term/18 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a term description: >- Deletes a term. Delete terms that are no longer in use to avoid cluttering the list of active terms. tags: - Terms operationId: delete-accounts-receivable-term-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 the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - 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. tags: - 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. example: '99' get: summary: Get a territory description: Returns detailed information for a specified territory. tags: - 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. tags: - 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. tags: - Territories operationId: delete-accounts-receivable-territory-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/shipping-method: get: summary: List shipping methods description: >- Returns a collection with a key, ID, and link for each shipping method. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Shipping methods operationId: list-accounts-receivable-shipping-method responses: '200': description: OK content: application/json: schema: type: object title: List of shipping method objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List shipping methods: value: ia::result: - key: '1' id: Ground href: /objects/accounts-receivable/shipping-method/1 - key: '2' id: Air href: /objects/accounts-receivable/shipping-method/2 - key: '3' id: Fedex href: /objects/accounts-receivable/shipping-method/3 - key: '4' id: Sea Route href: /objects/accounts-receivable/shipping-method/4 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a shipping method description: Creates a new shipping method object. tags: - Shipping methods operationId: create-accounts-receivable-shipping-method requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-shipping-method' - $ref: '#/components/schemas/accounts-receivable-shipping-methodRequiredProperties' examples: Create a new shipping method: value: id: Air daysInTransit: 10 responses: '201': description: Created content: application/json: schema: type: object title: New shipping method properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new shipping method: value: ia::result: key: '2' id: '2' href: /objects/accounts-receivable/shipping-method/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/shipping-method/{key}: parameters: - schema: type: string name: key in: path required: true example: '2' description: System-assigned unique key for the shipping method. get: summary: Get a shipping method description: Returns detailed information for a specified shipping method. tags: - Shipping methods operationId: get-accounts-receivable-shipping-method-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the shipping method properties: ia::result: $ref: '#/components/schemas/accounts-receivable-shipping-method' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a shipping method: value: ia::result: key: '2' id: Air status: active daysInTransit: 4 href: /objects/accounts-receivable/shipping-method/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a shipping method description: >- Updates an existing shipping method by setting field values. Any fields not provided remain unchanged. tags: - Shipping methods operationId: update-accounts-receivable-shipping-method-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-shipping-method' - type: object properties: id: readOnly: true examples: Update a shipping method: value: daysInTransit: 15 responses: '200': description: OK content: application/json: schema: type: object title: Updated shipping method properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated shipping method: value: ia::result: key: '2' id: '2' href: /objects/accounts-receivable/shipping-method/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a shipping method description: Deletes a shipping method. tags: - Shipping methods operationId: delete-accounts-receivable-shipping-method-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/manual-deposit: get: summary: List manual deposits description: >- Returns a collection with a key, ID, and link for each manual deposit. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Manual deposits operationId: list-accounts-receivable-manual-deposit responses: '200': description: OK content: application/json: schema: type: object title: List of manual deposits properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List manual deposits: value: ia::result: - key: '20' id: '20' href: /objects/accounts-receivable/manual-deposit/20 - key: '44' id: '44' href: /objects/accounts-receivable/manual-deposit/44 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a manual deposit description: Creates a new manual deposit. tags: - Manual deposits operationId: create-accounts-receivable-manual-deposit requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-manual-deposit' - $ref: '#/components/schemas/accounts-receivable-manual-depositRequiredProperties' examples: Create a manual deposit: value: customer: id: CNXT financialEntity: entityId: CITI createdDate: '2025-06-03' manualDepositSummary: id: '2226' lines: - paymentInformation: txnAmount: '150' glAccount: id: '1200' accountLabel: id: sale01 dimensions: location: id: '1' responses: '201': description: Created content: application/json: schema: type: object title: New manual deposit properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new manual deposit: value: ia::result: id: '20' key: '20' href: /objects/accounts-receivable/manual-deposit/20 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/manual-deposit/{key}: parameters: - name: key description: System-assigned unique key for the manual deposit. in: path example: '62' required: true schema: type: string get: summary: Get a manual deposit description: Returns detailed information for a specified manual deposit. tags: - Manual deposits operationId: get-accounts-receivable-manual-deposit-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the accounts-receivable-manual-deposit properties: ia::result: $ref: '#/components/schemas/accounts-receivable-manual-deposit' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a manual deposit: value: ia::result: id: '20' key: '20' recordType: rp createdDate: '2025-07-08' audit: createdDateTime: '2025-07-08T00:00:00Z' modifiedDateTime: '2025-07-08T12:19:07Z' createdBy: '1' modifiedBy: '1' customer: id: CNXT key: '12' name: CNXT href: /objects/accounts-receivable/customer/12 financialEntity: entityId: CITI bankName: Bank of America documentNumber: INV-1602 depositId: BOA-0001 description: null contacts: billTo: id: cnxt(Ccnxt) key: '661' href: /objects/company-config/contact/661 shipTo: id: cnxt(Ccnxt) key: '661' href: /objects/company-config/contact/661 currency: baseCurrency: USD txnCurrency: USD paymentInformation: totalAmountEntered: '100.00' totalPaid: '100.00' paidDate: '2025-07-08' totalEntered: '100.00' txnTotalPaid: '100.00' state: confirmed manualDepositSummary: id: '2226' key: '19' href: /objects/accounts-receivable/manual-deposit-summary/19 entity: key: null id: null name: null lines: - id: '46' key: '46' manualDeposit: id: '46' key: '20' href: /objects/accounts-receivable/manual-deposit/20 glAccount: key: '36' id: '1200' name: Accounts Receivable href: /objects/general-ledger/account/36 accountLabel: id: Accounts Receivable - Manual key: '11' href: /objects/accounts-receivable/account-label/11 currency: baseCurrency: USD txnCurrency: USD paymentInformation: baseAmount: '100.00' txnAmount: '100.00' dimensions: department: key: null id: null name: null location: key: '1' id: '1' href: /objects/company-config/location/1 project: key: null id: null name: null customer: key: '12' id: cnxt name: cnxt href: /objects/accounts-receivable/customer/12 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: null lineNumber: 1 audit: createdDateTime: '2025-07-08T12:19:07Z' modifiedDateTime: '2025-07-08T12:19:07Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/manual-deposit-line/46 href: /objects/accounts-receivable/manual-deposit/20 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/manual-deposit-line: get: summary: List manual deposit lines description: >- Returns a collection with a key, ID, and link for each manual deposit line. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Manual deposit lines operationId: list-accounts-receivable.manual-deposit-line responses: '200': description: OK content: application/json: schema: type: object title: List of manual deposit lines properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List manual deposit lines: value: ia::result: - key: '282' id: '282' href: /objects/accounts-receivable/manual-deposit-line/282 - key: '286' id: '286' href: /objects/accounts-receivable/manual-deposit-line/286 - key: '300' id: '300' href: /objects/accounts-receivable/manual-deposit-line/300 ia::meta: totalCount: 3 start: 1 ageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/manual-deposit-line/{key}: parameters: - name: key description: System-assigned unique key for the manual deposit line. in: path example: '286' required: true schema: type: string get: summary: Get a manual deposit line description: Returns detailed information for a specified manual deposit line. tags: - Manual deposit lines operationId: get-accounts-receivable.manual-deposit-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the manual deposit line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-manual-deposit-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a manual deposit line: value: ia::result: id: '300' key: '300' manualDeposit: id: '148' key: '148' href: /objects/accounts-receivable/manual-deposit/148 glAccount: key: '36' id: '1200' name: Accounts Receivable href: /objects/general-ledger/account/36 accountLabel: id: Accounts Receivable - Manual key: '11' href: /objects/accounts-receivable/account-label/11 currency: baseCurrency: USD txnCurrency: USD paymentInformation: baseAmount: '110.00' txnAmount: '110.00' dimensions: department: key: null id: null name: null location: key: '1' id: '1' href: /objects/company-config/location/1 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 memo: null lineNumber: 1 audit: createdDateTime: '2025-06-05T11:48:59Z' modifiedDateTime: '2025-06-05T11:54:14Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/manual-deposit-line/300 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/manual-deposit-summary: get: summary: List manual deposit summaries description: >- Returns a collection with a key, ID, and link for each AR manual deposit summary. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Manual deposit summaries operationId: list-accounts-receivable-manual-deposit-summary responses: '200': description: OK content: application/json: schema: type: object title: List of ar-manual-deposit-summary objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List manual deposit summaries: value: ia::result: - key: '11' id: '11' href: /objects/accounts-receivable/manual-deposit-summary/11 - key: '10' id: '10' href: /objects/accounts-receivable/manual-deposit-summary/10 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/manual-deposit-summary/{key}: parameters: - name: key description: System-assigned unique key for the manual deposit summary. in: path example: '25' required: true schema: type: string get: summary: Get a manual deposit summary description: Returns detailed information for a specified manual deposit summary. tags: - Manual deposit summaries operationId: get-accounts-receivable-manual-deposit-summary-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the ar-manual-deposit-summary properties: ia::result: $ref: '#/components/schemas/accounts-receivable-manual-deposit-summary' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a manual deposit summary: value: ia::result: key: '11' id: '11' name: 'Invoices: 2025/06/01 Batch' glPostingDate: 2025/06/01 status: active recordType: invoice totalAmount: '1100' state: open parent: key: '8' id: '8' href: /objects/accounts-receivable/summary/8 preventGLPosting: true summaryCreationType: manual isQuickPaymentSummary: true href: /objects/accounts-receivable/manual-deposit-summary/11 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/dunning-level: get: summary: List dunning levels description: > Returns a collection with a key, ID, and link for each dunning level. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Dunning levels operationId: list-accounts-receivable-dunning-level responses: '200': description: OK content: application/json: schema: type: object title: List of dunning-level objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List dunning levels: value: ia::result: - key: '2' id: DL1 href: /objects/accounts-receivable/dunning-level/2 - key: '5' id: Dunning level href: /objects/accounts-receivable/dunning-level/5 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a dunning level description: > Creates a new dunning level. Use naming conventions to establish levels for different customer types, company entities, and amount owed ranges. To learn more, see [Add dunning levels](https://www.intacct.com/ia/docs/en_US/help_action/Default.htm#cshid=Add_dunning_levels) in the Sage Intacct Help Center. tags: - Dunning levels operationId: create-accounts-receivable-dunning-level requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-dunning-level' - $ref: '#/components/schemas/accounts-receivable-dunning-levelRequiredProperties' examples: Create a dunning level: value: id: L1 Dunning level dunningThreshold: minDays: 0 maxDays: 100 txnCurrency: USD printTemplate: id: L1 PWD Dunning Notice noticeSequence: id: AR-Cr responses: '201': description: Created content: application/json: schema: type: object title: New dunning level properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new dunning level: value: ia::result: key: '4' id: L1 Dunning level href: /objects/accounts-receivable/dunning-level/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/dunning-level/{key}: parameters: - name: key description: System-assigned unique key for the dunning level. in: path example: '4' required: true schema: type: string get: summary: Get a dunning level description: Returns detailed information for a specified dunning level. tags: - Dunning levels operationId: get-accounts-receivable-dunning-level-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the dunning-level properties: ia::result: $ref: '#/components/schemas/accounts-receivable-dunning-level' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a dunning level: value: ia::result: key: '6' id: DL1 dunningThreshold: minDays: 0 maxDays: 100 minAmount: '1000' maxAmount: '10000' baseCurrency: USD txnCurrency: USD printTemplate: key: '2000492' id: DL1 Dunning Notice emailTemplate: key: '3' id: DL1 PWD template href: /objects/company-config/email-template/3 noticeSequence: id: Ar-Rec status: active audit: createdDateTime: '2025-05-21T09:05:50Z' modifiedDateTime: '2025-05-21T09:05:50Z' createdBy: '1' modifiedBy: '1' entity: key: null id: null name: null href: /objects/accounts-receivable/dunning-level/6 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a dunning level description: >- Updates an existing dunning level by setting field values. Any fields not provided remain unchanged. tags: - Dunning levels operationId: update-accounts-receivable-dunning-level-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-dunning-level' - type: object properties: id: readOnly: true examples: Update a dunning level: value: minDays: 10 responses: '200': description: OK content: application/json: schema: type: object title: Updated dunning level properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated dunning level: value: ia::result: key: '4' id: L2 Dunning level href: /objects/accounts-receivable/dunning-level/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a dunning level description: Deletes a dunning level. tags: - Dunning levels operationId: delete-accounts-receivable-dunning-level-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/dunning-customer: get: summary: List dunning customers description: >- Returns a collection with a key, ID, and link for each dunning customer. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Dunning customers operationId: list-accounts-receivable-dunning-customer responses: '200': description: OK content: application/json: schema: type: object title: List of dunning-customer objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List dunning customers: value: ia::result: - key: '1' id: DN-2 href: /objects/accounts-receivable/dunning-customer/1 - key: '2' id: DN-3 href: /objects/accounts-receivable/dunning-customer/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/dunning-customer/{key}: parameters: - name: key description: System-assigned unique key for the dunning customer. in: path example: '18' required: true schema: type: string get: summary: Get a dunning customer description: Returns detailed information for a specified dunning customer. tags: - Dunning customers operationId: get-accounts-receivable-dunning-customer-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the dunning-customer properties: ia::result: $ref: '#/components/schemas/accounts-receivable-dunning-customer' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a dunning customer: value: ia::result: id: '12' key: '12' dunningNoticeCustomerId: DN-2 dunningNotice: id: '14' key: '14' audit: modifiedDateTime: '2025-06-02T00:00:00Z' createdDateTime: '2025-06-02T00:00:00Z' modifiedBy: '1' createdBy: '1' href: /objects/accounts-receivable/dunning-notice/14 customer: key: '11' id: '11' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/11 invoiceCount: 2 totalAmountOverdue: '499.00' totalTxnAmountOverdue: '499.00' noticeEmail: date: 06/02/2025 01:24:51 to: null cc: null bcc: null dunningNoticeAttachment: PDF data deliveryMethod: printed invoices: - id: '4009' key: '4009' dunningCustomer: id: '119' key: '119' href: /objects/accounts-receivable/dunning-customer/119 arInvoice: id: '1966' key: '1966' invoiceNumber: inv213 invoiceDate: '2025-12-26' dueDate: '2025-12-31' totalBaseAmount: '400.00' totalTxnAmount: '400.00' totalBaseAmountDue: '400.00' referenceNumber: null totalTxnAmountDue: '499.00' href: /objects/accounts-receivable/invoice/1966 href: /objects/accounts-receivable/dunning-invoice/4009 - id: '4462' key: '4462' dunningCustomer: id: '129' key: '129' href: /objects/accounts-receivable/dunning-customer/129 arInvoice: id: '127' key: '127' invoiceNumber: Inv-1-Doc invoiceDate: '2025-12-27' dueDate: '2025-12-31' totalBaseAmount: '100.00' totalTxnAmount: '100.00' totalBaseAmountDue: '99.00' referenceNumber: null totalTxnAmountDue: '499.00' href: /objects/accounts-receivable/invoice/127 href: /objects/accounts-receivable/dunning-invoice/4462 href: /objects/accounts-receivable/dunning-customer/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/dunning-invoice: get: summary: List dunning invoices description: >- Returns a collection with a key, ID, and link for each dunning invoice. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Dunning invoices operationId: list-accounts-receivable-dunning-invoice responses: '200': description: OK content: application/json: schema: type: object title: List of dunning-invoice objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List dunning invoices: value: ia::result: - key: '96' id: '96' href: /objects/accounts-receivable/dunning-invoice/96 - key: '97' id: '97' href: /objects/accounts-receivable/dunning-invoice/97 ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/dunning-invoice/{key}: parameters: - name: key description: System-assigned unique key for the dunning invoice. in: path example: '43' required: true schema: type: string get: summary: Get a dunning invoice description: Returns detailed information for a specified dunning invoice. tags: - Dunning invoices operationId: get-accounts-receivable-dunning-invoice-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the dunning-invoice properties: ia::result: $ref: '#/components/schemas/accounts-receivable-dunning-invoice' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a dunning invoice: value: ia::result: id: '4009' key: '4009' dunningCustomer: id: '119' key: '119' href: /objects/accounts-receivable/dunning-customer/119 arInvoice: id: '1966' key: '1966' invoiceNumber: inv213 invoiceDate: '2025-03-27' dueDate: '2025-03-31' totalBaseAmount: '100.00' totalTxnAmount: '100.00' totalBaseAmountDue: '100.00' referenceNumber: null totalTxnAmountDue: '200.00' href: /objects/accounts-receivable/invoice/1966 href: /objects/accounts-receivable/dunning-invoice/4009 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/dunning-notice: get: summary: List dunning notices description: >- Returns a collection with a key, ID, and link for each dunning notice. This operation is mostly for use in testing; use the [query service](/openapi/common/core.query/tag/Query) to find objects that meet certain criteria and to specify properties that are returned. tags: - Dunning notices operationId: list-accounts-receivable-dunning-notice responses: '200': description: OK content: application/json: schema: type: object title: List of dunning-notice objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List dunning notices: value: ia::result: - key: '1' id: '1' href: /objects/accounts-receivable/dunning-notice/1 - key: '4' id: '4' href: /objects/accounts-receivable/dunning-notice/4 - key: '2' id: '2' href: /objects/accounts-receivable/dunning-notice/2 - key: '3' id: '3' href: /objects/accounts-receivable/dunning-notice/3 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a dunning notice description: Creates a new dunning notice. tags: - Dunning notices operationId: create-accounts-receivable-dunning-notice requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-dunning-notice' - $ref: '#/components/schemas/accounts-receivable-dunning-noticeRequiredProperties' examples: Create a printed dunning notice: value: basedOn: dueDate asOfDate: '2025-04-18' dunningLevel: id: L1 printTemplateName: L1 DL Doc Template dunningCustomers: - customer: id: '1' noticeEmail: bcc: null cc: null to: accounts@mycompany.com sendPrintedNotice: false sendEmailNotice: false - customer: id: BTI noticeEmail: bcc: null cc: null to: accounts@mycompany.com sendPrintedNotice: false sendEmailNotice: false sender: email: bblank@mycompany.com responses: '201': description: Created content: application/json: schema: type: object title: New dunning-notice properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new dunning notice: value: ia::result: id: '11' key: '11' href: /objects/accounts-receivable/dunning-notice/11 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/dunning-notice/{key}: parameters: - name: key description: System-assigned unique key for the dunning notice. in: path example: '11' required: true schema: type: string get: summary: Get a dunning notice description: Returns detailed information for a specified dunning notice. tags: - Dunning notices operationId: get-accounts-receivable-dunning-notice-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the dunning-notice properties: ia::result: $ref: '#/components/schemas/accounts-receivable-dunning-notice' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a dunning notice: value: ia::result: id: '48' key: '48' dunningLevel: key: '12' id: L1 href: /objects/accounts-receivable/dunning-level/12 basedOn: dueDate currency: USD baseCurrency: USD asOfDate: '2025-04-18' printTemplateName: L1 DL Doc Template emailTemplate: key: null id: null attachInvoice: false sender: email: bblank@mycompany.com name: Bill Blank phone: 123-456-7890 audit: createdDateTime: '2025-05-09T10:14:21Z' modifiedDateTime: '2025-05-09T10:14:21Z' createdBy: '1' modifiedBy: '1' dunningCustomers: - id: '129' key: '129' dunningNoticeCustomerId: DN-116 dunningNotice: id: '48' key: '48' href: /objects/accounts-receivable/dunning-notice/48 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 invoiceCount: 3 totalAmountOverdue: '2307.00' totalTxnAmountOverdue: '2307.00' noticeEmail: date: '2025-05-09' to: jdoe@mycompany.com cc: null bcc: null dunningNoticeAttachment: null deliveryMethod: printed invoices: - id: '4462' key: '4462' dunningCustomer: id: '129' key: '129' href: '/objects/accounts-receivable/dunning-customer/129' arInvoice: id: '164' key: '164' invoiceNumber: inv-2 invoiceDate: '2025-02-25' dueDate: '2025-02-30' totalBaseAmount: '100.00' totalTxnAmount: '100.00' totalBaseAmountDue: '100.00' referenceNumber: new_document totalTxnAmountDue: '2307.00' href: /objects/accounts-receivable/invoice/164 href: '/objects/accounts-receivable/dunning-invoice/4462' - id: '4464' key: '4464' dunningCustomer: id: '129' key: '129' href: '/objects/accounts-receivable/dunning-customer/129' arInvoice: id: '310' key: '310' invoiceNumber: inv-2 invoiceDate: '2025-03-25' dueDate: '2025-03-30' totalBaseAmount: '100.00' totalTxnAmount: '100.00' totalBaseAmountDue: '100.00' referenceNumber: new_document totalTxnAmountDue: '2307.00' href: /objects/accounts-receivable/invoice/310 href: '/objects/accounts-receivable/dunning-invoice/4464' href: /objects/accounts-receivable/dunning-notice/48 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] components: schemas: accounts-receivable-account-labelRequiredProperties: type: object required: - id - description - glAccount 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 number of members in the result set. readOnly: true example: 3 start: type: integer description: First member of the result set included in the current response. readOnly: true example: 1 pageSize: type: integer description: >- Maximum number of members included in the current response. The response may contain fewer members if the final page of the result set is smaller than the page size. readOnly: true example: 100 next: type: integer description: First member number of the next page of results. readOnly: true nullable: true example: 101 previous: type: integer description: First member number of the previous page of results. readOnly: true nullable: true example: null metadata: description: Metadata for response type: object properties: totalCount: type: integer description: Total count readOnly: true example: 3 totalSuccess: type: integer description: Total success readOnly: true example: 2 totalError: type: integer description: Total errors readOnly: true example: 1 error-response: type: object description: Error response properties: ia::result: type: object properties: ia::error: type: object properties: code: type: string example: invalidRequest message: type: string example: Payload contains errors supportId: type: string example: sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ errorId: type: string example: REST-1064 additionalInfo: type: object properties: messageId: type: string example: IA.PAYLOAD_CONTAINS_ERRORS placeholders: type: object example: {} propertySet: type: object example: {} details: type: array items: type: object properties: code: type: string example: invalidRequest message: type: string example: /newDate is not a valid field errorId: type: string example: REST-1043 target: type: string example: /newDate additionalInfo: type: object properties: messageId: type: string example: IA.NOT_A_VALID_FIELD placeholders: type: object example: {} propertySet: type: object example: {} ia::meta: $ref: '#/components/schemas/metadata' example: ia::result: ia::error: code: invalidRequest message: A POST request requires a payload errorId: REST-1028 additionalInfo: messageId: IA.REQUEST_REQUIRES_A_PAYLOAD placeholders: OPERATION: POST propertySet: {} supportId: Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo ia::meta: totalCount: 1 totalSuccess: 0 totalError: 1 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 audit.s1: type: object readOnly: true properties: createdDateTime: description: Date-time when this record was created. type: string format: date-time readOnly: true example: '2023-05-16T15:34:35Z' modifiedDateTime: description: Date-time when this record was modified. type: string format: date-time readOnly: true example: '2024-09-14T21:23:42Z' createdBy: description: Key for the user who created this object. type: string readOnly: true nullable: true deprecated: true example: '436' modifiedBy: description: Key for the user who last modified this object. type: string readOnly: true nullable: true deprecated: true example: '3086' createdByUser: type: object description: The user who created this object. readOnly: true properties: key: type: string description: User key. readOnly: true nullable: true example: '436' id: type: string description: User login ID. readOnly: true nullable: true example: JohnDoe href: type: string readOnly: true description: URL endpoint for the user. example: /objects/company-config/user/436 modifiedByUser: type: object description: The user who last modified this object. readOnly: true properties: key: type: string description: User key. readOnly: true nullable: true example: '3086' id: type: string description: User login ID. readOnly: true nullable: true example: JaneDoe href: type: string readOnly: true description: URL endpoint for the user. example: /objects/company-config/user/3086 entity-ref: type: object description: >- The entity that the object is associated with. Objects created at the top level do not have an entity reference so the `key`, `id`, and `name` properties will be `null`. readOnly: true properties: key: type: string description: Entity key. readOnly: true nullable: true example: '46' id: type: string description: Entity ID. readOnly: true nullable: true example: CORP name: type: string description: Entity name. readOnly: true nullable: true example: Corp href: type: string description: URL endpoint for the entity. readOnly: true example: /objects/company-config/entity/46 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 href: type: string description: Endpoint for the AR account label. readOnly: true example: /objects/accounts-receivable/account-label/23 description: type: string description: A note about the purpose and use of the account label. example: Software sales isTaxable: type: boolean description: >- Set to true to enable Advanced Tax to calculate the sales tax automatically. example: false default: false isSubtotal: type: boolean description: >- Set to true if the account label is for a subtotal type. This field is applicable only for entities that use the Avalara AvaTax solution. By default, Accounts Receivable is automatically configured to display tax and subtotal fields for invoices. example: false default: false isTax: type: boolean description: >- Set to true only if the account label is for a subtotal and the subtotal is for a tax, such as sales tax or excise tax. Do not enable for other subtotals, such as discounts, shipping, or handling charges. This field is applicable only for entities that use the Avalara AvaTax. example: true default: false taxGroup: type: object description: >- Tax group to which the label is assigned. Account label tax groups organize taxable account labels under one tax category. Relevant only for companies configured to use Advanced Tax, and only if this account label is not a subtotal. properties: key: type: string description: System-assigned key for the tax group. nullable: true example: '23' id: type: string description: Unique identifier for the tax group. nullable: true example: Goods Exempt Rate - CA href: type: string description: Endpoint URL for the tax group. readOnly: true example: /objects/tax/account-label-tax-group/23 taxCode: type: string description: AR account labels Tax Code. nullable: true example: CST 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. nullable: true example: '2' id: type: string description: Account number for the offset general ledger account. nullable: true example: 1215--EquipmentOffset href: type: string readOnly: true example: /objects/general-ledger/account/2 glAccount: type: object description: General ledger account this AR account label is assigned to. properties: href: type: string description: Endpoint for the glaccount. readOnly: true example: /objects/general-ledger/account/356 id: type: string description: General ledger account number. example: '1501' key: type: string description: System-assigned key for the general ledger account. example: '356' revenueRecognitionTemplate: type: object properties: key: type: string description: System-assigned key for the revenue recognition template. nullable: true example: '1' id: type: string description: Unique identifier for the revenue recognition template. nullable: true example: Straight Line href: type: string description: URL for the revenue recognition template. example: /objects/accounts-receivable/revenue-recognition-template/1 readOnly: true deferredRevenueGLAccount: type: object properties: key: type: string description: System-assigned key for the revenue gl account. nullable: true example: '1' id: type: string description: Unique identifier for the revenue gl account. nullable: true example: '1001' href: type: string description: URL for the deffer revenue gl account template. example: /objects/general-ledger/account/356 readOnly: true status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit.s1' entity: $ref: '#/components/schemas/entity-ref' accounts-receivable-adjustmentRequiredProperties: type: object required: - createdDate properties: customer: required: - id example: '1' txnCurrency: required: - currency example: USD adjustmentSummary: required: - id example: 'AR Summary: 2022/01/01 Batch' lines: type: array items: type: object properties: glAccount: required: - id example: '2995' txnCurrency: required: - amount example: '100' dimensions: properties: location: required: - id example: '1' example: location: id: '1' accounts-receivable-adjustment-tax-entry: type: object description: >- For VAT enabled transactions, adjustment line items will have tax entries. allOf: - title: Tax entries description: Tax entries for line items. type: object properties: key: type: string description: System-assigned key for the tax entry. example: '7149' readOnly: true id: type: string description: Unique identifier for 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. For a PATCH request, set to `null` if you want Sage Intacct to recalculate the amount, or set to the value you want if you don't want the system to recalculate. format: decimal-precision-2 example: '100.00' taxRate: type: number description: Tax rate. example: 1.0299 - type: object properties: orderEntryTaxDetail: type: object description: >- Order Entry tax details associated with the adjustment tax entry. properties: key: type: string description: Unique key for the tax detail. example: '1' id: type: string description: Unique identifier for the tax detail. example: Alaska Tax Detail href: type: string description: URL endpoint of the tax detail. readOnly: true example: /objects/tax/order-entry-tax-detail/1 adjustmentLine: title: adjustment-line description: >- Adjustment line item that the adjustment tax entry is associated with. readOnly: true type: object properties: id: type: string description: >- Unique identifier for the adjustment line. This value is the same as the `key` for this object. example: '100' readOnly: true key: type: string description: Unique key for the adjustment line. example: '100' readOnly: true href: type: string description: URL endpoint for the adjustment line. readOnly: true example: /objects/accounts-receivable/adjustment-line/100 dimension-ref: type: object properties: location: type: object properties: key: type: string description: Location key example: '22' nullable: true id: type: string description: Location ID example: LOC-22 nullable: true name: type: string description: Location name readOnly: true example: California nullable: true href: type: string readOnly: true example: /objects/company-config/location/22 department: type: object properties: key: type: string description: Department key example: '11' nullable: true id: type: string description: Department ID example: DEP-11 nullable: true name: type: string description: Department name readOnly: true example: Sales and Marketing nullable: true href: type: string readOnly: true example: /objects/company-config/department/11 employee: type: object properties: key: type: string description: Employee key example: '10' nullable: true id: type: string description: Employee ID example: EMP-10 nullable: true name: type: string description: Employee name readOnly: true example: Thomas, Glenn nullable: true href: type: string example: /objects/company-config/employee/10 readOnly: true project: type: object properties: key: type: string description: Project key example: '2' nullable: true id: type: string description: Project ID example: NET-XML30-2 nullable: true name: type: string description: Project name readOnly: true example: Talcomp training nullable: true href: type: string readOnly: true example: /objects/projects/project/2 customer: type: object properties: key: type: string description: Customer key example: '13' nullable: true id: type: string description: Customer ID example: CUST-13 nullable: true name: type: string description: Customer name readOnly: true example: Jack In the Box nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/customer/13 vendor: type: object properties: key: type: string description: Vendor key example: '357' nullable: true id: type: string description: Vendor ID example: '1605212096809' nullable: true name: type: string description: Vendor name readOnly: true example: GenLab nullable: true href: type: string readOnly: true example: /objects/accounts-payable/vendor/357 item: type: object properties: key: type: string description: Item key example: '13' nullable: true id: type: string description: Item ID example: Case 13 nullable: true name: type: string description: Item name readOnly: true example: Platform pack nullable: true href: type: string readOnly: true example: /objects/inventory-control/item/13 warehouse: type: object properties: key: type: string description: Warehouse key example: '6' nullable: true id: type: string description: Warehouse ID example: WH01 nullable: true name: type: string description: Warehouse name readOnly: true example: WH01 nullable: true href: type: string readOnly: true example: /objects/inventory-control/warehouse/6 class: type: object properties: key: type: string description: Class key example: '731' nullable: true id: type: string description: Class ID example: REST_CLS_001 nullable: true name: type: string description: Class name readOnly: true example: Enterprises nullable: true href: type: string readOnly: true example: /objects/company-config/class/731 task: type: object properties: id: type: string description: Task ID example: '1' nullable: true key: type: string description: Task key example: '1' nullable: true name: type: string description: Task name readOnly: true example: Project Task nullable: true href: type: string readOnly: true example: /objects/projects/task/1 costType: type: object properties: id: type: string description: Cost Type ID example: '2' nullable: true key: type: string description: Cost Type key example: '2' nullable: true name: type: string description: Cost Type name readOnly: true example: Project Expense nullable: true href: type: string readOnly: true example: /objects/construction/cost-type/2 asset: type: object properties: id: type: string description: Asset ID example: A001 nullable: true key: type: string description: Asset key example: '1' nullable: true name: type: string description: Asset name readOnly: true example: Laptop 1 nullable: true href: type: string readOnly: true example: /objects/fixed-assets/asset/1 contract: type: object properties: id: type: string description: Contract ID example: CON-0045-1 nullable: true key: type: string description: Contract key example: '12' nullable: true name: type: string description: Contract name readOnly: true example: ACME Widgets - Service nullable: true href: type: string readOnly: true example: /objects/contracts/contract/12 affiliateEntity: type: object properties: key: type: string description: Affiliate entity key example: '23' nullable: true id: type: string description: Affiliate entity ID example: AFF-23 nullable: true href: type: string readOnly: true example: /objects/affiliate-entity/23 name: type: string readOnly: true description: Affiliate entity name example: 100-USA nullable: true 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 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 format: decimal-precision-2 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 format: decimal-precision-2 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 taxEntries: type: array description: Tax Entries of the AR adjustment items: $ref: '#/components/schemas/accounts-receivable-adjustment-tax-entry' 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.s1' 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 nullable: true 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 tax: type: object title: tax description: Tax related information for the ship-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 ship-to contact. properties: key: type: string description: System-assigned key for the group. example: '288' nullable: true id: type: string description: Unique identifier for the group. example: Goods Zero Rate - CA nullable: true href: type: string description: URL endpoint for the group. readOnly: true example: /objects/tax/contact-tax-group/288 state: type: string description: >- Processing state of the AR adjustment. The state can be modified through workflow operations like Submit and Reverse, but cannot be changed using the PATCH operation. enum: - reversed - reversal - draft - noValue - posted - paid - partiallyPaid - selected example: paid default: posted description: type: string description: Description of the AR adjustment. example: >- Computer Hardware & Software Expenses 03/01/20 - 08/31/21 Subscription charges. nullable: true 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' nullable: true 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' 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 href: type: string description: URL endpoint for the tax solution. readOnly: true example: /objects/tax/tax-solution/4 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 adjustmentSummary: type: object description: >- The payment summary details for this adjustment. Summaries are collections of the same types of transactions grouped together for processing. properties: href: type: string description: URL endpoint for the summary. readOnly: true example: /objects/accounts-receivable/summary/280 key: type: integer description: System-assigned key to uniquely identify the summary. example: 280 id: type: string description: >- Name for the AR summary. The system uses this name to identify the summary throughout the Accounts Receivable application. example: 'AR Summary: 2022/01/01 Batch' 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.s1' - type: object properties: createdDateTime: type: string description: Date and time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true entity: $ref: '#/components/schemas/entity-ref' accounts-receivable-advanceRequiredProperties: type: object properties: customer: required: - id example: '1' paymentInformation: required: - paymentDate - paymentMethod - receiptDate example: paymentDate: '2024-05-10' paymentMethod: cash receiptDate: '2024-05-10' items: type: array items: type: object properties: glAccount: required: - id example: glAccount: id: '4010' dimensions: properties: location: required: - id example: '1' example: location: id: '1' required: - txnAmount example: txnAmount: id: '100' 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 location-ref: 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 for the location. example: /objects/company-config/location/1 readOnly: true 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: >- ID for the AR advance line. This value is the same as the `key` for this object. readOnly: true example: '23' href: type: string description: URL 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 the company's base currency. 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 line item. 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 of the AR advance line item. readOnly: true example: 5 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: Unique key for the account label. example: '14' id: type: string description: Name or other unique ID for the account label. example: Accounting Fees name: type: string description: Name of the account label. readOnly: true example: Accounting Fees href: type: string description: URL 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: Location associated with the AR advance line item. title: location properties: key: type: string description: Unique key for the location. example: '4' id: type: string description: Unique ID for the location. example: AU name: type: string description: Name of the location. readOnly: true example: Australia href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/4 department: type: object description: Department associated with the AR advance line item. title: department properties: key: type: string description: Unique key for the department. example: '9' id: type: string description: Unique ID for the department. example: '01' name: type: string description: Name of the department. readOnly: true example: Accounting href: type: string description: URL 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: Unique ID for the AR advance. readOnly: true example: '23' key: type: string description: Unique key for the AR advance. readOnly: true example: '23' href: type: string description: URL 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.s1' accounts-receivable-advance: type: object description: >- Advances record an advance payment from a customer. This object provides header information for an Accounts Receivable advance transaction. properties: key: type: string description: System-assigned unique key for the advance. readOnly: true example: '23' id: type: string description: AR advance ID. This value is the same as the key for this object. readOnly: true example: '23' recordType: type: string description: >- Record type to identify the type of transaction. AR advances have a record type of `rr`. readOnly: true example: rr href: type: string description: URL endpoint for the advance. readOnly: true example: /objects/accounts-receivable/advance/23 referenceNumber: type: string description: >- This is a number that might be useful in searches or reports, such as a transaction number from the bank, a purchase order number, or an account number. This number is listed in the GL Details report. example: INV-902852 description: type: string description: Brief description of the advance payment. example: 08/31/21 Subscription charges advanceNumber: type: string description: >- If document sequencing is enabled, specifies the auto-generated document sequence number for the advance. If document sequencing is not enabled, this field is null. readOnly: true nullable: true example: Advance-001 state: type: string description: >- Processing state of the AR advance. The state can be modified through workflow operations like Submit and Reverse, but cannot be changed using the PATCH operation. enum: - reversed - reversal - draft - reconciled - fullyApplied - partiallyApplied - posted - selected example: posted totalEntered: type: string format: decimal-precision-2 description: Total amount of the AR advance. example: '100.00' txnTotalEntered: type: string format: decimal-precision-2 description: Total transaction amount of the AR advance. example: '200.20' paymentInformation: type: object description: Payment information for the AR advance. properties: paymentDate: type: string format: date example: '2021-01-23' description: Date the advance was paid. totalPaid: type: string format: decimal-precision-2 description: Total amount paid for the advance. readOnly: true example: '100' totalSelected: type: string format: decimal-precision-2 description: Total amount selected for the advance. readOnly: true example: '100.10' txnTotalSelected: type: string format: decimal-precision-2 description: Total transaction amount selected. readOnly: true example: '1000.05' txnTotalPaid: 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 amount due for the advance. readOnly: true example: '251464.01' totalTxnAmountDue: type: string format: decimal-precision-2 description: Total transaction amount due for the advance. readOnly: true example: '10' paymentMethod: type: string description: Payment method for the advance. nullable: false example: printedCheck enum: - printedCheck - creditCard - eft - cash - ach receiptDate: type: string format: date description: >- The date on which the check, cash, credit card, or bank transfer for the advance was received. example: '2024-01-25' financialEntity: type: object description: Financial account from which the reconciliation is done. properties: key: type: string description: Unique key for the bank account. readOnly: true example: '1002' id: type: string description: Account number or other unique ID for the bank account. example: BOA href: type: string description: URL endpoint for the bank account. readOnly: true example: /objects/cash-management/bank-account/10 currency: $ref: '#/components/schemas/currency' reconciliationGroup: type: object description: Reconciliation information for the advance transaction. readOnly: true properties: clearingDate: type: string format: date description: Automatically added when reconciliation is complete. readOnly: true example: '2021-01-23' cleared: type: string enum: - 'true' - 'false' - matched description: >- Status to indicate the reconciliation stage of the advance. If `true`, the advance has been reconciled. If `false`, the advance has not been reconciled. If `matched`, the advance has been matched for reconciliation, which is pending. default: 'false' readOnly: true example: 'false' isSystemGenerated: type: boolean description: Indicates whether the advance is system-generated. example: false default: false readOnly: true createdDate: type: string format: date description: Date the advance was created. readOnly: true example: '2024-02-06' deposit: type: object description: Deposit associated with the advance. readOnly: true properties: key: type: string description: Unique key for the deposit. readOnly: true example: '10' id: type: string description: ID for the deposit. readOnly: true example: '10' href: type: string description: URL endpoint for the deposit. readOnly: true example: /objects/cash-management/deposit/10 advanceSummary: type: object description: >- The payment summary details for this advance. Summaries are collections of the same types of transactions grouped together for processing. properties: href: type: string description: URL endpoint for the summary. readOnly: true example: /objects/accounts-receivable/summary/280 key: type: string description: Unique key for the summary. example: '280' id: type: string description: ID for the summary. example: '280' customer: type: object description: Customer from whom the advance was received. properties: href: type: string description: URL 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: Unique key for the customer. example: '23' name: type: string description: Name of the customer. example: Logic Solutions glAccount: type: object description: GL account associated with the advance. properties: href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/356 id: type: string description: General ledger account number. example: '1501' key: type: string description: Unique key for the general ledger account. example: '356' undepositedGLAccountNumber: type: string description: Undeposited funds account number for the general ledger account. example: '100444' attachment: type: object description: Supporting document for the advance. properties: key: type: string description: System-assigned key for the attachment. example: '21' id: type: string description: ID for the attachment. example: Sales01 href: type: string description: URL endpoint for the attachment. 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' entity: $ref: '#/components/schemas/entity-ref' audit: readOnly: true type: object allOf: - $ref: '#/components/schemas/audit.s1' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2024-01-23T11:28:12Z' readOnly: true accounts-receivable-advance-lineRequiredProperties: type: object required: - txnAmount accounts-receivable-billback-templateRequiredProperties: type: object required: - id - description properties: lines: type: array items: type: object properties: invoiceGLAccount: type: object required: - key billGLAccount: type: object required: - key accounts-receivable-billback-template-line: type: object description: >- Line items in a bill back template provide the GL accounts and department to use for line items in corresponding invoices and bills. properties: key: type: string description: System-assigned key for the bill back template line. readOnly: true example: '5' id: type: string description: >- Unique ID for the bill back template line. This value is the same as the `key` for this object. readOnly: true example: '5' href: type: string description: URL endpoint for the bill back template line. readOnly: true example: /objects/accounts-receivable/billback-template-line/5 lineNumber: type: string description: Number of the line item in the bill back template. readOnly: true example: '2' memo: type: string description: Memo about the line item. example: Line number 2 invoiceGLAccount: type: object description: The GL account to use for associated invoice line items. properties: key: type: string description: Unique key for the GL account. example: '5' id: type: string description: Unique ID for the GL account. example: '4000' name: type: string description: Name of the GL account. example: Sales href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/5 billGLAccount: type: object description: The GL account to use for associated bill line items. properties: key: type: string description: Unique key for the GL account. example: '6' id: type: string description: Unique ID for the GL account. example: '2000' name: type: string description: Name of the GL account. example: School Fees href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/6 department: type: object description: Department to include on associated invoices. properties: key: type: string description: Unique key for the department. example: '9' id: type: string description: Unique ID for the department. example: '11' name: type: string description: Name of the department. example: Accounting href: type: string description: URL endpoint for department. readOnly: true example: /objects/company-config/department/9 billbackTemplate: description: Header level details for the template line items. type: object properties: id: type: string description: Unique ID for the bill back template. readOnly: true example: '5' key: type: string description: Unique key for the bill back template. readOnly: true example: '5' href: type: string description: URL endpoint for the bill back template. readOnly: true example: /objects/accounts-receivable/billback-template/5 readOnly: true accounts-receivable-billback-template: type: object description: >- Bill back templates are used in multi-entity companies to generate an invoice and corresponding bill when one entity provides goods or services to another entity. properties: key: type: string description: System-assigned key for the bill back template. readOnly: true example: '23' id: type: string description: Unique ID for the bill back template. example: Template 1 href: type: string description: URL endpoint for the bill back template. readOnly: true example: /objects/accounts-receivable/billback-template/23 description: type: string description: Description of the template. example: Bill back template for India 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' entity: $ref: '#/components/schemas/entity-ref' lines: type: array description: Line items in the bill back template. items: $ref: '#/components/schemas/accounts-receivable-billback-template-line' accounts-receivable-customerRequiredProperties: type: object required: - 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 default: active contact-ref: type: object properties: key: type: string description: System-assigned unique key for the contact. 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. deprecated: true example: Smith nullable: true firstName: type: string description: First name. example: John deprecated: true nullable: true middleName: type: string description: Middle name. example: Archibald deprecated: true nullable: true prefix: type: string description: Prefix, such as Mr., Mrs., or Ms. example: Mr deprecated: true nullable: true printAs: type: string description: The contact's name as it will appear on documents. deprecated: true example: John Smith email1: type: string description: Primary email address. example: jsmith@company.com deprecated: true nullable: true email2: type: string description: Secondary email address. example: john@aol.com deprecated: true nullable: true phone1: type: string description: Primary phone number. example: '14085551212' deprecated: true nullable: true phone2: type: string description: Secondary phone number. example: '14085559876' deprecated: true nullable: true mobile: type: string description: Mobile phone number. example: '14085554420' deprecated: true nullable: true pager: type: string description: Pager number. example: '14085559987' deprecated: true nullable: true fax: type: string description: Fax number. example: '14085555309' deprecated: true nullable: true URL1: type: string description: Web page address for this contact. example: https://mycompany.com deprecated: true nullable: true URL2: type: string description: Secondary web page address. example: https://anothercompany.com deprecated: true nullable: true companyName: type: string description: Name of the company. example: AlcoSoft Inc deprecated: true nullable: true mailingAddress: type: object description: Mailing address. properties: addressLine1: type: string description: The first address line for shipping, billing, etc. example: 300 Park Avenue deprecated: true nullable: true addressLine2: type: string description: The second address line for shipping, billing, etc. example: Suite 1400 deprecated: true nullable: true addressLine3: type: string description: >- The third address line for shipping, billing, etc. which provides additional geographical information. example: Western industrial area deprecated: true nullable: true city: type: string description: City. example: San Jose deprecated: true nullable: true state: type: string description: State. example: California deprecated: true nullable: true postCode: type: string description: Zip or Postal Code. example: '95110' deprecated: true nullable: true country: type: string description: Country. This field is deprecated, please use `isoCountryCode`. deprecated: true default: US example: United States nullable: true isoCountryCode: type: string description: >- ISO country code. This field takes prevalence over `country` which is now deprecated. default: US example: US deprecated: true nullable: true 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.s1' 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 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 templateType: type: string description: >- Specify the type of transaction that will use the email template. enum: - arInvoice - arStatement - contract - orderEntryTxn - purchasingTxn example: arInvoice default: arInvoice readOnly: true href: type: string description: URL of the email template. readOnly: true example: /objects/company-config/email-template/1 accounts-receivable-customer-restricted-location: type: object description: >- In shared multi-entity companies, customers can be restricted to specific locations or location groups to prevent the customer from being used in the wrong entity. properties: key: type: string description: System-assigned key for the customer restricted location. readOnly: true example: '51' id: type: string description: ID for the customer restricted location. readOnly: true example: '51' href: type: string description: URL endpoint for the customer restricted location. readOnly: true example: /objects/accounts-receivable/customer-restricted-location/51 location: type: object description: Location to which the customer is restricted. properties: key: type: string description: Unique key for the location. example: '14' id: type: string description: Unique ID for the location. example: '14' href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/14 locationGroup: type: object description: Location group to which the customer is restricted. properties: key: type: string description: System-assigned key for the location group. example: '66' id: type: string description: Unique identifier for the location group. example: '66' href: type: string description: Endpoint for the location group. readOnly: true example: /objects/company-config/location-group/66 customer: type: object description: Customer that is restricted. properties: key: type: string description: System-assigned key for the customer. readOnly: true example: '89' id: type: string description: Unique ID for the customer. readOnly: true example: C89 href: type: string description: URL endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/89 accounts-receivable-customer-restricted-department: type: object description: >- In shared multi-entity companies, customers can be restricted to specific departments or department groups to prevent the customer from being used in the wrong entity. properties: key: type: string description: System-assigned key for the customer restricted department. readOnly: true example: '31' id: type: string description: Unique ID for the customer restricted department. readOnly: true example: '31' href: type: string description: URL endpoint for the customer restricted department. readOnly: true example: /objects/accounts-receivable/customer-restricted-department/31 department: type: object description: Department to which the customer is restricted. readOnly: true properties: key: type: string description: Unique key for the department. example: '41' id: type: string description: User-defined ID for the department. example: Eng href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/41 departmentGroup: type: object description: Department group to which the customer is restricted. readOnly: true properties: key: type: string description: Unique key for the department group. example: '46' id: type: string description: Unique ID for the department group. example: SW href: type: string description: URL endpoint for the department group. readOnly: true example: /objects/company-config/department-group/46 customer: type: object description: Customer that is restricted. properties: key: type: string description: Unique key for the customer. readOnly: true example: '23' id: type: string description: Unique ID for the customer. readOnly: true example: C23 href: type: string description: URL endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/23 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: showInContactList: type: boolean description: >- Set to `true` to display the contact in the contact list. default: true 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 solution: type: object description: Tax solution for this customer. properties: key: type: string description: System-assigned key for the tax solution. example: '90' id: type: string description: Identifier for the tax solution. example: Los Angeles href: type: string description: URL for the tax solution. readOnly: true example: /objects/tax/tax-solution/90 electronicInvoiceDetails: type: object description: >- For businesses operating in France, the following fields are required to comply with local electronic invoicing. properties: legalCategory: type: string description: >- Identifies the type of organization under French law, encompassing various recognized forms for both private and public entities. example: 24 Fiduciary mainActivity: type: string description: >- Specifies the primary economic activities the business engages in, helping classify the nature of operations. example: >- 10.3 Transformation and conservation of fruits and vegetables typeOfCompany: type: string description: >- Classifies the business entity based on legal structure, size, activities, or other key characteristics. example: 03 Intermediate sized enterprises registeredCapital: type: integer description: >- Represents the total capital invested by shareholders upon the company's formation. example: 37 000 valueAddedTaxRegime: type: string description: >- Details the specific VAT rules and regulations applicable to the business, including requirements for VAT collection, application, and reporting within France. example: Monthly internationalTaxId: type: string description: Business identification number for EU companies. example: '123' 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' audit: $ref: '#/components/schemas/audit.s1' 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 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 format: decimal-precision-2 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 default: print 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 - billingContact - shippingContact default: customer example: billingContact customerMessage: type: object description: Message to include on the customer's invoice. properties: key: type: string description: System-assigned key for the customer message. example: '10' id: type: string description: ID for the customer message. example: welcome message message: type: string description: Message text for the customer message. example: welcome to the company href: type: string description: URL endpoint for the customer message. readOnly: true example: /objects/accounts-receivable/customer-message/10 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 deprecated: 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 href: type: string description: URL for the territory. readOnly: true example: /objects/accounts-receivable/territory/6 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' nullable: true id: type: string description: ID for the attachment. example: Sales01 nullable: true 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 customerRestriction: type: string description: Customer visibility type. example: restricted default: unrestricted enum: - unrestricted - rootOnly - restricted restrictedLocations: type: array description: Restricted locations for the customer. items: $ref: '#/components/schemas/accounts-receivable-customer-restricted-location' restrictedDepartments: type: array description: Restricted departments for the customer. items: $ref: '#/components/schemas/accounts-receivable-customer-restricted-department' entity: $ref: '#/components/schemas/entity-ref' accounts-receivable-customer-email-templateRequiredProperties: type: object properties: customer: required: - key example: '127' emailTemplate: required: - key example: '1' 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.s1' 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-customer-messageRequiredProperties: type: object required: - id - message accounts-receivable-customer-message: type: object description: This object represents a message associated with a customer. properties: key: type: string description: System-assigned key for the customer message. readOnly: true example: '23' id: type: string description: Unique ID for the customer message. example: Message 1 href: type: string description: URL endpoint for the customer message. readOnly: true example: /objects/accounts-receivable/customer-message/23 message: type: string description: Message text. example: Express shipping now available! status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit.s1' 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.s1' entity: $ref: '#/components/schemas/entity-ref' accounts-receivable-customer-total: type: object description: Provides information about the total amount due from a customer. readOnly: true properties: key: type: string description: System-assigned key for the customer total. readOnly: true example: '1' id: type: string description: Unique ID for the customer total. readOnly: true example: '5' href: type: string description: URL endpoint for the customer total. readOnly: true example: /objects/accounts-receivable/customer-total/1 totalDue: type: string description: Total amount due from the customer. format: decimal-precision-2 readOnly: true example: '500.01' customer: type: object description: The customer who owes the total amount due. readOnly: true properties: key: type: string description: Unique key for the customer. example: '5' readOnly: true id: type: string description: Unique ID for the customer. example: cust_id_531214 readOnly: true name: type: string description: Name of the customer. example: cnxt readOnly: true href: type: string description: URL endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/5 entity: type: object allOf: - $ref: '#/components/schemas/entity-ref' - type: object properties: id: type: string description: ID for the entity location. readOnly: true example: NYC name: type: string description: Name of the entity location. example: New York City accounts-receivable-customer-groupRequiredProperties: type: object required: - id - name member-filter: description: Member filter. type: object properties: object: type: string description: >- Object type to filter on. Must match the type of object contained in the group, such as `company-config/department` or `company-config/employee`. filters: type: array description: >- Filters to select the records to return based on their field values. You use operators and conditions to build your filter, such as `{"$eq":{"status":"active"}}` to select records in which `status` is equal to "active". example: - $eq: status: active - $gt: totalDue: '1000' - $contains: name: Acme items: anyOf: - title: equal type: object description: Field value must be equal to this specified value. 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. 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. 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. 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. 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. 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. 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. 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: 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 orderBy: description: >- Sort order for the results that match the `filters` when the group is displayed in reports. The entry consists of a field name to sort by and whether it should be sorted in ascending or descending order. type: array maxItems: 1 items: type: object title: field name and sort order additionalProperties: type: string enum: - asc - desc example: - id: asc size: description: >- The maximum number of records that match the `filters` to include in the group when it is displayed in reports. type: integer example: 100 accounts-receivable-customer-group: type: object description: >- A customer group categorizes customer dimension records, mainly for the purpose of structuring financial reporting. properties: key: type: string description: System-assigned unique key for the customer group. readOnly: true example: '25' id: type: string description: Unique ID for the customer group. example: CustomerGrp4 href: type: string description: URL endpoint for the customer group. readOnly: true example: /objects/accounts-receivable/customer-group/25 name: type: string description: Name of the customer group. example: Active JC Customers description: type: string description: Description of the customer group. example: Charity service customers groupType: type: string description: "Specifies the group membership type. The group type and related fields determine which customers are included in the group.\n* `specific` - Specify the customers to include and their order in the `groupMembers` array.\n* `all` - All customers that match the `memberFilter` criteria. \n" enum: - all - specific default: all example: all memberFilter: type: object description: >- One or more filters to select the customers to include in the customer group. Can be used in addition to the `groupMembers` array to filter from a selected list of customers. allOf: - $ref: '#/components/schemas/member-filter' - type: object groupMembers: type: array description: >- Members of the customer group and their sort order. Only applicable when the `groupType` is set to `specific`. items: type: object properties: key: type: string description: Unique key for the customer. example: '23' id: type: string description: Unique ID for the customer. example: '23' href: type: string description: URL endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/23 sortOrder: type: string description: >- Customer group sort order. Determines the position of the member within the customer group. Lower values indicate earlier placement. readOnly: true example: '2' isDimensionStructure: type: boolean description: >- Indicates whether a dimension structure is created from the group. If true, the group can be added to the rows or columns of a financial report. default: false example: false audit: $ref: '#/components/schemas/audit.s1' entity: $ref: '#/components/schemas/entity-ref' accounts-receivable-delivery-history: type: object description: History of invoices delivered by print or email. properties: key: type: string description: System-assigned unique key for the delivery history. readOnly: true example: '23' id: type: string description: >- Delivery history ID. This value is the same as the `key` for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the delivery history. readOnly: true example: /objects/accounts-receivable/delivery-history/23 object: type: string description: Object that was delivered. readOnly: true example: invoice description: type: string description: This field has been deprecated. Use the `module` field instead. deprecated: true module: type: string description: The Sage Intacct application module the invoice was delivered from. readOnly: true example: AR documentDate: type: string format: date description: The date of the invoice. readOnly: true example: '2025-02-19' deliveryDate: type: string format: date description: The date the invoice was delivered. readOnly: true example: '2025-02-20' deliveryOptions: type: string description: >- This field has been deprecated. Use the `deliveryMethod` field instead. default: print enum: - print - email - onlineDelivery - printEmail deprecated: true deliveryMethod: type: string description: Method used to deliver the invoice. default: print example: print enum: - print - email - onlineDelivery - printEmail readOnly: true data: type: string description: The data that makes up the invoice. readOnly: true example: Blob data attachment: type: object description: Supporting document attached to the invoice. readOnly: true properties: href: type: string description: URL endpoint for the attachment. readOnly: true example: /objects/company-config/attachment/21 key: type: string description: Unique key for the attachment. readOnly: true example: '21' id: type: string description: ID for the attachment. readOnly: true example: '21' 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' example: location: id: '1' required: - txnAmount example: txnAmount: '100.00' glAccount: id: '4010' dimensions: location: id: '1' required: - invoiceDate - dueDate accounts-receivable-invoice-tax-entry: type: object description: For VAT enabled transactions, invoice line items will have tax entries. allOf: - title: Tax entries description: Tax entries for line items. type: object properties: key: type: string description: System-assigned key for the tax entry. example: '7149' readOnly: true id: type: string description: Unique identifier for 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. For a PATCH request, set to `null` if you want Sage Intacct to recalculate the amount, or set to the value you want if you don't want the system to recalculate. format: decimal-precision-2 example: '100.00' taxRate: type: number description: Tax rate. example: 1.0299 - type: object properties: orderEntryTaxDetail: type: object description: Order Entry tax details associated with the invoice tax entry. properties: key: type: string description: Unique key for the Order Entry tax detail. example: '1' id: type: string description: Unique identifier for the Order Entry tax detail. example: Alaska Tax Detail href: type: string description: URL endpoint for the Order Entry tax detail. readOnly: true example: /objects/tax/order-entry-tax-detail/1 invoiceLine: title: invoice-line description: Invoice line item that the invoice tax entry is associated with. readOnly: true type: object properties: id: type: string description: Unique identifier for the invoice line. example: '100' readOnly: true key: type: string description: >- Unique key for the invoice line. This value is the same as the `key` for this object. example: '100' readOnly: true href: type: string description: URL endpoint for the invoice line. readOnly: true example: /objects/accounts-receivable/invoice-line/100 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 href: type: string readOnly: true example: /objects/general-ledger/txn-allocation-template/21 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 taxEntries: type: array description: Tax entries for the AR invoice. items: $ref: '#/components/schemas/accounts-receivable-invoice-tax-entry' 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.s1' 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' action: type: string description: This field has been deprecated. Use the `state` field instead. writeOnly: true default: submit enum: - submit - draft deprecated: true 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 default: 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: > An invoice's state shows the current status of the invoice within the workflow. The state can be modified through workflow operations like Submit and Reverse, but cannot be changed using the PATCH operation. enum: - reversed - reversal - draft - noValue - posted - paid - partiallyPaid - selected example: posted default: posted 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: This field is deprecated, please use `salesDocument` field instead. deprecated: true salesDocument: type: object readOnly: true properties: id: type: string description: Document ID of the sales invoice. readOnly: true example: Sales Invoice-SI-00188 key: type: string description: >- System-assigned key to uniquely identify the order entry document. readOnly: true example: '511' href: type: string description: URL endpoint for the order entry document. readOnly: true example: /objects/order-entry/document/511 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 customerMessage: type: object description: Message to include on the customer's invoice. properties: key: type: string description: System-assigned key for the customer message. example: '10' id: type: string description: ID for the customer message. example: welcome message message: type: string description: Message text for the customer message. example: welcome to the company href: type: string description: URL endpoint for the customer message. readOnly: true example: /objects/accounts-receivable/customer-message/10 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) tax: type: object title: tax description: Tax related information for the ship-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 ship-to contact. properties: key: type: string description: System-assigned key for the group. example: '288' nullable: true id: type: string description: Unique identifier for the group. example: Goods Zero Rate - CA nullable: true href: type: string description: URL endpoint for the group. readOnly: true example: /objects/tax/contact-tax-group/288 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 taxSolution: type: object description: Tax solution details for this invoice. 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 href: type: string description: URL endpoint for the tax solution. readOnly: true example: /objects/tax/tax-solution/4 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: Name of the summary. example: 'OE Sales Invoice: 2023 Batch 1' glPostingDate: type: string description: GL posting date for the summary. format: date readOnly: true example: '2023-02-06' 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 description: URL for the term. readOnly: true example: /objects/accounts-receivable/summary/33 downloadURL: type: string description: Contains download link for an invoice. format: outbound-binary example: >- /services/core/content/download?key=106&resource=objects/accounts-receivable/invoice&field=/downloadURL readOnly: true 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.s1' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true 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: 'Invoices: 2019/12/01 Batch' 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. Record type ri (invoices) example: invoice default: invoice readOnly: true enum: - invoice 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 default: open 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 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: '2024-01-23' customer: required: - id example: '1' txnCurrency: required: - currency example: USD required: - paymentMethod oneOf: - required: - undepositedGLAccount - required: - financialEntity 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 unique key for the AR payment detail object. readOnly: true example: '94' id: type: string description: >- ID for the AR payment detail object. This value is the same as the `key` for this object. readOnly: true example: '94' href: type: string description: URL endpoint for the AR payment detail object. 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: '2024-04-30' discountDate: type: string format: date description: Date the discount was applied. example: '2024-04-30' baseCurrency: type: object description: >- For multi-currency companies, base currency information for the payment detail. properties: paymentAmount: type: string format: decimal-precision-2 description: The amount of the payment in the company's base currency. example: '10' nullable: true inlineAmount: type: string format: decimal-precision-2 description: Inline transaction base amount. readOnly: true example: '10' nullable: true 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: >- For multi-currency companies, transaction currency information for the payment detail. properties: currency: type: string description: Transaction currency. readOnly: true example: USD paymentAmount: type: string description: The amount of the transaction in the payment currency. format: decimal-precision-2 nullable: true 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: Unique key for the inline transaction. example: '89' nullable: true id: type: string description: Inline transaction ID. example: '89' nullable: true href: type: string description: URL endpoint 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: Unique key for the inline transaction line item. example: '4' nullable: true id: type: string description: ID for the inline transaction line item. example: '4' nullable: true href: type: string description: URL endpoint 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: Unique key for the posted advance. readOnly: true nullable: true example: '25' id: type: string description: ID for the posted advance. readOnly: true nullable: true example: '25' href: type: string description: URL endpoint for the posted advance. readOnly: true example: /objects/accounts-receivable/advance/25 postedAdvanceLine: type: object description: Posted advance line item record. readOnly: true properties: key: type: string description: Unique key for the posted advance line item. readOnly: true nullable: true example: '112' id: type: string description: ID for the posted advance line item. readOnly: true nullable: true example: '112' href: type: string description: URL endpoint for the posted advance line item. readOnly: true example: /objects/accounts-receivable/advance-line/112 postedOverPayment: type: object description: Posted overpayment record. readOnly: true properties: key: type: string description: Unique key for the posted overpayment record. readOnly: true nullable: true example: '3328' id: type: string description: ID for the posted overpayment record. readOnly: true nullable: true example: '3328' href: type: string description: URL endpoint 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: Unique key for the posted overpayment line item. readOnly: true nullable: true example: '56' id: type: string description: ID for the posted overpayment line item. readOnly: true nullable: true example: '56' href: type: string description: URL endpoint 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: Unique key for the negative invoice transaction. example: '33' nullable: true id: type: string description: ID for the negative invoice transaction. example: '33' nullable: true href: type: string description: URL endpoint 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: Unique key for the negative invoice transaction line item. example: '4' nullable: true id: type: string description: ID for the negative invoice transaction line item. nullable: true example: '4' href: type: string description: URL endpoint for the negative 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: Unique key for the AR adjustment. example: '41' nullable: true id: type: string description: ID for the AR adjustment. nullable: true example: '41' href: type: string description: URL endpoint for the adjustment. readOnly: true example: /objects/accounts-receivable/adjustment/41 arAdjustmentLine: type: object description: AR adjustment transaction line item record. properties: key: type: string description: Unique key for the adjustment line item. example: '86' nullable: true id: type: string description: ID for the adjustment line item. example: '86' nullable: true href: type: string description: URL endpoint 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: Unique key for the AR invoice. example: '1202' id: type: string description: ID for the AR invoice. example: '1202' href: type: string description: URL endpoint 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: Unique key for the AR invoice line item. example: '6012' id: type: string description: ID for the AR invoice line item. example: '6012' href: type: string description: URL endpoint 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: Unique key for the AR advance. example: '999' nullable: true id: type: string description: ID for the AR advance. example: '999' nullable: true href: type: string description: URL endpoint for the AR advance. readOnly: true example: /objects/accounts-receivable/advance/999 arAdvanceLine: type: object description: AR advance line item record. properties: key: type: string description: Unique key for the AR advance line item. example: '59' nullable: true id: type: string description: ID for the AR advance line item. example: '59' nullable: true href: type: string description: URL endpoint for the AR advance line item. readOnly: true example: /objects/accounts-receivable/advance-line/59 arPostedOverPayment: type: object description: AR posted overpayment record. properties: key: type: string description: Unique key for the posted overpayment. example: '4428' nullable: true id: type: string description: ID for the posted overpayment. example: '4428' nullable: true href: type: string description: URL endpoint 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: Unique key for the posted overpayment line item. nullable: true example: '1642' id: type: string description: ID for the posted overpayment line item. example: '1642' nullable: true href: type: string description: URL endpoint for the posted overpayment line item. readOnly: true example: /objects/accounts-receivable/payment-line/1642 arPayment: type: object description: AR payment record. readOnly: true properties: key: type: string description: Unique key for the AR payment. readOnly: true example: '2527' id: type: string description: ID for the AR payment. readOnly: true example: '2527' href: type: string description: URL endpoint 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: Unique key for the AR payment line. readOnly: true example: '6663' id: type: string description: ID for the AR payment line. readOnly: true example: '6663' href: type: string description: URL endpoint for the AR payment line. readOnly: true example: /objects/accounts-receivable/payment-line/6663 positiveAdjustment: type: object description: Positive adjustment record. properties: key: type: string description: Unique key for the positive adjustment. example: '3379' nullable: true id: type: string description: ID for the positive adjustment. example: '3379' nullable: true href: type: string description: URL endpoint for the positive adjustment. readOnly: true example: /objects/accounts-receivable/adjustment/3379 positiveAdjustmentLine: type: object description: Positive adjustment line item record. properties: key: type: string description: Unique key for the positive adjustment line item. nullable: true example: '5678' id: type: string description: ID for the positive adjustment line item. nullable: true example: '5678' href: type: string description: URL endpoint for the positive adjustment line item. readOnly: true example: /objects/accounts-receivable/adjustment-line/5678 audit: $ref: '#/components/schemas/audit.s1' 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: >- ID for the AR payment line item. This value is the same as the `key` for this object. readOnly: true example: '678' key: type: string description: System-assigned unique key for the AR payment line item. readOnly: true example: '678' href: type: string description: URL endpoint for the AR payment line item. readOnly: true example: /objects/accounts-receivable/payment-line/678 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: 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: >- For payment involving multi-currency, 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: The amount of the line item in the currency for the invoice. readOnly: true example: '10' totalPaid: type: string format: decimal-precision-2 description: Total transaction amount paid for the line item. readOnly: true example: '10' totalSelected: type: string format: decimal-precision-2 description: Total transaction amount 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: '2024-01-23' description: Exchange rate date. readOnly: true rate: type: number description: Exchange rate. readOnly: true example: 1.0789 typeId: type: string description: Exchange rate type. readOnly: true example: '-1' lineNumber: type: number description: Line number of the AR payment line item. readOnly: true example: 1 allocation: type: object description: >- Transaction allocation template for the line item, which distributes the invoice amount across specified dimensions. properties: key: type: string description: Unique key for the allocation template. example: '22' nullable: true id: type: string description: ID for the allocation template. example: Premium Allocation nullable: true href: type: string description: URL endpoint for the allocation template. readOnly: true example: /objects/general-ledger/txn-allocation-template/22 arPayment: type: object description: Header level details for the AR payment's line entries. readOnly: true properties: key: type: string description: Unique key for the AR payment. readOnly: true example: '310' id: type: string description: ID for the AR payment. readOnly: true example: '310' href: type: string description: URL endpoint for the AR payment. readOnly: true example: /objects/accounts-receivable/payment/310 glAccount: type: object description: General Ledger (GL) account associated with the line item. properties: key: type: string description: Unique key for the GL account. example: '87' id: type: string description: GL account number. example: '1100' name: type: string description: GL account title. example: Sales href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/87 offsetGLAccount: type: object description: The GL account where the system posts offsets to this line item. properties: key: type: string description: Unique key for the GL account. example: '83' id: type: string description: GL account number. example: '4000' href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/83 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: Location associated with the AR payment line item. title: location properties: key: type: string description: Unique key for the location. example: '4' id: type: string description: ID for the location. example: US name: type: string description: Name of the location. example: United States href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/4 department: type: object description: Department associated with the AR payment line item. title: department properties: key: type: string description: Unique key for the department. example: '9' id: type: string description: ID for the department. example: ENG name: type: string description: Name of the department. example: Engineering href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/9 audit: $ref: '#/components/schemas/audit.s1' 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 unique 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. The state can be modified through workflow operations like Submit and Reverse, but cannot be changed using the PATCH operation. enum: - complete - reconciled - draft - reversed - reversal example: complete nullable: false default: complete multiEntityPayment: type: object description: Multi-entity payment details. properties: key: type: string description: Unique key for the multi-entity payment. example: '123' readOnly: true nullable: true id: type: string description: ID for the multi-entity payment. readOnly: true nullable: true example: PAY-00136 href: type: string description: URL endpoint for the multi-entity payment. readOnly: true example: /objects/accounts-receivable/payment/123 paymentMethod: type: string description: Payment Method nullable: false 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: '2024-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 nullable: 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 nullable: true example: '2024-04-30' referenceNumber: type: string description: >- Reference number, which can be a transaction number from the bank or a document number. maxLength: 21 nullable: true 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: Unique key for the AR summary. maxLength: 8 example: '1259' id: type: string description: ID for the AR summary. example: '1259' receiptDate: type: string format: date description: Posting date for the AR payment. example: '2024-01-23' title: type: string description: Title of the AR summary. example: 'Receipts (Bank-CHK0002): Batch 02-07-2024' name: type: string description: Name of the AR summary. maxLength: 100 example: Feb 2024 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/356 id: type: string description: Undeposited funds account number. example: '1501' nullable: true key: type: string description: Unique 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: Unique key for the customer. example: '45' entity: type: string description: Customer entity. example: C100 readOnly: true id: type: string description: ID for the customer. maxLength: 21 example: Cust-00064 name: description: Name of the customer, which is usually the company name. type: string example: Gomez Manufacturers 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: Unique key for the attachment. example: '123' id: type: string description: ID 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: '2024-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: Unique key for the pay-to contact. example: '8' id: type: string description: ID for the pay-to contact. example: Klay Vanderbilt href: type: string description: URL endpoint for the pay-to contact. readOnly: true example: /objects/company-config/contact/8 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.s1' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true entity: $ref: '#/components/schemas/entity-ref' accounts-receivable-payment-summaryRequiredProperties: type: object required: - name - glPostingDate 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: '110' id: type: string description: AR payment summary ID. readOnly: true example: '110' href: type: string description: Endpoint for the AR payment summary. readOnly: true example: /objects/accounts-receivable/payment-summary/110 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' nullable: true recordType: type: string description: >- This determines the type of transactions of AR payment summary. Record type rp (payments), ro (overpayment) example: payment enum: - payment - overpayment default: payment readOnly: true totalAmount: type: string description: >- Total amount of transactions in the summary. Transactions amount include quick payments. format: decimal-precision-2 example: '200.00' readOnly: true nullable: 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 default: open parent: type: object description: Parent of the AR payment summary. properties: key: type: string description: System-assigned key for the parent. nullable: true example: '13' id: type: string description: Identifier for the parent. nullable: true 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 nullable: true bankAccount: type: object description: Bank account ID. properties: key: type: string description: System-assigned key for the bank account. example: '1' readOnly: true id: type: string description: Identifier for the bank account. example: BOA currency: type: string description: The currency for this bank account. example: USD href: type: string description: URL for the bankaccount. readOnly: true example: /objects/cash-management/bank-account/1 undepositedGLAccount: type: object description: >- The GL undeposited funds account to use when accumulating payment summary. This account is required if a 'bankAccount' is not specified. properties: key: type: string description: System-assigned key for the undeposited funds account. nullable: true example: '33' id: type: string description: General ledger undeposited funds account number. nullable: true example: '1070' href: type: string description: URL for the undeposited funds account. readOnly: true example: /objects/general-ledger/account/33 isQuickPaymentSummary: type: boolean description: >- This field is set to true only for manual and quick payment summaries. Default is false. example: false default: false entity: $ref: '#/components/schemas/entity-ref' status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit.s1' 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-tax-entry: type: object description: >- For VAT enabled transactions, recurring invoice line items will have tax entries. allOf: - title: Tax entries description: Tax entries for line items. type: object properties: key: type: string description: System-assigned key for the tax entry. example: '7149' readOnly: true id: type: string description: Unique identifier for 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. For a PATCH request, set to `null` if you want Sage Intacct to recalculate the amount, or set to the value you want if you don't want the system to recalculate. format: decimal-precision-2 example: '100.00' taxRate: type: number description: Tax rate. example: 1.0299 - type: object properties: orderEntryTaxDetail: type: object description: >- Order Entry tax details associated with the recurring invoice tax entry. properties: key: type: string description: Unique key for the Order Entry tax detail. example: '1' id: type: string description: Unique identifier for the Order Entry tax detail. example: Alaska Tax Detail href: type: string description: URL endpoint for the Order Entry tax detail. readOnly: true example: /objects/tax/order-entry-tax-detail/1 recurringInvoiceLine: title: recurring-invoice-line description: >- Recurring invoice line item that the recurring invoice tax entry is associated with. readOnly: true type: object properties: id: type: string description: Unique identifier for the recurring invoice line. example: '100' readOnly: true key: type: string description: >- Unique key for the recurring invoice line. This value is the same as the `key` for this object. example: '100' readOnly: true href: type: string description: URL endpoint for the recurring invoice line. readOnly: true example: /objects/accounts-receivable/recurring-invoice-line/100 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 the key for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the line item. readOnly: true example: /objects/accounts-receivable/recurring-invoice-line/23 description: type: string description: >- 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 of the line item. 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 of the line item. format: decimal-precision-2 example: '100.00' totalTxnAmount: type: string format: decimal-precision-2 description: >- For tax inclusive recurring invoices, provide a total transaction amount. example: '100.00' 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: '2024-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: '14' id: type: string description: ID for the allocation. example: Alloc1-WBS-US href: type: string description: URL endpoint for the allocation. readOnly: true example: /objects/general-ledger/txn-allocation-template/14 accountLabel: type: object description: Account label for the account that the line item is assigned to. properties: key: type: string description: Account label key example: '14' id: type: string description: Account label ID example: Accounting Fees href: type: string description: URL endpoint 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: '12' id: type: string description: Tax detail ID example: '12' 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 endpoint for the tax detail. readOnly: true example: /objects/tax/order-entry-tax-detail/12 startDate: type: string format: date description: Revenue recognition start date. nullable: true example: '2024-01-23' endDate: type: string format: date description: Revenue recognition end date. nullable: true example: '2024-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 endpoint 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: '35' 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 endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/35 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: '10' id: type: string description: ID for the location. example: '10' name: type: string description: Name of the location. readOnly: true example: India href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/10 department: type: object description: Department the line item is assigned to. properties: key: type: string description: Department key example: '14' id: type: string description: Department ID example: '14' name: type: string description: Department name readOnly: true example: Accounting href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/14 offsetGLAccount: type: object description: GL account for discounts and penalties. properties: key: type: string description: System-assigned key for the offset GL account. nullable: true 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 endpoint for the offset GL account. readOnly: true example: /objects/general-ledger/account/384 taxEntries: type: array description: Tax Entries of the AR recurring invoice items: $ref: '#/components/schemas/accounts-receivable-recurring-invoice-tax-entry' 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.s1' 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 the key for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the recurring invoice. readOnly: true example: /objects/accounts-receivable/recurring-invoice/23 invoiceNumber: type: string description: >- Each occurrence of the invoice is numbered incrementally based on the sequence type defined in Company Setup - Document Sequence. example: AR-INV totalEntered: type: string format: decimal-precision-2 description: Total amount entered. readOnly: true example: '100.00' taxSolution: type: object description: Tax solution details for this invoice. 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 href: type: string description: URL endpoint for the tax solution. readOnly: true example: /objects/tax/tax-solution/4 description: type: string description: Description of the recurring invoice. nullable: true example: Monthly premium subscription referenceNumber: type: string description: >- A number, such as a purchase order or account number, that may be useful in searches for or reports on this invoice. example: PO1223 scheduledOperation: description: Settings that establish the recurrence schedule. type: object properties: key: type: string description: System-specified key for scheduled operation readOnly: true example: '234' id: type: string description: >- Unique identifier for the schedule operation. This value is the same as the `key` for this object readOnly: true example: '234' href: type: string description: URL endpoint for the Scheduled Operation. readOnly: true example: /objects/core/scheduled-operation/234 schedule: description: Settings that establish the recurrence schedule. type: object properties: startDate: type: string description: The first date on which the invoice is generated. format: date example: '2024-01-01' endDate: type: string description: >- If the `scheduleEnd` is set to `endDate`, this establishes the final date on which the invoice will be generated. format: date nullable: true example: '2025-01-01' repeatCount: type: string description: >- If `scheduleEnd` is set to `numberOfOccurrences`, this establishes the number of times the invoice is generated. nullable: true example: '1' repeatInterval: type: string description: >- Repeat interval for generating the recurring invoice. For example, if `repeatBy` is set to `month` and the `repeatInterval` is set to `2`, an invoice is generated every other month after the start date. nullable: true example: '2' default: '1' repeatBy: type: string description: "Indicates the regular interval at which the invoice is generated. To have the invoice occur at regular intervals, set to `day`, `week`, `month` or `year`. Set to `none` to have the invoice occur only once.\n\nIf set to `day`, `week`, `month` or `year`, the invoice will recur at the next interval on the same date as the start date. To make an invoice with a monthly interval generate at the end of the month, set to `endOfMonth`. \n" 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 date on which the next 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 nullable: true readOnly: true example: '2021-01-01' txnCount: type: number description: The number of transactions created from this recurring invoice. readOnly: true example: '0' 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: '16' id: type: string description: Name or other unique identifier for the payment term. example: N15 href: type: string description: URL endpoint 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: Intacct Daily Rate customerMessage: type: object description: Message to include on the customer's invoice. properties: key: type: string description: System-assigned key for the customer message. example: '10' id: type: string description: ID for the customer message. example: welcome message message: type: string description: Message text for the customer message. example: welcome to the company href: type: string description: URL endpoint for the customer message. readOnly: true example: /objects/accounts-receivable/customer-message/10 txnTotalEntered: type: string description: Total transaction amount entered. format: decimal-precision-2 example: '100' contacts: type: object description: Contacts for the invoice. properties: billTo: type: object description: Customer contact to receive the invoice. title: billTo properties: key: type: string description: System-assigned key for the contact. example: '15' id: type: string description: Name of the contact. example: Klay Vanderbilt href: type: string description: URL endpoint for the contact. readOnly: true example: /objects/company-config/contact/15 shipTo: type: object description: Ship-to contact for the invoice. title: shipTo properties: key: type: string description: System-assigned key for the contact. example: '15' id: type: string description: Name of the contact. example: Klay Vanderbilt tax: type: object title: tax description: Tax related information for the ship-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 ship-to contact. properties: key: type: string description: System-assigned key for the group. example: '288' nullable: true id: type: string description: Unique identifier for the group. example: Goods Zero Rate - CA nullable: true href: type: string description: URL endpoint for the group. readOnly: true example: /objects/tax/contact-tax-group/288 href: type: string description: URL endpoint for the contact. readOnly: true example: /objects/company-config/contact/15 customer: type: object description: Customer 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 endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/10 payment: type: object description: List of payments on the recurring AR invoice. 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: '25.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: Indicates whether to pay the invoice in full. default: true example: true bankAccountId: type: string description: Bank account record number. nullable: true example: SBME bankAccountID: type: string description: This field is deprecated, please use bankAccountId. deprecated: true nullable: true example: SBME undepositedFundsAccountId: type: string description: Undeposited funds 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: Supporting document for the invoice. properties: key: type: string description: System-assigned key for the attachment. nullable: true example: '6' id: type: string description: Unique ID of the attachment. nullable: true example: Doc6331 href: type: string description: URL endpoint for the attachment. readOnly: true example: /objects/company-config/attachment/6 lines: type: array description: Line items of the invoice. items: $ref: '#/components/schemas/accounts-receivable-recurring-invoice-line' audit: readOnly: true type: object allOf: - $ref: '#/components/schemas/audit.s1' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2024-01-23T11:28:12Z' readOnly: true status: $ref: '#/components/schemas/status' entity: $ref: '#/components/schemas/entity-ref' accounts-receivable-revenue-recognition-templateRequiredProperties: type: object required: - id - description 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' entity: $ref: '#/components/schemas/entity-ref' audit: $ref: '#/components/schemas/audit.s1' 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: 'Invoices: 2019/12/01 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: 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: Specifies the type of transactions that the summary contains. example: invoice enum: - invoice - adjustment default: invoice 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.00' 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 default: open 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 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' entity: $ref: '#/components/schemas/entity-ref' accounts-receivable-termRequiredProperties: type: object required: - id - description 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 term. readOnly: true example: '23' id: type: string description: Name or other unique identifier for the term. example: 2% 10 Net 30 href: type: string description: Endpoint for the accounts-receivable-term. readOnly: true example: /objects/accounts-receivable-term/23 status: $ref: '#/components/schemas/status' description: type: string description: Note about the purpose and use of the term. example: 2% discount if paid 10 days from invoice. Due on day 30. audit: $ref: '#/components/schemas/audit.s1' 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 `fromInvoiceDate` in `from`. properties: days: type: integer description: Number of days until the term is due. nullable: true example: 10 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 example: fromInvoiceDate discount: type: object description: >- A discount is a combination of the days, what the days reference, the dollar or percent discount, and the number of grace days. properties: days: type: integer description: Number of days until the discount goes into effect. example: 2 amount: type: integer description: Amount of the discount. nullable: true example: 5 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 example: fromInvoiceDate 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 example: percentage graceDays: type: integer description: Number of days before the discount is withdrawn. nullable: true example: 10 value: type: string description: Contains encoding of Term Properties. nullable: true readOnly: true example: 20:12:3#30#5%:D:2 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 example: lineItemsTotal 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: Time span in which the penalty accrues. default: noPenalty example: weekly amount: type: integer description: Amount of the penalty. nullable: true example: 5 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 example: percentage graceDays: type: integer description: >- The number of days after the due date that the penalty takes effect. nullable: true example: 15 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.s1' accounts-receivable-shipping-methodRequiredProperties: type: object required: - id accounts-receivable-shipping-method: type: object description: >- A shipping method is the specific way that you transport goods, such as UPS, FedEx, or hand deliver. properties: key: type: string description: System-assigned key for the shipping method. readOnly: true example: '2' id: type: string description: Name or other unique ID for the shipping method. example: Air href: type: string description: URL endpoint for the shipping method. readOnly: true example: /objects/accounts-receivable/shipping-method/2 status: $ref: '#/components/schemas/status' entity: $ref: '#/components/schemas/entity-ref' daysInTransit: type: integer description: >- Estimated number of days to ship goods from the warehouse to the customer. The value in this field is used to calculate the ship by date in Order Entry transactions. The ship by date is calculated based on the need by date minus the estimated days in transit. example: 10 accounts-receivable-manual-depositRequiredProperties: type: object required: - createdDate properties: customer: required: - id example: '1' financialEntity: required: - entityId example: BOA manualDepositSummary: required: - id example: 'Manual deposit Summary: 2024/01/01 Batch' lines: type: array items: type: object properties: glAccount: required: - id example: '2995' paymentInformation: required: - txnAmount example: 100 dimensions: properties: location: required: - id example: '1' example: location: id: '1' accounts-receivable-manual-deposit-line: type: object description: Detail and header information for manual deposits. properties: key: type: string description: System-assigned unique key for the manual deposit line. readOnly: true example: '23' id: type: string description: >- Unique ID for the manual deposit line item. This value is the same as the `key` for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the manual deposit line. readOnly: true example: /objects/accounts-receivable/manual-deposit-line/23 memo: type: string description: Memo or notes about the manual deposit line item. nullable: true example: BOA manual deposit slip 01/08/2025 lineNumber: type: number description: Line number of the manual deposit line item. readOnly: true example: 10 currency: type: object description: Currency details for the deposit line item. properties: baseCurrency: type: string description: Base currency for the deposit line item. readOnly: true example: USD txnCurrency: type: string description: Transaction currency for the deposit line item readOnly: true example: USD paymentInformation: type: object description: Payment information for the deposit line item. readOnly: true properties: baseAmount: type: string format: decimal-precision-2 description: The amount of the line item in the company's base currency. readOnly: true example: '1117.8' txnAmount: type: string format: decimal-precision-2 description: >- The transaction amount for the manual deposit line item in the currency specified for the transaction. example: '100' glAccount: type: object description: General Ledger (GL) account associated with the line item. properties: key: type: string description: Unique key for the GL account. example: '163' id: type: string description: ID for the GL account. example: '4010' href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/163 accountLabel: type: object description: Label for the associated AR account. properties: key: type: string description: Unique key for the account label. nullable: true example: '9' id: type: string description: ID for the account label. example: Accounts Receivable - Sale nullable: true href: type: string description: URL endpoint for the account label. readOnly: true example: /objects/accounts-receivable/account-label/9 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: Location associated with the deposit. title: location properties: key: type: string description: Unique key for the location. example: '1' nullable: true id: type: string description: ID for the location. example: '1' nullable: true href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/1 department: type: object description: Department associated with the deposit. title: department properties: key: type: string description: Unique key for the department. example: '11' nullable: true id: type: string description: ID for the department. example: '11' nullable: true href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/11 manualDeposit: description: Header level details for the manual deposit line entries. type: object readOnly: true properties: id: type: string description: ID for the manual deposit. readOnly: true example: '51' key: type: string description: Unique key for the manual deposit. readOnly: true example: '51' href: type: string description: URL endpoint for the manual deposit. readOnly: true example: /objects/accounts-receivable/manual-deposit/51 audit: $ref: '#/components/schemas/audit.s1' accounts-receivable-manual-deposit: type: object description: >- Manual deposits can be used to record receipt of money that's not related to an invoice (for example, an over-the-counter cash sale). properties: key: type: string description: System-assigned unique key for the manual deposit. readOnly: true example: '20' id: type: string description: >- ID for the manual deposit. This value is the same as the `key` for this object. readOnly: true example: '20' href: type: string description: URL endpoint for the manual deposit. readOnly: true example: /objects/accounts-receivable/manual-deposit/20 createdDate: type: string format: date description: Specifies the date that the manual deposit was created. example: '2025-06-08' recordType: type: string description: Record type of the manual deposit. readOnly: true example: rp financialEntity: type: object description: Financial institution where the deposit was made. properties: entityId: type: string description: Name of the bank account used in creating the manual deposit. example: BOA depositId: type: string description: >- The deposit ID correlates the manual deposit with the actual deposit slip from the bank. For example, the deposit ID can be the transaction number from the bank or a note such as `Deposit Slip of MM/DD/YYYY`. nullable: true example: BOA-0001 description: type: string description: Description of the manual deposit. nullable: true example: Deposit slip of bank BOA contacts: type: object description: Associated contacts for the manual deposit. properties: billTo: type: object description: The billing contact associated with the manual deposit. title: billTo properties: key: type: string description: Unique key for the contact. example: '916' id: type: string description: Name or other unique ID for 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: The shipping contact associated with the manual deposit. title: shipTo properties: key: type: string description: Unique key for the contact. example: '312' id: type: string description: Name or other unique ID for the contact. example: Power Aerospace Materials (C1) href: type: string description: URL endpoint for the contact. readOnly: true example: /objects/company-config/contact/312 documentNumber: type: string description: Invoice number to apply the payment against. nullable: true example: INV-1602 bankName: type: string description: Bank name for the manual deposit. example: BOA state: type: string description: State of the manual deposit. example: confirmed readOnly: true default: confirmed enum: - confirmed manualDepositSummary: type: object description: >- Specifies the summary the deposit is added to. This field is applicable only if your company has configured AR to use manually created summaries (the summary frequency for manual deposits is set to `user-specified`). properties: key: type: integer description: Unique key for the summary. example: 280 id: type: string description: >- Name of the summary. The system uses this name to identify the summary throughout the Accounts Receivable application. example: 'Manual deposit Summary: 2024/01/01 Batch' href: type: string description: URL endpoint for the summary. readOnly: true example: /objects/accounts-receivable/manual-deposit-summary/280 paymentInformation: type: object description: Payment information for the deposit. readOnly: true properties: totalAmountEntered: type: string format: decimal-precision-2 description: Total amount of the manual deposit. readOnly: true example: '1117.8' totalPaid: type: string format: decimal-precision-2 description: Total paid amount of the manual deposit. readOnly: true example: '100.10' paidDate: type: string format: date description: Payment date. readOnly: true example: '2025-06-01' totalEntered: type: string format: decimal-precision-2 description: Total transaction amount entered for the manual deposit. readOnly: true example: '1000.20' txnTotalPaid: type: string format: decimal-precision-2 description: Total transaction amount paid for the manual deposit. readOnly: true example: '2000.50' currency: type: object description: Currency details for the deposit. properties: baseCurrency: type: string description: Base currency for the deposit. example: USD txnCurrency: type: string description: Transaction currency for the deposit example: USD customer: type: object description: Customer who made the payment. properties: key: type: string description: Unique key for the customer. example: '11' id: type: string description: ID for the customer. example: '11' name: type: string description: Name of the customer. example: CENTEX href: type: string description: URL endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/11 lines: type: array description: Line items included in the manual deposit. items: $ref: '#/components/schemas/accounts-receivable-manual-deposit-line' audit: readOnly: true type: object allOf: - $ref: '#/components/schemas/audit.s1' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2025-01-23T11:28:12Z' readOnly: true entity: $ref: '#/components/schemas/entity-ref' accounts-receivable-manual-deposit-summary: type: object description: >- A manual deposit summary is a collection of payments received from customers, such as quick or manual deposit payments, grouped together for processing. properties: key: type: string description: System-assigned unique key for the manual deposit summary. readOnly: true example: '11' id: type: string description: >- ID for the manual deposit summary. This value is the same as the `key` for this object. readOnly: true example: '11' href: type: string description: URL endpoint for the manual deposit summary. readOnly: true example: /objects/accounts-receivable/manual-deposit-summary/11 name: type: string description: >- Name of the manual deposit summary. Sage Intacct uses this name to identify the summary throughout the Accounts Receivable application. example: 'Invoices: 2024/06/01 Batch' summaryCreationType: type: string description: >- Specifies how the summary was created. If set to `manual`, the summary was created by a user. If set to `system`, the summary was created by Sage Intacct based on the specified summary frequency. example: manual enum: - system - manual default: manual readOnly: true glPostingDate: type: string format: date description: The date that summary items post to the general ledger. example: '2025-05-03' recordType: type: string description: >- Specifies the type of transactions included in the manual deposit summary. example: invoice default: invoice readOnly: true enum: - invoice totalAmount: type: string description: Total amount of transactions in the summary. format: decimal-precision-2 example: '110' 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 default: open parent: type: object description: Parent summary of the manual deposit summary. properties: key: type: string description: Unique key for the parent summary. example: '1' id: type: string description: ID for the parent summary. example: '1' href: type: string description: URL endpoint for the parent summary. readOnly: true example: /objects/accounts-receivable/summary/1 preventGLPosting: type: boolean description: >- Set to `true` to prevent posting summary items to the general ledger. example: true default: true isQuickPaymentSummary: type: boolean description: Specifies whether this is a quick payment summary. example: true default: true status: $ref: '#/components/schemas/status' accounts-receivable-dunning-levelRequiredProperties: type: object required: - id properties: printTemplate: type: object required: - id dunningThreshold: type: object required: - minDays - txnCurrency noticeSequence: type: object required: - id accounts-receivable-dunning-level: type: object description: >- Dunning levels define the levels of notices that are sent during the collection process. properties: key: type: string description: System-assigned unique key for the dunning level. readOnly: true example: '23' id: type: string description: Name or other unique identifier for the dunning level. example: L1 Dunning level href: type: string description: URL endpoint for the dunning level. readOnly: true example: /objects/accounts-receivable/dunning-level/23 printTemplate: type: object description: The printed document template assigned to the dunning level. properties: key: type: string description: Unique key for printed document template. example: '24' id: type: string description: Unique identifier for printed document template. example: Level 1 Document Template dunningThreshold: type: object properties: minDays: type: integer description: >- Minimum days overdue. This is the lower value for the days overdue range of the dunning level. example: 10 default: 0 maxDays: type: integer description: >- Maximum days overdue. This is the higher value for the days overdue range of the dunning level. example: 100 minAmount: type: string format: decimal-precision-2 description: >- Minimum invoice amount. This is the lower value for the invoice amount overdue range of the dunning level. example: '100' maxAmount: type: string format: decimal-precision-2 description: >- Maximum invoice amount. This is the higher value for the invoice amount overdue range of the dunning level. example: '5000' baseCurrency: type: string description: Base currency for the invoice amount. example: USD txnCurrency: type: string description: Transaction currency for the invoice amount. example: USD noticeSequence: type: object description: >- Sets how dunning notices are sequentially numbered when they're created. properties: key: type: string readOnly: true description: Unique key for the numbering sequence. example: '2' id: type: string description: Name or other unique ID for the numbering sequence. example: L1 Dunning Sequence href: type: string description: URL endpoint for the numbering sequence. example: /objects/company-config/document-sequence/2 readOnly: true emailTemplate: type: object description: The email template assigned to the dunning level. properties: key: type: string description: Unique key for the email template. example: '10' id: type: string description: Name or other unique ID for the email template. example: L1 Dunning email template href: type: string description: URL endpoint for the email template. readOnly: true example: /objects/company-config/email-template/23 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit.s1' entity: $ref: '#/components/schemas/entity-ref' accounts-receivable-dunning-invoice: type: object description: >- Dunning invoices are part of a generated dunning notice when a customer fails to pay an invoice by the due date. properties: key: type: string description: System-assigned unique key for the dunning invoice. readOnly: true example: '32' id: type: string description: >- ID for the dunning invoice. This value is the same as the key for this object. readOnly: true example: '32' href: type: string description: URL endpoint for the dunning invoice. readOnly: true example: /objects/accounts-receivable/dunning-invoice/32 dunningCustomer: type: object description: Customer associated with the dunning invoice. properties: key: type: string description: Unique key for the dunning customer. example: '15' readOnly: true id: type: string description: ID for the dunning customer. example: '15' readOnly: true href: type: string description: URL endpoint for the dunning customer. readOnly: true example: /objects/accounts-receivable/dunning-customer/15 arInvoice: type: object description: AR invoice included in the dunning invoice. readOnly: true properties: key: type: string description: Unique key for the invoice. example: '35' readOnly: true id: type: string description: ID for the invoice. example: '35' readOnly: true href: type: string description: URL endpoint for the invoice. readOnly: true example: /objects/accounts-receivable/invoice/35 invoiceNumber: type: string description: User-defined unique ID for invoice. example: INV1 default: '' nullable: true readOnly: true invoiceDate: type: string description: Date the invoice was created. example: '2025-01-01' readOnly: true format: date dueDate: type: string description: Date the invoice is due. example: '2025-01-11' readOnly: true format: date totalBaseAmount: type: string description: >- For multi-currency companies, total entered in the base currency of the company. example: '100' format: decimal-precision-2 readOnly: true totalBaseAmountDue: type: string description: >- For multi-currency companies, total due in the base currency of the company. example: '100' format: decimal-precision-2 readOnly: true totalTxnAmount: type: string description: Total transaction amount in the currency of the invoice. example: '100' format: decimal-precision-2 readOnly: true totalTxnAmountDue: type: string description: Total transaction amount due in the currency of the invoice. example: '100' format: decimal-precision-2 readOnly: true referenceNumber: type: string description: Customer purchase order number or another reference number. example: CHECK-123 nullable: true readOnly: true audit: $ref: '#/components/schemas/audit.s1' accounts-receivable-dunning-customer: type: object description: Information about customers receiving a dunning notice. properties: key: type: string description: System-assigned unique key for the dunning customer. readOnly: true example: '12' id: type: string description: >- Unique ID for the dunning customer. This value is the same as the `key` for this object. example: '12' href: type: string description: URL endpoint for the dunning customer. readOnly: true example: /objects/accounts-receivable/dunning-customer/12 dunningNoticeCustomerId: type: string description: System generated ID for a dunning notice generated for a customer. example: DUN1 readOnly: true noticeEmail: type: object description: Dunning notice email details. properties: date: type: string description: Date of the email notification. example: '2025-01-01' format: date to: type: string description: Email addresses of recipients (separated by , or ;). example: john.doe@mycompany.com nullable: true cc: type: string description: Email addresses of cc line recipients (separated by , or ;). example: ganesh@mycompany;bblank@mycompany.com nullable: true bcc: type: string description: Email addresses of bcc line recipients (separated by , or ;). example: mogare@mycompany.com nullable: true deliveryMethod: type: string description: Delivery method for the dunning notice. example: both enum: - printed - emailed - both totalAmountOverdue: type: string description: Total overdue amount of customer invoices. example: '1000.00' readOnly: true format: decimal-precision-2 totalTxnAmountOverdue: type: string description: Total overdue transaction amount of customer invoices. example: '1000.00' readOnly: true format: decimal-precision-2 invoiceCount: type: number description: Number of due invoices. readOnly: true example: 3 dunningNotice: type: object description: Dunning notice associated with the customer. readOnly: true properties: key: type: string description: Unique key for the dunning notice. readOnly: true example: '23' id: type: string description: Unique ID for the dunning notice. readOnly: true example: '23' audit: $ref: '#/components/schemas/audit.s1' href: type: string description: URL endpoint for the dunning notice. readOnly: true example: /objects/accounts-receivable/dunning-notice/23 dunningNoticeAttachment: type: string description: Generated dunning notice PDF data. format: base64zip readOnly: true example: PDF data customer: type: object description: Customer associated with the dunning notice. properties: key: type: string description: Unique key for the customer. example: '19' id: type: string description: Unique ID for the customer. example: CUST1 name: type: string description: Name of the customer. readOnly: true example: John Bow href: type: string description: URL endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/19 sendPrintedNotice: type: boolean description: Specifies whether to print a dunning notice for the customer. example: true default: true sendEmailNotice: type: boolean description: >- Specifies whether to send a dunning email notification to the email addresses listed in `noticeEmail`. example: true default: true invoices: type: array description: List of invoices included in the dunning notice. items: $ref: '#/components/schemas/accounts-receivable-dunning-invoice' accounts-receivable-dunning-noticeRequiredProperties: type: object required: - basedOn - asOfDate - printTemplateName - dunningLevel properties: sender: type: object required: - email dunningCustomers: type: array items: type: object required: - sendPrintedNotice - customer accounts-receivable-dunning-notice: type: object description: Dunning notice. properties: key: type: string description: System-assigned unique key for the dunning notice. example: '23' id: type: string description: >- ID for the dunning notice. This value is the same as the `key` for this object. example: '23' readOnly: true href: type: string description: URL endpoint for the dunning notice. readOnly: true example: /objects/accounts-receivable/dunning-notice/23 basedOn: type: string description: >- Specifies how to filter due invoices, either by the invoice date or the due date. example: dueDate enum: - invoiceDate - dueDate asOfDate: type: string description: >- Specifies the date to use to determine when invoices are filtered. For example, if you set an `asOfDate` of 2025-06-15 and you set the `basedOnDate` to `dueDate`, notices are sent to customers who have invoices due by 2025-06-15. example: '2025-01-01' format: date currency: type: string description: The transaction currency for the dunning notice. readOnly: true example: USD baseCurrency: type: string description: The base currency for the dunning notice. readOnly: true example: USD printTemplateName: type: string description: Name of the printed document template to use for the dunning notice. example: L1 DL Doc Template sender: type: object description: Information about the user who is the sender. properties: email: type: string description: Sender email address. example: john.bow@mycompany.com name: type: string description: Sender name. example: John Bow phone: type: string description: Sender phone number. example: 123-456-7890 attachInvoice: type: boolean description: Specifies whether invoices are attached to the dunning notice. example: false default: false dunningLevel: type: object properties: href: type: string description: URL endpoint for the dunning level. readOnly: true example: /objects/accounts-receivable/dunning-level/23 key: type: string description: Unique key for the dunning level. example: '100' id: type: string description: Name or other unique ID for the dunning level. example: L1 emailTemplate: type: object description: Email template for the dunning notice. properties: href: type: string description: URL endpoint for the email template. readOnly: true example: /objects/company-config/email-template/23 key: type: string description: Unique key for the email template. example: '23' nullable: true id: type: string description: Name or other unique ID for the email template. example: L1 DL template nullable: true dunningCustomers: type: array description: List of customers included in the dunning notice. items: $ref: '#/components/schemas/accounts-receivable-dunning-customer' audit: $ref: '#/components/schemas/audit.s1' responses: 400error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error-response' securitySchemes: OAuth2: description: Sage Intacct OAuth 2.0 authorization code flow type: oauth2 flows: authorizationCode: authorizationUrl: https://api.intacct.com/ia/api/v1/oauth2/authorize tokenUrl: https://api.intacct.com/ia/api/v1/oauth2/token refreshUrl: https://api.intacct.com/ia/api/v1/oauth2/token scopes: {}