openapi: 3.0.3 info: title: Accounts Receivable description: > Accounts Receivable (AR) is used to manage a full AR cycle, including customers, receivables transactions, and generating reports. version: '1.0' 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. x-displayName: Account labels - name: Adjustment lines description: >- Line items in an adjustment represent debits or credits to modify the amount owed by a customer. x-displayName: Adjustment lines - name: Adjustment tax entries description: For VAT enabled transactions, adjustment line items will have tax entries. x-displayName: Adjustment tax entries - name: Adjustments description: >- An adjustment is a transaction that applies a credit or debit in order to modify the amount owed by a customer. x-displayName: Adjustments - name: Advance lines description: >- An advance line item is associated with a particular advance. Each advance can have any number of line items. x-displayName: Advance lines - name: Advances description: >- Advances record an advance payment from a customer before creating an invoice, for example, when a customer provides a retainer. x-displayName: Advances - name: Billback template lines description: Line items for a bill back template. x-displayName: Billback template lines - name: Billback templates description: >- Create a bill back template for each recurring bill back transaction. The template provides line item information needed in the bill back transaction, including invoice line items and corresponding line items in the system-generated bill. x-displayName: Billback templates - name: Customer account groups description: Organize customers into account groups to simplify reporting. x-displayName: Customer account groups - name: Customer contacts description: Contact information for a customer. x-displayName: Customer contacts - name: Customer email templates description: >- Customer email templates can be used to standardize messages sent to multiple customers. x-displayName: Customer email templates - 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. x-displayName: Customer item cross references - name: Customer messages description: This object represents a message associated with a customer. x-displayName: Customer messages - 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. x-displayName: Customer restricted departments - 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. x-displayName: Customer restricted locations - 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. x-displayName: Customer types - 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. x-displayName: Customers - name: Invoice lines description: Line items in an invoice represent transactions captured in that invoice. x-displayName: Invoice lines - 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. x-displayName: Invoice summaries - name: Invoice tax entries description: For VAT enabled transactions, invoice line items will have tax entries. x-displayName: Invoice tax entries - name: Invoices description: >- An invoice object represents an invoice sent to a customer for goods or services provided. x-displayName: Invoices - name: Recurring invoice lines description: >- Line items in a recurring invoice represent transactions captured in that recurring invoice. x-displayName: Recurring invoice lines - name: Recurring invoice tax entries description: >- For VAT enabled transactions, recurring invoice line items will have tax entries. x-displayName: Recurring invoice tax entries - name: Recurring invoices description: >- Recurring invoices are invoices that repeat at periods and durations that you define in the recurrence schedule. x-displayName: Recurring invoices - 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. x-displayName: Revenue recognition templates - name: Shipping methods description: >- A shipping method is a specific way to transport goods, such as UPS or FedEx. x-displayName: Shipping methods - 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. x-displayName: 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. x-displayName: Terms - 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. x-displayName: Territories 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 query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View AR Account Labels
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Add AR Account Labels
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: '151' get: summary: Get an account label description: >+ Returns detailed information for a specified AR account label.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View AR Account Labels
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Edit AR Account Labels
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Delete AR Account Labels
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-line: get: summary: List adjustment lines description: >- Returns a collection with a key, ID, and link for each adjustment line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - 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: '146' 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. 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: '72' 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/adjustment: get: summary: List adjustments description: >+ Returns a collection with a key, ID, and link for each adjustment. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Adjustments
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, and Add Adjustments
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: '41' get: summary: Get an adjustment description: >+ Returns detailed information for a specified adjustment.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Adjustments
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Edit Adjustments
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View, Delete Adjustments
tags: - Adjustments operationId: delete-accounts-receivable-adjustment-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 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. in: path required: true schema: type: string example: '177' 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: '' baseAmount: '100.00' txnAmount: '100.00' dimensions: department: key: '' id: '' name: '' location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 project: key: '' id: '' name: '' customer: key: '36' id: C-00045 name: MetroArtic, Inc. href: /objects/accounts-receivable/customer/36 vendor: key: '' id: '' name: '' employee: key: '' id: '' name: '' item: key: '' id: '' name: '' class: key: '' id: '' name: '' baseLocation: name: United States of America key: '1' href: /objects/company-config/location/1 createdDate: '2023-04-25' memo: New contract down payment currency: exchangeRate: date: '2023-04-25' typeId: '' rate: 1 baseCurrency: USD txnCurrency: USD lineNumber: 1 paymentInformation: totalPaid: '100.00' txnTotalPaid: '100.00' totalSelected: '100.00' txnTotalSelected: '100.00' audit: createdDateTime: '2023-06-13T06:42:36Z' modifiedDateTime: '2023-06-13T07:31:51Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/advance-line/2067 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/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 query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsList, View Advances
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. If `accountType` is set to or defaults to `bank`, `financialEntity` must be included in `paymentInformation` to create an advance. If `accountType` is set to `undepositedFundsAccount`, a `glAccount` with an `undepositedGLAccountNumber` is required to create an advance. If the Accounts Receivable application is configured to Enable Account Labels, you must include an `accountLabel` in the items array to create an advance.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness (with all admin privileges), Employee, CRM
PermissionsList, View, Add Advances
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Advances
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 recordType: rr state: posted totalEntered: '10.00' txnTotalEntered: '10.00' audit: modifiedDateTime: '2024-06-26T05:51:05Z' createdBy: '1' modifiedBy: '1' createdDateTime: '2024-06-13T00:00:00Z' 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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View, Edit Advances
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 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: [] /objects/accounts-receivable/billback-template-line: get: summary: List billback template lines description: >- Returns a collection with a key, ID, and link for each billback template line. tags: - Billback template lines operationId: list-accounts-receivable-billback-template-line responses: '200': description: OK content: application/json: schema: type: object title: List of billback-template-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List billback template lines: value: ia::result: - key: '1' id: '1' href: /objects/accounts-receivable/billback-template-line/1 - key: '8' id: '8' href: /objects/accounts-receivable/billback-template-line/8 - key: '9' id: '9' href: /objects/accounts-receivable/billback-template-line/9 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/billback-template-line/{key}: parameters: - name: key description: System-assigned key for the billback template line. in: path required: true schema: type: string example: '92' get: summary: Get a billback template line description: Returns detailed information for a particular billback template line. tags: - Billback template lines operationId: get-accounts-receivable-billback-template-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the billback-template-line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-billback-template-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a billback template line: value: ia::result: key: '1' id: '1' billbackTemplate: id: '1' key: '1' href: /objects/accounts-receivable/billback-template/1 lineNumber: '0' invoiceGLAccount: key: '194' id: '4000' name: Sales href: /objects/general-ledger/account/194 billGLAccount: key: '207' id: '5001' name: Construction href: /objects/general-ledger/account/207 department: key: '9' id: '11' name: Accounting href: /objects/company-config/department/9 memo: line 1 href: /objects/accounts-receivable/billback-template-line/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/billback-template: get: summary: List billback templates description: >- Returns a collection with a key, ID, and link for each billback template. tags: - Billback templates operationId: list-accounts-receivable-billback-template responses: '200': description: OK content: application/json: schema: type: object title: List of billback-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of billback templates: value: ia::result: - key: '11' id: BBT-NextGen-2 href: /objects/accounts-receivable/billback-template/11 - key: '14' id: BBT-NextGen-5 href: /objects/accounts-receivable/billback-template/14 - key: '25' id: BBT-NextGen-8 href: /objects/accounts-receivable/billback-template/25 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a billback template description: Creates a new billback template. tags: - Billback templates operationId: create-accounts-receivable-billback-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-billback-template' - $ref: '#/components/schemas/accounts-receivable-billback-templateRequiredProperties' examples: Creates a billback template: value: id: BBT-NextGen-9 description: BBT Next Gen template-9 enableInterEntityPostings: true lines: - invoiceGLAccount: key: '194' billGLAccount: key: '109' department: key: '9' memo: line 1 responses: '201': description: Created content: application/json: schema: type: object title: New billback-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New billback template: value: ia::result: key: '26' id: BBT-NextGen-9 href: /objects/accounts-receivable/billback-template/26 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/billback-template/{key}: parameters: - name: key description: System-assigned key for the billback template. in: path required: true schema: type: string example: '111' get: summary: Get a billback template description: Returns detailed information for a particular billback template. tags: - Billback templates operationId: get-accounts-receivable-billback-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the billback-template properties: ia::result: $ref: '#/components/schemas/accounts-receivable-billback-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the billback template: value: ia::result: key: '1' id: bbt1 description: Billback template 2 status: active enableInterEntityPostings: true lines: - key: '1' id: '1' billbackTemplate: id: '1' key: '1' href: /objects/accounts-receivable/billback-template/1 lineNumber: '0' invoiceGLAccount: key: '194' id: '4000' name: Sales href: /objects/general-ledger/account/194 billGLAccount: key: '207' id: '5001' name: Construction href: /objects/general-ledger/account/207 department: key: '9' id: '11' name: Accounting href: /objects/company-config/department/9 memo: line 1 href: '/objects/accounts-receivable/billback-template-line/1' href: /objects/accounts-receivable/billback-template/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a billback template description: >- Updates an existing billback template by setting field values. Any fields not provided remain unchanged. tags: - Billback templates operationId: update-accounts-receivable-billback-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-billback-template' - type: object properties: id: readOnly: true examples: Updates a billback template: value: status: active lines: - invoiceGLAccount: key: '194' billGLAccount: key: '109' department: key: '9' memo: line 1-1 - invoiceGLAccount: key: '194' billGLAccount: key: '109' department: key: '9' memo: line 1-2 responses: '200': description: OK content: application/json: schema: type: object title: Updated billback-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated billback template: value: ia::result: key: '5' id: BBT-NextGen-1 href: /objects/accounts-receivable/billback-template/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a billback template description: Deletes a billback template. tags: - Billback templates operationId: delete-accounts-receivable-billback-template-key responses: '204': description: No Content '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: '50' 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-contact: get: summary: List customer contacts description: >- Returns a collection with a key, ID, and link for each customer contact. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. operationId: list-accounts-receivable-customer-contact tags: - 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 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: '134' 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-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 together! 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 required: true schema: type: string example: '73' 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: WelcomeMessage message: Welcome to the company status: active audit: createdDateTime: '2023-08-16T13:26:56Z' modifiedDateTime: '2023-08-16T13:26:56Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/customer-message/15 ia::meta: totalCount: 1 '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: WelcomeMessage 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-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 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' ia::meta: totalCount: 2 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' objectType: CUSTOMER 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/142 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 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: '200' id: '200' href: '/objects/accounts-receivable/customer-restricted-location/200' - key: '198' id: '198' href: '/objects/accounts-receivable/customer-restricted-location/198' ia::meta: totalCount: 2 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: '142' 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: '142' objectType: CUSTOMER id: '142' location: key: '3' id: '3' href: /objects/company-config/location/3 locationGroup: key: null id: null customer: key: '330' id: Nov7-02 href: /objects/accounts-receivable/customer/142 href: '/objects/accounts-receivable/customer-restricted-location/142' 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 query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsList, View Customer Types
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Add Customer Types
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View Customer Types
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Edit Customer Types
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Delete Customer Types
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: get: summary: List customers description: >+ Returns a collection with a key, ID, and link for each customer. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View Customers
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Add Customers
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: '160' get: summary: Get a customer description: |+ Returns detailed information for a specified customer.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View Customers
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: 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: 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 customerMessageId: Abhi message isOnHold: false overridePriceList: Customer enableOnlineCardPayment: true enableOnlineACHPayment: true audit: modifiedDateTime: '2023-12-14T11:31:06Z' createdDateTime: '2018-07-28T19:22:31Z' createdBy: '1' modifiedBy: '1' restrictions: restrictionType: restricted locations: - North America--North America - GM--Gulf of Mexico - BG--Bangalore - NY--New York departments: - 1st Level Depts--Level 1 Departments - 2nd Level Depts--Level 2 Departments overrideOffsetGLAccount: id: '1120' name: Pledges Receivable emailOptIn: false contactList: - id: '150' key: '150' categoryName: ship audit: modifiedDateTime: '2023-12-14T11:31:06Z' createdDateTime: '2022-06-07T12:37:37Z' createdBy: '1' modifiedBy: '1' customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 contact: key: '106' id: Aron href: /objects/company-config/contact/106 href: /objects/accounts-receivable/customer-contact/150 customerEmailTemplates: - id: '8' key: '8' customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 txnDefinitionName: Sales Quote emailTemplate: id: '4' key: '4' name: OETemplate href: /objects/company-config/email-template/4 templateType: soDocument href: '/objects/accounts-receivable/customer-email-template/8' href: /objects/accounts-receivable/customer/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a customer description: >+ Updates an existing customer by setting field values. Any fields not provided remain unchanged. Customers included in posted transactions will not be updated. Only new transactions and records will refer to the updated customer information.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Edit Customers
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Delete Customers
tags: - Customers operationId: delete-accounts-receivable-customer-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice-line: get: summary: List invoice lines description: >+ Returns a collection with a key, ID, and link for each invoice line item. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Approver
PermissionsList, View Invoices
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: '88' get: summary: Get an invoice line description: >+ Returns detailed information for a specified invoice line item.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Approver
PermissionsList, View Invoices
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-summary: get: summary: List invoice summaries description: >+ Returns a collection with a key, ID, and link for each AR invoice summary. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View Summaries
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: '18' get: summary: Get an invoice summary description: |+ Returns detailed information for a specified AR invoice summary.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View Summaries
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/invoice-tax-entry: get: summary: List invoice tax entries description: >- Returns a collection with a key, ID, and link for each invoice tax entry. 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: '113' 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: get: summary: List invoices description: >+ Returns a collection with a key, ID, and link for each invoice. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Approver
PermissionsList, View Invoices
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Approver
PermissionsAdd Invoices
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: '65' get: summary: Get an invoice description: >+ Returns detailed information for a specified invoice.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Approver
PermissionsList, View Invoices
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 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).
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Approver
PermissionsEdit Invoices
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Approver
PermissionsDelete Invoices
tags: - Invoices operationId: delete-accounts-receivable-invoice-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/recurring-invoice-line: get: summary: List recurring invoice lines description: >+ Returns a collection with a key, ID, and link for each recurring invoice line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness/Admin, Employee, Project Manager, Warehouse, Approver
PermissionsList, View Recurring invoices
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: '42' get: summary: Get a recurring invoice line description: >+ Returns detailed information for a specified line item in a recurring invoice.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness/Admin, Employee, Project Manager, Warehouse, Approver
PermissionsList, View Recurring invoices
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. 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: '92' 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/recurring-invoice: get: summary: List recurring invoices description: >+ Returns a collection with a key, ID, and link for each recurring invoice. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness/Admin, Employee, Project Manager, Warehouse, Approver
PermissionsList, View Recurring invoices
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness/Admin, Employee, Approver
PermissionsList, View, Add Recurring invoices
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: '146' get: summary: Get a recurring invoice description: >+ Returns detailed information for a specified recurring invoice.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness/Admin, Employee, Project Manager, Warehouse, Approver
PermissionsList, View Recurring invoices
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Edit Recurring invoices
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Edit, Delete Recurring invoices
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/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: '187' 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' createdBy: '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/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 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 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: null 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/summary: get: summary: List summaries description: >- Returns a collection with a key, ID, and link for each AR summary. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - 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 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: '151' 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 query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View AR terms
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Add AR terms
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: '136' get: summary: Get a term description: |+ Returns detailed information for a specified term.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View AR terms
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Edit AR terms
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.
Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View, Delete AR 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 query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View Territories
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.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Add Territories
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: '45' get: summary: Get a territory description: |+ Returns detailed information for a specified territory.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View Territories
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.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Edit Territories
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.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Delete Territories
tags: - Territories operationId: delete-accounts-receivable-territory-key responses: '204': description: No Content '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 count readOnly: true example: 3 start: type: integer description: Start element number readOnly: true example: 1 pageSize: type: integer description: Page size readOnly: true example: 100 next: type: integer description: Next element number readOnly: true nullable: true example: 101 previous: type: integer description: Previous element number readOnly: true nullable: true example: null metadata: description: Metadata for response type: object properties: totalCount: type: integer description: Total count readOnly: true example: 3 totalSuccess: type: integer description: Total success readOnly: true example: 2 totalError: type: integer description: Total errors readOnly: true example: 1 error-response: type: object description: Error response properties: ia::result: type: object properties: ia::error: type: object properties: code: type: string example: invalidRequest message: type: string example: Payload contains errors supportId: type: string example: sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ errorId: type: string example: REST-1064 additionalInfo: type: object properties: messageId: type: string example: IA.PAYLOAD_CONTAINS_ERRORS placeholders: type: string example: {} propertySet: type: string example: {} details: type: array items: type: object properties: code: type: string example: invalidRequest message: type: string example: /newDate is not a valid field errorId: type: string example: REST-1043 target: type: string example: /newDate additionalInfo: type: object properties: messageId: type: string example: IA.NOT_A_VALID_FIELD placeholders: type: string example: FIELD: /newDate propertySet: type: string example: {} ia::meta: $ref: '#/components/schemas/metadata' example: ia::result: ia::error: code: invalidRequest message: A POST request requires a payload errorId: REST-1028 additionalInfo: messageId: IA.REQUEST_REQUIRES_A_PAYLOAD placeholders: OPERATION: POST propertySet: {} supportId: Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo ia::meta: totalCount: 1 totalSuccess: 0 totalError: 1 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: type: object readOnly: true properties: createdDateTime: description: Date-time when this record was created. type: string format: date-time readOnly: true example: '2023-05-16T15:34:35Z' modifiedDateTime: description: Date-time when this record was modified. type: string format: date-time readOnly: true example: '2024-09-14T21:23:42Z' createdBy: description: Key for the user who created this object. type: string readOnly: true nullable: true example: '436' modifiedBy: description: Key for the user who last modified this object. type: string readOnly: true nullable: true example: '3086' 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' entity: $ref: '#/components/schemas/entity-ref' 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 accounts-receivable-adjustment-tax-entry: type: object description: >- For VAT enabled transactions, adjustment line items will have tax entries. allOf: - $ref: '#/components/schemas/tax-entries' - type: object properties: orderEntryTaxDetail: type: object description: >- Order Entry tax details describe a specific type of tax that applies to lines in Accounts Receivable transactions. properties: key: type: string description: System-assigned 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 object. readOnly: true example: /objects/tax/order-entry-tax-detail/1 adjustmentLine: title: adjustment-line description: Line item that the tax entries are associated with. readOnly: true type: object properties: id: type: string description: Unique ID for the adjustment line object. example: '100' readOnly: true key: type: string description: Unique key for the adjustment line object. example: '100' readOnly: true href: type: string description: URL endpoint for the adjustment line object. 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' 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: 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. readOnly: true 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' - 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-advance-lineRequiredProperties: type: object required: - txnAmount 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: AR advance line ID. readOnly: true example: '23' href: type: string description: Endpoint for the AR advance line. readOnly: true example: /objects/accounts-receivable/advance-line/23 baseAmount: type: string format: decimal-precision-2 description: >- Amount for the line item in your company's base currency, which is calculated based on the exchange rate defined in the header. readOnly: true example: '100.00' txnAmount: type: string format: decimal-precision-2 description: Amount for the AR advance line item in the transaction currency. example: '100' memo: type: string description: Memo about the line item. example: Service charges currency: type: object description: Currency details for the advance. properties: baseCurrency: type: string description: Base currency for the company. readOnly: true example: USD txnCurrency: type: string description: Transaction currency for the advance. readOnly: true example: GBP exchangeRate: type: object title: exchangeRate description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' lineNumber: type: integer description: Line number readOnly: true example: 1 paymentInformation: type: object description: Payment information for the AR advance line item. properties: totalPaid: type: string format: decimal-precision-2 description: Total paid for the line item. readOnly: true example: '200' txnTotalPaid: type: string format: decimal-precision-2 description: Transaction total paid for the line item. readOnly: true example: '200' totalSelected: type: string format: decimal-precision-2 description: Total selected for the line item. readOnly: true example: '100' txnTotalSelected: type: string format: decimal-precision-2 description: Total transaction selected for the line item. readOnly: true example: '100' baseLocation: type: object allOf: - $ref: '#/components/schemas/location-ref' - type: object properties: key: type: string description: Base location key. example: '4' accountLabel: type: object properties: key: type: string description: System-assigned key for the account label. example: '14' id: type: string description: Meaningful name of the account. example: Accounting Fees name: type: string description: Name of the account label. readOnly: true example: Accounting Fees href: type: string description: Endpoint for the account label. readOnly: true example: /objects/accounts-receivable/account-label/14 glAccount: $ref: '#/components/schemas/gl-account-ref' dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of locations to reflect how your company is organized. title: location properties: key: type: string description: System-assigned key for the location. example: '4' id: type: string description: Unique identifier of the location. example: AU name: type: string description: Name of the location. readOnly: true example: Australia href: type: string description: Endpoint for the location. readOnly: true example: /objects/company-config/location/4 department: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string description: System-assigned key for the department. example: '9' id: type: string description: Unique identifier of the department. example: '01' name: type: string description: Name of the department. readOnly: true example: Accounting href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/9 arAdvance: description: Header level details for the AR advance's line items. type: object readOnly: true properties: id: type: string description: Identifier for the AR advance. readOnly: true example: '23' key: type: string description: System-assigned key for the AR advence. readOnly: true example: '23' href: type: string description: Endpoint for the AR advance. readOnly: true example: /objects/accounts-receivable/advance/23 recordType: type: string description: Record type. readOnly: true example: rr audit: $ref: '#/components/schemas/audit' accounts-receivable-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 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 state: type: string description: Processing state of the AR advance. readOnly: true 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 accountType: type: string description: >- Type of account associated with the payment method. If `accountType` is set to or defaults to `bank`, `financialEntity` is required to create an advance. If `accountType` is set to `undepositedFundsAccount`, a `glAccount` with an `undepositedGLAccountNumber` is required to create an advance. example: bank enum: - bank - undepositedFundsAccount default: bank 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: $ref: '#/components/schemas/audit' accounts-receivable-billback-template-line: type: object description: Billback template lines properties: key: type: string description: Record key readOnly: true example: '5' id: type: string description: BillBack Template Line Item ID readOnly: true example: '5' href: type: string description: URL for the billback template line. readOnly: true example: /objects/accounts-receivable/billback-template-line/5 lineNumber: type: string description: Line No readOnly: true example: '2' memo: type: string description: Memo example: Line number 2 invoiceGLAccount: type: object description: The account for the line item in the invoice properties: key: type: string example: '5' id: type: string example: '4000' name: type: string example: Sales href: type: string description: URL for the account. readOnly: true example: /objects/general-ledger/account/5 billGLAccount: type: object description: >- The bill GL Account is used in the corresponding line item of generated bill. properties: key: type: string example: '6' id: type: string example: '2000' name: type: string example: School Fees href: type: string description: URL for the account. readOnly: true example: /objects/general-ledger/account/6 department: type: object description: Department properties: key: type: string example: '9' id: type: string example: '11' name: type: string example: Accounting href: type: string description: URL for the account. readOnly: true example: /objects/company-config/department/9 billbackTemplate: description: Header level details for the Billback templete's line items. type: object properties: id: type: string description: Identifier for the billback template. readOnly: true example: '5' key: type: string description: System-assigned key for the Billback template. readOnly: true example: '5' href: type: string description: URL for the billback template. readOnly: true example: /objects/accounts-receivable/billback-template/5 readOnly: true accounts-receivable-billback-templateRequiredProperties: type: object required: - id - description properties: lines: type: array items: type: object required: - txnAmount properties: invoiceGLAccount: type: object required: - key billGLAccount: type: object required: - key accounts-receivable-billback-template: type: object description: Billback template properties: key: type: string description: BillBack Template Key readOnly: true example: '23' id: type: string description: BillBack Template ID example: Template 1 href: type: string description: URL for the billback template. readOnly: true example: /objects/accounts-receivable/billback-template/23 description: type: string description: Description example: Billback template for sales account enableInterEntityPostings: type: boolean description: >- Set to true to post directly to the mapped inter-entity offset accounts instead of the Accounts Receivable and Accounts Payable offset accounts. default: false example: true status: $ref: '#/components/schemas/status' entity: $ref: '#/components/schemas/entity-ref' lines: type: array description: Line items of the billback template. items: $ref: '#/components/schemas/accounts-receivable-billback-template-line' 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-contact: type: object description: A customer-contact is a contact record on a customer's `contactList`. properties: key: type: string description: System-assigned key for the customer contact information. readOnly: true example: '1' id: type: string description: >- Unique identifier for the customer contact information. This value is the same as `key` for this object. readOnly: true example: '1' categoryName: type: string description: User-defined category for grouping and sorting contacts. example: Billing contact href: type: string readOnly: true example: /objects/accounts-receivable/customer-contact/1 contact: type: object description: Contact to associate with the customer. properties: key: type: string description: System-assigned key for the contact. example: '197' id: type: string description: Unique identifier for the contact example: Jeffrey Palms href: type: string readOnly: true example: /objects/company-config/contact/197 audit: $ref: '#/components/schemas/audit' customer: type: object description: Customer that has the contactList where this contact appears. properties: key: type: string description: System-assigned key for the customer. example: '15' id: type: string description: ID for the customer. example: '15' href: type: string readOnly: true example: /objects/accounts-receivable/customer/15 accounts-receivable-customer-email-templateRequiredProperties: type: object properties: customer: required: - key example: '127' emailTemplate: required: - key example: '1' 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-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' 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' 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 of the customer. readOnly: true example: C23 href: type: string description: Endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/23 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-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' entity: $ref: '#/components/schemas/entity-ref' 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 readOnly: true example: '21' id: type: string description: Contact ID example: jsmith href: type: string description: URL endpoint for the contact readOnly: true example: /objects/company-config/contact/21 lastName: type: string description: Last name example: Smith firstName: type: string description: First name example: John middleName: type: string description: Middle name example: Archibald prefix: type: string description: Prefix, such as Mr., Mrs., or Ms. example: Mr printAs: type: string description: The contact's name as it will appear on documents example: John Smith email1: type: string description: Primary email address example: jsmith@company.com email2: type: string description: Secondary email address example: john@aol.com phone1: type: string description: Primary phone number example: '14085551212' phone2: type: string description: Secondary phone number example: '14085559876' mobile: type: string description: Mobile phone number example: '14085554420' pager: type: string description: Pager number example: '14085559987' fax: type: string description: Fax number example: '14085555309' URL1: type: string description: Web page address for this contact example: https://mycompany.com URL2: type: string description: Secondary web page address example: https://anothercompany.com companyName: type: string description: Name of the company example: AlcoSoft Inc mailingAddress: type: object description: Mailing address properties: addressLine1: type: string description: The first address line for shipping, billing, etc. example: 300 Park Avenue addressLine2: type: string description: The second address line for shipping, billing, etc. example: Suite 1400 addressLine3: type: string description: >- The third address line for shipping, billing, etc. which provides additional geographical information. example: Western industrial area city: type: string description: City example: San Jose state: type: string description: State example: California postCode: type: string description: Zip or Postal Code example: '95110' country: type: string description: Country example: United States 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 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' 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 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-invoice-tax-entry: type: object description: For VAT enabled transactions, invoice line items will have tax entries. allOf: - $ref: '#/components/schemas/tax-entries' - type: object properties: orderEntryTaxDetail: type: object description: >- Order Entry tax details describe a specific type of tax that applies to lines in Accounts Receivable transactions. properties: key: type: string description: System-assigned key for the tax detail. example: '1' id: type: string description: Unique ID for the tax detail. example: Alaska Tax Detail href: type: string description: URL endpoint for the tax detail object. readOnly: true example: /objects/tax/order-entry-tax-detail/1 invoiceLine: title: invoice-line description: Line item that the tax entries are associated with. readOnly: true type: object properties: id: type: string description: Unique ID for the invoice line object. example: '100' readOnly: true key: type: string description: Unique key for the invoice line object. example: '100' readOnly: true href: type: string description: URL endpoint for the invoice line object. 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' 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-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: 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: Action to take on the invoice. writeOnly: true example: submit default: submit enum: - submit - draft 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: > A invoices's state shows the current status of the invoice within the workflow. enum: - reversed - reversal - draft - noValue - posted - paid - partiallyPaid - selected example: posted default: posted readOnly: true dueInDays: type: integer description: Number of days until the invoice is due. readOnly: true example: 108 referenceNumber: type: string description: Customer purchase order number or another reference number. example: PO6917 description: type: string description: >- Description of the invoice, which prints on the Customer Ledger report. example: Regular invoice documentId: type: string description: ID of the associated document. example: Sales Invoice-SI-00188 discountCutOffDate: type: string format: date example: '2022-12-13' description: Date of the discount. readOnly: true invoiceDate: type: string format: date description: Date the invoice was created. example: '2022-12-06' dueDate: type: string format: date example: '2022-12-31' description: Date the invoice is due. currency: type: object description: Currency details for this invoice. properties: baseCurrency: type: string description: Base currency for the invoice. example: USD txnCurrency: type: string description: >- The transaction currency to use for this invoice. If this currency is different from the base currency, provide an exchange rate. example: USD exchangeRate: type: object description: Exchange rate details used to calculate the base amount. title: exchangeRate properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: Intacct Daily Rate totalBaseAmount: type: string format: decimal-precision-2 description: >- For multi-currency companies, total entered in the base currency of the company. readOnly: true example: '700000' totalBaseAmountDue: type: string format: decimal-precision-2 description: >- For multi-currency companies, total due in the base currency of the company. readOnly: true example: '700000' totalTxnAmount: type: string format: decimal-precision-2 description: Total transaction amount in the currency of the invoice. readOnly: true example: '700000' totalTxnAmountDue: type: string format: decimal-precision-2 description: Total transaction amount due in the currency of the invoice. readOnly: true example: '700000' dunningCount: type: integer description: Number of associated dunning notices. readOnly: true example: 1 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 lines: type: array description: Line items of the invoice. items: $ref: '#/components/schemas/accounts-receivable-invoice-line' entity: $ref: '#/components/schemas/entity-ref' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true accounts-receivable-recurring-invoice-tax-entry: type: object description: >- For VAT enabled transactions, recurring invoice line items will have tax entries. allOf: - $ref: '#/components/schemas/tax-entries' - type: object properties: orderEntryTaxDetail: type: object description: >- Order Entry tax details describe a specific type of tax that applies to lines in Accounts Receivable transactions. properties: key: type: string description: System-assigned key for the tax detail. example: '1' id: type: string description: Unique ID for the tax detail. example: Alaska Tax Detail href: type: string description: URL endpoint for the tax detail object. readOnly: true example: /objects/tax/order-entry-tax-detail/1 recurringInvoiceLine: title: recurring-invoice-line description: Line item that the tax entries are associated with. readOnly: true type: object properties: id: type: string description: Unique ID for the recurring invoice line object. example: '100' readOnly: true key: type: string description: Unique key for the recurring invoice line object. example: '100' readOnly: true href: type: string description: URL endpoint for the recurring invoice line object. 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' 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: 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. If 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`. 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 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: $ref: '#/components/schemas/audit' 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' 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 description of 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. example: 10 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: >- This determines the type of transaction that the summary contains. Options Invoice (ri), Adjustment (ra), Payments (rp), ManualDeposit (ri/rp), Discounts (rd). example: invoice enum: - invoice - payment - adjustment - discount - overpayment 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' 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' 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: {}