openapi: 3.0.0 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-beta2 description: Open Beta tags: - name: Invoices description: >- An invoice object represents an invoice sent to a customer for goods or services provided. x-displayName: Invoices - name: Invoice lines description: Line items in an invoice represent transactions captured in that invoice. x-displayName: Invoice lines - 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: 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: 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: 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: Customer email templates description: >- Customer email templates can be used to standardize messages sent to multiple customers.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Customer email templates - name: 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: 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: Advances description: >- Advances let you receive customer advance payments before creating an invoice, such as if a customer sends you a retainer
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Advances - name: Advance lines description: >- An advance line item is associated with a particular advance. Each advance can have any number of line items.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Advance lines - name: Billback templates description: >- Create a bill back template for each recurring bill back transaction. The template provides line item information needed in the bill back transaction, including invoice line items and corresponding line items in the system-generated bill.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Billback templates - name: Billback template lines description: >- Line items for a bill back template.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Billback template lines - name: Invoice summaries description: >- Invoice summaries are collections of the same type of transactions grouped together for processing. AR invoice summaries can be either open or closed. Invoices can be added to open summaries.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Invoice summaries - name: Payments description: >- A payment is a transaction used to record a payment against an invoice or an adjustment/debit memo. x-displayName: Payments - name: Payment lines description: >- Line items in a payment represent charges for items or services included in an invoice or adjustment.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Payment lines - name: Payment details description: >- A payment detail object can specify either an object, like an invoice or an adjustment, as a whole (header level), or it can specify a line item. A payment detail object also provides the transaction amount that was received.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Payment details - name: Payment summaries description: >- AR payment summaries are collections of the same type of transactions grouped together for processing. AR payment summaries can be either open or closed. Payments can be added to open summaries.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Payment summaries - name: Summaries description: >- Summaries are collections of the same type of transactions, grouped together for processing. Summaries can be either opened or closed. Invoices, adjustments, and deposits can be added to open summaries.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Summaries - name: Territories description: >- Territories are optionally included in customer records and are used with Accounts Receivable reports. They can be useful for filtering and categorizing data, assuming your company has multiple territories.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Territories - name: Territory groups description: >- Group territories to generate reports that contain data for that group of territories.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Territory groups - name: Territory group members description: >- A territory group member is an individual territory included in a territory group.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Territory group members - name: Customer item cross references description: >- Customer item cross references match the customer identifier for an item to the item ID your company uses, which makes transaction entry easier and more robust.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Customer item cross references - name: Customer contacts description: >- Contact information for a customer.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Customer contacts - name: Customer account groups description: >- Customer account groups
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Customer account groups - name: Recurring invoices description: >- Recurring invoices are invoices that repeat at periods and durations defined in a recurrence schedule. The system respects the company's accounting periods to generate and post transactions based on the defined month end.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Recurring invoices - name: Recurring invoice lines description: >- Line items in a recurring invoice represent transactions captured in that recurring invoice.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Recurring invoice lines - name: Posted overpayments description: >- Payments received that exceed the amount the customer owes are overpayments. Overpayments can be applied to future invoices or the excess can be returned to the customer.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Posted overpayments - name: Posted overpayment lines description: >- Line items in a posted overpayment.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Posted overpayment lines - name: Revenue recognition templates description: >- Revenue recognition templates define how to amortize deferred revenue. Each template is associated with an Accounts Receivable label or Order Entry Item GL group.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Revenue recognition templates - name: Revenue recognition template lines description: >- This object represents line entries in a revenue recognition template.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Revenue recognition template lines - name: Revenue recognition template milestones description: >- Milestone information for revenue recognition templates that have a recognition method of percent complete, milestone, or custom.
Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.
x-displayName: Revenue recognition template milestones paths: /objects/accounts-receivable/invoice: get: summary: List invoices description: >+ Returns a collection with a key, ID, and link for each invoice. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsList, View Invoices
tags: - Invoices operationId: list-accounts-receivable-invoice responses: '200': description: OK content: application/json: schema: type: object title: List of invoice objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List invoices: value: ia::result: - key: '498' id: '498' href: /objects/accounts-receivable/invoice/498 - key: '501' id: '501' href: /objects/accounts-receivable/invoice/501 - key: '978' id: '978' href: /objects/accounts-receivable/invoice/978 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an invoice description: >+ Creates a new invoice. For the invoice to be posted, you must specify at least the account and an amount for each line item.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsAdd Invoices
tags: - Invoices operationId: create-accounts-receivable-invoice requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-invoice' - $ref: '#/components/schemas/accounts-receivable-invoiceRequiredProperties' examples: Create an invoice: value: invoiceNumber: SI-0034 customer: id: C-00019 customerMessageId: Greeting01 referenceNumber: B9R456 description: Regular invoice term: id: N15 invoiceDate: '2022-12-06' dueDate: '2022-12-31' currency: txnCurrency: USD exchangeRate: date: '2022-12-06' typeId: Intacct Daily Rate rate: 0.05112 contacts: payTo: id: Power Aerospace Materials(C1) returnTo: id: Power Aerospace Materials(C1) lines: - txnAmount: '100.40' glAccount: id: '5004' accountLabel: id: SWL001 dimensions: department: id: SA location: id: CA customer: id: '1652' - txnAmount: '-10' glAccount: id: '5004' accountLabel: id: SWL001 dimensions: department: id: SA location: id: CA customer: id: '1652' responses: '201': description: Created content: application/json: schema: type: object title: New invoice properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New invoice: value: ia::result: id: '2091' key: '2091' href: /objects/accounts-receivable/invoice/2091 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice/{key}: parameters: - name: key description: System-assigned key for the invoice. in: path required: true schema: type: string get: summary: Get an invoice description: >+ Returns detailed information for a specified invoice.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsList, View Invoices
tags: - Invoices operationId: get-accounts-receivable-invoice-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the invoice properties: ia::result: $ref: '#/components/schemas/accounts-receivable-invoice' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an invoice: value: ia::result: id: '2091' key: '2091' recordType: ri invoiceNumber: newInv10 state: posted customer: id: C-00019 key: '14' name: Power Aerospace Materials emailOption: false customerDue: '20106.8' deliveryOptions: print href: /objects/accounts-receivable/customer/14 customerMessageId: Greeting01 customerMessage: Thank your for your business. referenceNumber: B9R456 description: Regular invoice orderEntry: documentId: Sales Invoice B9-R456 term: id: N15 key: '1' href: /objects/accounts-receivable/term/1 invoiceDate: '2022-12-06' audit: createdDateTime: '2022-12-06T00:00:00Z' modifiedDateTime: '2023-04-18T16:59:05Z' createdBy: '1' modifiedBy: '1' invoiceSummary: glPostingDate: '2022-12-06' title: 'Invoices: 2023/03/21 22:04:36:8980 Batch' key: '854' id: '854' isSummaryOpen: open isSummaryPosted: 'false' discountCutOffDate: '2022-12-13' dueDate: '2022-12-31' paymentInformation: fullyPaidDate: null totalBaseAmountSelectedForPayment: '0' totalBaseAmountPaid: '0' totalTxnAmountSelectedForPayment: '0' totalTxnAmountPaid: '0' currency: baseCurrency: USD txnCurrency: MXN exchangeRate: date: '2022-12-06' typeId: Intacct Daily Rate rate: 0.05112 totalBaseAmount: '4.62' totalBaseAmountDue: '4.62' totalTxnAmount: '90.4' totalTxnAmountDue: '90.4' contacts: payTo: id: Power Aerospace Materials(C1) key: '725' returnTo: id: Power Aerospace Materials(C1) key: '725' moduleKey: accountsReceivable recurringSchedule: key: '20' isSystemGeneratedDocument: false billbackTemplate: id: BBT-error5 key: '18' dueInDays: 108 attachment: id: '11' key: '11' dunningCount: 0 lines: - id: '4338' key: '4338' invoice: id: '2091' key: '2091' href: /objects/accounts-receivable/invoice/2091 glAccount: key: '218' id: '5004' name: Commissions Paid href: /objects/gl-account/218 overrideOffsetGLAccount: key: '36' id: '1200' name: Accounts Receivable href: /objects/general-ledger/account/36 accountLabel: name: Commissions Paid key: '14' id: Accounts Receivable - Microcomputer createdDate: '2022-12-06' baseAmount: '5.13' txnAmount: '100.40' dimensions: department: key: '31' id: SA name: Sales href: /objects/company-config/department/31 location: key: '10' id: North America name: North America href: /objects/company-config/location/10 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/company-config/customer/1 baseLocation: name: North America key: '10' href: /objects/company-config/location/10 memo: hello line 1 currency: exchangeRate: date: '2022-06-12' typeId: '-1' rate: 0.05112 txnCurrency: MXN baseCurrency: USD allocation: id: '22' key: '22' name: Premium allocation lineNumber: 1 paymentInformation: totalBaseAmountPaid: '.51' totalTxnAmountPaid: '10' totalBaseAmountSelectedForPayment: '0' totalTxnAmountSelectedForPayment: '0' isSubtotal: null audit: createdDateTime: '2023-04-18T16:54:13Z' modifiedDateTime: '2023-04-18T16:59:05Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/invoice-line/4338 - id: '4340' key: '4340' invoice: id: '2091' key: '2091' href: /objects/accounts-receivable/invoice/2091 glAccount: key: '218' id: '5004' name: Commissions Paid href: /objects/gl-account/218 overrideOffsetGLAccount: key: '36' id: '1200' name: Accounts Receivable href: /objects/gl-account/36 accountLabel: name: Commissions Paid key: '14' id: Accounts Receivable - Microcomputer createdDate: '2022-12-06' baseAmount: '-.51' txnAmount: '-10.00' dimensions: department: key: '31' id: SA name: Sales href: /objects/department/31 location: key: '10' id: North America name: North America href: /objects/location/10 customer: key: '1' id: '1' name: Power Aerospace Materials href: /objects/customer/1 baseLocation: name: North America key: '10' href: /objects/location/10 memo: Current Q1 charges currency: exchangeRate: date: '2022-06-12' typeId: '-1' rate: 0.05112 txnCurrency: MXN baseCurrency: USD allocation: id: '22' key: '22' name: Premium allocation lineNumber: 2 paymentInformation: totalBaseAmountPaid: '-.51' totalTxnAmountPaid: '-10' totalBaseAmountSelectedForPayment: '0' totalTxnAmountSelectedForPayment: '0' isSubtotal: null audit: createdDateTime: '2023-04-18T16:54:13Z' modifiedDateTime: '2023-04-18T16:59:05Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/invoice-line/4340 href: /objects/accounts-receivable/invoice/2091 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an invoice description: >+ Updates an existing invoice by setting field values. Any fields not provided remain unchanged. Allowed edits depend on the state an invoice is in. For more information, see [About editing invoices](https://www.intacct.com/ia/docs/en_US/help_action/Accounts_Receivable/Invoices/Tasks/edit-an-invoice-overview.htm).
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsEdit Invoices
tags: - Invoices operationId: update-accounts-receivable-invoice-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-invoice' - type: object properties: id: readOnly: true examples: Update a single value: value: description: Special off-cycle order responses: '200': description: OK content: application/json: schema: type: object title: Updated invoice properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: id: '2091' key: '2091' href: /objects/accounts-receivable/invoice/2091 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an invoice description: >+ Deletes an invoice. Only invoices with a `draft` or `posted` state can be deleted.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsDelete Invoices
tags: - Invoices operationId: delete-accounts-receivable-invoice-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice-line: get: summary: List invoice lines description: >+ Returns a collection with a key, ID, and link for each invoice line item. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsList, View Invoices
tags: - Invoice lines operationId: list-accounts-receivable-invoice-line responses: '200': description: OK content: application/json: schema: type: object title: List of invoice line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List invoice lines: value: ia::result: - key: '1' id: '1' href: /objects/accounts-receivable/invoice-line/1 - key: '3' id: '3' href: /objects/accounts-receivable/invoice-line/3 - key: '19' id: '19' href: /objects/accounts-receivable/invoice-line/19 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice-line/{key}: parameters: - name: key description: System-assigned unique key for the invoice line item. in: path required: true schema: type: string get: summary: Get an invoice line description: >+ Returns detailed information for a specified invoice line item.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Approver
PermissionsList, View Invoices
tags: - Invoice lines operationId: get-accounts-receivable-invoice-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the invoice line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-invoice-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an invoice line: value: ia::result: id: '1' key: '1' invoice: id: '6' key: '6' href: /objects/accounts-receivable/invoice/6 glAccount: key: '194' id: '4000' name: Sales href: /objects/general-ledger/account/194 overrideOffsetGLAccount: key: '36' id: '1200' name: Accounts Receivable href: /objects/general-ledger/account/36 accountLabel: name: Sales key: '35' id: Sales href: /objects/accounts-receivable/account-label/35 createdDate: '2022-04-20' baseAmount: '24115.65' txnAmount: '16740.00' dimensions: department: key: '1' id: '01' name: Sales href: objects/company-config/department/1 location: key: '19' id: CA name: California href: /objects/company-config/location/19 customer: key: '11' id: '11' name: Power Aerospace Materials href: /objects/company-config/customer/11 baseLocation: name: United States of America key: '1' href: /objects/company-config/location/1 memo: Replaces discontinued part currency: exchangeRate: date: '2022-01-23' typeId: '-1' rate: 1.4406 txnCurrency: EUR baseCurrency: USD allocation: id: null key: null name: null lineNumber: 1 paymentInformation: totalBaseAmountPaid: '35' totalTxnAmountPaid: '35' totalBaseAmountSelectedForPayment: '0' totalTxnAmountSelectedForPayment: '0' isSubtotal: null audit: createdDateTime: '2022-04-21T09:37:41Z' modifiedDateTime: '2022-11-22T05:11:50Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/invoice-line/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/account-label: get: summary: List account labels description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each label. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View AR Account Labels
tags: - Account labels operationId: list-accounts-receivable-account-label responses: '200': description: OK content: application/json: schema: type: object title: List of ar-account-label objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List account labels: value: ia::result: - key: '9' id: Retail Sales href: /objects/accounts-receivable/account-label/9 - key: '41' id: Retail Sales 2 href: /objects/accounts-receivable/account-label/41 - key: '10' id: Sales href: /objects/accounts-receivable/account-label/10 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an account label description: >+ Creates a new AR account label.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Add AR Account Labels
tags: - Account labels operationId: create-accounts-receivable-account-label requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-account-label' - $ref: '#/components/schemas/accounts-receivable-account-labelRequiredProperties' examples: Create an account label: value: id: Wholesale Sales description: Wholesale sales north america glAccount: id: '2050' status: active offsetGLAccount: id: '1200.01' responses: '201': description: Created content: application/json: schema: type: object title: New ar-account-label properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create an account label: value: ia::result: key: '110' id: Wholesale Sales href: /objects/accounts-receivable/account-label/110 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/account-label/{key}: parameters: - name: key description: System-assigned key for the account label. in: path required: true schema: type: integer example: 110 get: summary: Get an account label description: >+ Returns detailed information for a specified AR account label.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View AR Account Labels
tags: - Account labels operationId: get-accounts-receivable-account-label-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the ar-account-label properties: ia::result: $ref: '#/components/schemas/accounts-receivable-account-label' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an account label: value: ia::result: key: '110' id: Wholesale Sales description: Wholesale Sales north america glAccount: id: 2050--Accured Compensation key: '197' href: /objects/account/197 status: active offsetGLAccount: id: 1200.01--Accounts Receivable - a/c label offset key: '168' href: /objects/account/168 href: /objects/accounts-receivable/account-label/110 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an account label description: >+ Updates an existing AR account label by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Edit AR Account Labels
tags: - Account labels operationId: update-accounts-receivable-account-label-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-account-label' - type: object properties: id: readOnly: true examples: Update a single value: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Updated account label properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated label: value: ia::result: key: '110' id: Test_AR_Account_Label href: /objects/accounts-receivable/account-label/110 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an account label description: >+ Deletes an AR account label.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Delete AR Account Labels
tags: - Account labels operationId: delete-accounts-receivable-account-label-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/term: get: summary: List terms description: >- Returns a collection with a key, ID, and link for each AR term. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Terms operationId: list-accounts-receivable-term responses: '200': description: OK content: application/json: schema: type: object title: List of ar-term objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List terms: value: ia::result: - key: '5' id: N15 href: /objects/accounts-receivable/term/5 - key: '8' id: N30 href: /objects/accounts-receivable/term/8 - key: '9' id: NET15 href: /objects/accounts-receivable/term/9 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a term description: Creates a new AR term. tags: - Terms operationId: create-accounts-receivable-term requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-term' - $ref: '#/components/schemas/accounts-receivable-termRequiredProperties' examples: Create a term: value: ia::result: key: '29' id: arterm3 href: /objects/accounts-receivable/term/29 ia::meta: totalCount: 1 responses: '201': description: Created content: application/json: schema: type: object title: New term properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a term: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/term/{key}: parameters: - name: key description: System-assigned key for the term. in: path required: true schema: type: string get: summary: Get a term description: Returns detailed information for a specified AR term. tags: - Terms operationId: get-accounts-receivable-term-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the term properties: ia::result: $ref: '#/components/schemas/accounts-receivable-term' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a term: value: ia::result: id: arterm5 description: desc5 status: active key: '24' audit: modifiedDateTime: '2021-04-30T20:37:48Z' createdDateTime: '2021-04-30T20:37:48Z' modifiedBy: '1' createdBy: '1' due: days: 2 from: of5thMonthFromBillDate discount: days: 1 from: of3rdMonthFromBillDate amount: 10 unit: amount graceDays: 15 calculateOn: billTotal penalty: cycle: quarterly amount: 101 unit: amount graceDays: 16 href: /objects/accounts-receivable/term/24 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a term description: >- Updates an existing AR term by setting field values. Any fields not provided remain unchanged. tags: - Terms operationId: update-accounts-receivable-term-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-term' - type: object properties: id: readOnly: true examples: Update a term: {} responses: '200': description: OK content: application/json: schema: type: object title: Updated ar-term properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated term: value: ia::result: key: '26' id: arterm1 href: /objects/accounts-receivable/term/26 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a term description: Deletes an AR term. tags: - Terms operationId: delete-accounts-receivable-term-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer: get: summary: List customers description: >+ Returns a collection with a key, ID, and link for each customer. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Customers
tags: - Customers operationId: list-accounts-receivable-customer responses: '200': description: OK content: application/json: schema: type: object title: List of customer objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List customers: value: ia::result: - key: '68' id: CUST-100 href: /objects/accounts-receivable/customer/68 - key: '69' id: CUST-200 href: /objects/accounts-receivable/customer/69 - key: '73' id: CUST-300 href: /objects/accounts-receivable/customer/73 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a customer description: >+ Creates a new customer.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Add Customers
tags: - Customers operationId: create-accounts-receivable-customer requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer' - $ref: '#/components/schemas/accounts-receivable-customerRequiredProperties' examples: Create a customer: value: id: CUST-002 name: Starluck taxId: 12-3456789 creditLimit: 50000 status: active responses: '201': description: Created content: application/json: examples: Create a customer: value: ia::result: key: '32' id: CUST-200 href: /objects/accounts-receivable/customer/32 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 schema: type: object title: New customer properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer/{key}: parameters: - schema: type: string example: '81' name: key in: path required: true description: System-assigned key for the customer. get: summary: Get a customer description: |+ Returns detailed information for a specified customer.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Customers
tags: - Customers operationId: get-accounts-receivable-customer-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the customer properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a customer: value: ia::result: key: '1' id: PAMats name: Power Aerospace Materials parent: key: '2055' id: '12' name: '12' href: /objects/accounts-receivable/customer/2055 contacts: default: mailingAddress: addressLine1: 1120 Harbor Bay Pkwy addressLine2: St John's street addressLine3: Double cross road city: Sacramento country: United States postCode: 95119-1208 state: CA tax: isTaxable: true URL1: www.google.com URL2: www.google.com companyName: Logic Solutions email1: user@domain.com email2: user2@domain.com fax: (925) 123-4567 firstName: Sandy id: Test customer 1(CtestCust1) lastName: Tieber middleName: E mobile: (925) 123-4567 pager: (925) 123-4567 phone1: (408) 395-2539 phone2: (408) 395-2540 printAs: Mr. Sandy Tieber key: '394' hideContactList: false href: /objects/company-config/contact/394 primary: id: Aron key: '106' href: /objects/company-config/contact/106 shipTo: id: Alex key: '107' href: /objects/company-config/contact/107 billTo: id: Ben key: '108' href: /objects/company-config/contact/108 term: id: 15DaysExtToEOM key: '26' href: /objects/accounts-receivable/term/26 salesRepresentative: id: EM M name: Aaron key: '89' href: /objects/company-config/employee/89 resaleNumber: 123456789 taxId: '123456803' creditLimit: 20000 totalDue: '99999.99' notes: Sample Notes accountLabel: id: Pledges key: '9' defaultRevenueGLAccount: id: '2080.06' name: Germany(France) - Inter Entity Payable key: '136' href: /objects/general-ledger/account/136 lastInvoiceCreatedDate: '2021-10-12' lastStatementGeneratedDate: '2023-02-28' deliveryOptions: print territory: id: '23456' name: North East key: '23456' shippingMethod: id: Fedex key: '3' href: /objects/accounts-receivable/shipping-method/3 customerType: id: DOCS key: '13' href: /objects/accounts-receivable/customer-type/13 accountGroup: key: '10' id: Auto CGL Group href: /objects/accounts-receivable/customer-account-group/10 priceSchedule: id: '101' key: '101' href: /objects/purchasing/price-schedule/101 discountPercent: '10' priceList: id: Base Price List key: '1' href: /objects/order-entry/price-list/1 currency: USD status: active isOneTimeUse: false customerMessageId: test abhi isOnHold: false overridePriceList: Customer enableOnlineCardPayment: true enableOnlineACHPayment: true audit: modifiedDateTime: '2023-12-14T11:31:06Z' createdDateTime: '2018-07-28T19:22:31Z' createdBy: '1' modifiedBy: '1' restrictions: restrictionType: restricted locations: - North America--North America - GM--Gulf of Mexico - BG--Bangalore - NY--New York departments: - 1st Level Depts--Level 1 Departments - 2nd Level Depts--Level 2 Departments overrideOffsetGLAccount: id: '1120' name: Pledges Receivable emailOptIn: false contactList: - id: '150' key: '150' categoryName: ship audit: modifiedDateTime: '2023-12-14T11:31:06Z' createdDateTime: '2022-06-07T12:37:37Z' createdBy: '1' modifiedBy: '1' customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 contact: key: '106' id: Aron href: /objects/company-config/contact/106 href: /objects/accounts-receivable/customer-contact/150 customerEmailTemplates: - id: '8' key: '8' customer: key: '1' id: '1' href: /objects/accounts-receivable/customer/1 txnDefinitionName: Sales Quote emailTemplate: id: '4' key: '4' name: OETemplate href: /objects/company-config/email-template/4 templateType: soDocument href: '/objects/accounts-receivable/customer-email-template/8' href: /objects/accounts-receivable/customer/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a customer description: >+ Updates an existing customer by setting field values. Any fields not provided remain unchanged. Customers included in posted transactions will not be updated. Only new transactions and records will refer to the updated customer information.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Edit Customers
tags: - Customers operationId: update-accounts-receivable-customer-key responses: '200': description: OK content: application/json: schema: type: object title: Updated customer properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated customer: value: ia::result: key: '34' id: CUST-100 href: /objects/accounts-receivable/payment/34 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer' - type: object properties: id: readOnly: true examples: Update a single value: value: creditLimit: 10000 security: - OAuth2: [] delete: summary: Delete a customer description: >+ Deletes a customer. Customers that have already been used in a transaction cannot be deleted. Instead, you can update customers that have already been used to make them inactive.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Delete Customers
tags: - Customers operationId: delete-accounts-receivable-customer-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-type: get: summary: List customer types description: >+ Returns a collection with a key, ID, and link for each customer type. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Project Manager, and Warehouse
PermissionsList, View Customer Types
tags: - Customer types responses: '200': description: OK content: application/json: schema: type: object title: List of customer-type objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List customer types: value: ia::result: - key: '1' id: Account Manager href: /objects/accounts-receivable/customer-type/1 - key: '2' id: Auto ACH href: /objects/accounts-receivable/customer-type/2 - key: '3' id: Auto CC Payment href: /objects/accounts-receivable/customer-type/3 - key: '4' id: Credit Card href: /objects/accounts-receivable/customer-type/4 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' operationId: list-accounts-receivable-customer-type security: - OAuth2: [] post: summary: Create a customer type description: >+ Creates a new customer type.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Add Customer Types
tags: - Customer types operationId: create-accounts-receivable-customer-type responses: '201': description: Created content: application/json: schema: type: object title: New customer-type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a customer type: value: ia::result: key: '9' id: Client Start Trial href: /objects/accounts-receivable/customer-type/9 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-type' - $ref: '#/components/schemas/accounts-receivable-customer-typeRequiredProperties' examples: Create a customer type: value: id: Top Level Customer status: active security: - OAuth2: [] /objects/accounts-receivable/customer-type/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the customer type. example: '4' get: summary: Get a customer type description: >+ Returns detailed information for a specified customer type.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Customer Types
tags: - Customer types responses: '200': description: OK content: application/json: schema: type: object title: Details of the customer-type properties: ia::result: $ref: '#/components/schemas/accounts-receivable-customer-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a customer type: value: ia::result: id: Client Start Trial parent: key: '1' id: Account Manager status: active key: '9' audit: createdDateTime: '2022-01-07T06:18:51Z' modifiedDateTime: '2022-01-07T06:18:51Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/customer-type/9 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' operationId: get-accounts-receivable-customer-type-key security: - OAuth2: [] patch: summary: Update a customer type description: >+ Updates an existing customer type by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Edit Customer Types
tags: - Customer types operationId: update-accounts-receivable-customer-type-key responses: '200': description: OK content: application/json: schema: type: object title: Updated customer-type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a customer type: value: ia::result: key: '2' id: Auto ACH href: /objects/accounts-receivable/customer-type/2 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-type' - type: object properties: id: readOnly: true examples: Update a customer type: value: status: inactive Update a parent customer type: value: parent: id: Top Level Customer status: inactive security: - OAuth2: [] delete: summary: Delete a customer type description: >+ Deletes a customer type.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Delete Customer Types
tags: - Customer types operationId: delete-accounts-receivable-customer-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-email-template: get: summary: List customer email templates description: >- Returns a collection with a key, ID, and link for each customer email template. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - 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 href: /objects/company-config/email-template/4 templateType: arInvoice href: /objects/accounts-receivable/customer-email-template/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a customer email template description: >- Updates an existing customer email template by setting field values. Any fields not provided remain unchanged. tags: - 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/adjustment: get: summary: List adjustments description: >+ Returns a collection with a key, ID, and link for each adjustment. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Adjustments
tags: - Adjustments operationId: list-accounts-receivable-adjustment responses: '200': description: OK content: application/json: schema: type: object title: List of adjustment objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List adjustments: value: ia::result: - key: '259' id: '259' href: /objects/accounts-receivable/adjustment/259 - key: '295' id: '295' href: /objects/accounts-receivable/adjustment/295 - key: '296' id: '296' href: /objects/accounts-receivable/adjustment/296 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an adjustment description: >+ Creates a new adjustment.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, and Add Adjustments
tags: - Adjustments operationId: create-accounts-receivable-adjustment requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-adjustment' - $ref: '#/components/schemas/accounts-receivable-adjustmentRequiredProperties' examples: Create an adjustment: value: customer: id: C-00005 createdDate: '2023-06-28' description: Lyon USD Adj baseCurrency: paidDate: '2022-11-15' currency: USD txnCurrency: currency: USD lines: - txnCurrency: amount: '120.03' currency: USD glAccount: id: '2990' dimensions: location: id: CA responses: '201': description: Created content: application/json: schema: type: object title: New adjustment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new adjustment: value: ia::result: id: '270' key: '270' href: /objects/accounts-receivable/adjustment/270 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/adjustment/{key}: parameters: - name: key description: System-assigned unique key for the adjustment. in: path required: true schema: type: string get: summary: Get an adjustment description: >+ Returns detailed information for a specified adjustment.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View Adjustments
tags: - Adjustments operationId: get-accounts-receivable-adjustment-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the adjustment properties: ia::result: $ref: '#/components/schemas/accounts-receivable-adjustment' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an adjustment: value: ia::result: id: '7' key: '7' txnType: ra adjustmentNumber: null state: posted customer: id: C-00003 key: '14' name: Lyon Worldwide totalDue: '1344041.29' href: /objects/accounts-receivable/customer/14 documentNumber: SI-00183 description: null createdDate: '2023-12-18' audit: createdDateTime: '2023-12-18T00:00:00Z' modifiedDateTime: '2023-02-08T11:16:19Z' createdBy: null modifiedBy: null glPostingDate: '2023-12-18' attachment: id: null key: null baseCurrency: paidDate: null currency: USD totalSelected: '0' totalPaid: '0' totalAmountEntered: '295.00' totalDue: '295.00' txnCurrency: currency: USD totalEntered: '295.00' totalSelected: '0' totalPaid: '0' totalDue: '295.00' exchangeRate: date: null typeId: null rate: null contacts: billTo: id: Power Aerospace Materials (C1) key: '916' href: /objects/company-config/contact/916 shipTo: id: Power Aerospace Materials (C1) key: '312' href: /objects/company-config/contact/312 moduleKey: 4.AR lines: - id: '115' key: '115' arAdjustment: id: '7' key: '7' href: /objects/accounts-receivable/adjustment/7 glAccount: key: '153' id: '2995' name: Deferred Revenue Maintenance href: /objects/general-ledger/account/153 accountLabel: key: null id: null baseCurrency: amount: '295.00' currency: USD txnCurrency: amount: '295.00' currency: USD dimensions: department: key: 1 id: '01' name: Sales href: /objects/company-config/department/1 location: key: 1 id: CA name: California href: /objects/company-config/location/1 class: key: null id: null name: null item: key: '1' id: MTN01-12 name: Maintenance 12 month Contract href: /objects/inventory-control/item/1 customer: key: null id: null name: null vendor: key: '1' id: C-00003V name: BT Corp of America href: /objects/accounts-payable/vendor/1 project: key: null id: null name: null employee: key: null id: null name: null warehouse: key: null id: null name: null contract: key: null id: null name: null task: key: null id: null name: null memo: null exchangeRate: date: null typeId: null rate: '1' lineNumber: '1' adjustmentType: null isTax: false audit: createdDateTime: '2023-03-23T13:10:29Z' modifiedDateTime: '2023-03-24T10:45:23Z' createdBy: 1 modifiedBy: 1 href: /objects/accounts-receivable/adjustment-line/115 href: /objects/accounts-receivable/adjustment/7 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an adjustment description: >+ Updates an existing adjustment by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Edit Adjustments
tags: - Adjustments operationId: update-accounts-receivable-adjustment-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-adjustment' - type: object properties: id: readOnly: true examples: Update an adjustment: value: description: May 2023 Refund responses: '200': description: OK content: application/json: schema: type: object title: Updated adjustment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated adjustment: value: ia::result: id: '16855' key: '16855' href: /objects/accounts-receivable/adjustment/16855 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an adjustment description: >+ Deletes an adjustment. An adjustment can be deleted if it has not yet been applied to an invoice.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness, Employee, Project Manager, and Warehouse users
PermissionsList, View, Delete Adjustments
tags: - Adjustments operationId: delete-accounts-receivable-adjustment-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/adjustment-line: get: summary: List adjustment lines description: >- Returns a collection with a key, ID, and link for each adjustment line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Adjustment lines operationId: list-accounts-receivable-adjustment-line responses: '200': description: OK content: application/json: schema: type: object title: List of adjustment-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get adjustments: value: ia::result: - key: '2651' id: '2651' href: /objects/accounts-receivable/adjustment-line/2651 - key: '2563' id: '2563' href: /objects/accounts-receivable/adjustment-line/2563 - key: '3481' id: '3481' href: /objects/accounts-receivable/adjustment-line/3481 ia::meta: totalCount: 3 start: 1 ageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/adjustment-line/{key}: parameters: - name: key description: System-assigned key for the adjustment line. in: path required: true schema: type: string get: summary: Get an adjustment line description: Returns detailed information for a specified adjustment line. tags: - Adjustment lines operationId: get-accounts-receivable-adjustment-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the adjustment-line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-adjustment-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an adjustment line: value: ia::result: id: '625' key: '625' arAdjustment: id: '270' key: '270' href: /objects/accounts-receivable/adjustment/270 glAccount: key: '348' id: '7510' name: Other Expense href: /objects/general-ledger/account/348 accountLabel: key: '36' id: InterCompany Sales href: /objects/accounts-receivable/account-label/36 department: key: '9' id: 11 name: Accounting href: /objects/company-config/department/9 location: key: '1' id: 1 name: United States of America href: /objects/company-config/location/1 description: null baseCurrency: currency: USD amount: '95' exchangeRate: date: '2023-01-23' typeId: '1' rate: '1' txnCurrency: currency: USD amount: '95' lineNumber: '1' state: approved adjustmentType: ra isTax: false audit: createdDateTime: '2023-03-23T13:10:29Z' modifiedDateTime: '2023-03-31T09:33:03Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/adjustment-line/625 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/advance: get: summary: List advances description: Returns a collection with a key, ID, and link for each advance. tags: - Advances operationId: list-accounts-receivable-advance responses: '200': description: OK content: application/json: schema: type: object title: List of advance objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of advances: value: ia::result: - key: '621' id: '621' href: /objects/accounts-receivable/advance/621 - key: '777' id: '777' href: /objects/accounts-receivable/advance-line/777 - key: '802' id: '802' href: /objects/accounts-receivable/advance-line/802 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an advance description: Creates a new advance. tags: - Advances operationId: create-accounts-receivable-advance requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-advance' - $ref: '#/components/schemas/accounts-receivable-advanceRequiredProperties' examples: Creates an advance: value: customer: id: '0203' paymentDate: '2023-04-25' receiptDate: '2023-04-25' advanceSummary: name: Divya summary paymentMethod: cash items: - glAccount: id: '2200' txnAmount: '10' dimensions: location: id: '1' responses: '201': description: Created content: application/json: schema: type: object title: New advance properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New advance: value: ia::result: key: '799' id: '799' href: /objects/accounts-receivable/advance/799 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/advance/{key}: parameters: - name: key description: system-assigned unique key for the advance. in: path required: true schema: type: string get: summary: Get an advance description: Returns detailed information for a particular advance. tags: - Advances operationId: get-accounts-receivable-advance-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the advance properties: ia::result: $ref: '#/components/schemas/accounts-receivable-advance' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the advance: value: ia::result: key: '799' id: '799' advanceSummary: key: 239 id: '239' name: Divya summary isSummaryOpen: open href: /objects/accounts-receivable/summary/239 glAccount: undepositedAccountNumber: '' paymentMethod: cash paymentMethodKey: 6 customer: id: '0203' key: '0203' name: Divya H href: /objects/accounts-receivable/customer/0203 referenceNumber: Text description: '' currency: baseCurrency: USD txnCurrency: USD exchangeRateDate: '2023-04-25' exchangeRateTypeId: '' exchangeRate: 1 receiptDate: '2023-04-25' paymentDate: '2023-04-25' recordType: rr state: posted totalEntered: '10.00' txnTotalEntered: '10.00' paymentInformation: totalBaseAmountPaid: '0.00' txnTotalPaid: '0.00' paidDate: '2023-04-25' totalDue: '10.00' totalTxnAmountDue: '10.00' audit: modifiedDateTime: '2023-06-13T07:31:51Z' createdBy: '1' modifiedBy: '1' createdDateTime: '2023-04-25T00:00:00Z' reconciliationGroup: cleared: 'false' clearingdDate: '' isSystemGenerated: false attachment: key: '' items: - key: '2067' id: '2067' advance: id: '799' key: '799' recordType: rr href: /objects/accounts-receivable/advance/799 glAccount: key: '156' id: '2200' name: Customer Advances href: /objects/general-ledger/account/156 accountLabel: name: Customer Advances id: '' baseAmount: '10.00' txnAmount: '10.00' dimensions: department: key: '' id: '' name: '' location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 project: key: '' id: '' name: '' customer: key: '' id: '' name: '' vendor: key: '' id: '' name: '' employee: key: '' id: '' name: '' item: key: '' id: '' name: '' class: key: '' id: '' name: '' baseLocation: name: United States of America key: '1' href: /objects/company-config/location/1 createdDate: '2023-04-25' memo: '' currency: exchangeRate: date: '2023-04-25' typeId: '' rate: 1 baseCurrency: USD txnCurrency: USD lineItem: t lineNumber: 1 paymentInformation: totalPaid: '0.00' txnTotalPaid: '0.00' totalSelected: '0.00' txnTotalSelected: '0.00' audit: createdDateTime: '2023-06-13T06:42:36Z' modifiedDateTime: '2023-06-13T07:31:51Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/advance-line/2067 href: /objects/accounts-receivable/advance/799 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an advance description: >- Updates an existing advance by setting field values. Any fields not provided remain unchanged. tags: - Advances operationId: update-accounts-receivable-advance-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-advance' - type: object properties: id: readOnly: true examples: Updates an advance: value: referenceNumber: DOC1234 responses: '200': description: OK content: application/json: schema: type: object title: Updated advance properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated advance: value: ia::result: key: '799' id: '799' href: /objects/accounts-receivable/advance/799 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/advance-line: get: summary: List advance lines description: >- Returns a collection with a key, ID, and link for each advance line item. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Advance lines operationId: list-accounts-receivable-advance-line responses: '200': description: OK content: application/json: schema: type: object title: List advance lines properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List advance lines: value: ia::result: - key: '2031' id: '2031' href: /objects/accounts-receivable/advance-line/2031 - key: '2067' id: '2067' href: /objects/accounts-receivable/advance-line/2067 - key: '856' id: '856' href: /objects/accounts-receivable/advance-line/856 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/advance-line/{key}: parameters: - name: key description: System-assigned unique key for the advance line. in: path required: true schema: type: string get: summary: Get an advance line description: Returns detailed information for a specified advance line. tags: - Advance lines operationId: get-accounts-receivable-advance-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the advance line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-advance-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an advance line: value: ia::result: key: '2067' id: '2067' advance: id: '799' key: '799' recordType: rr href: /objects/accounts-receivable/advance/799 glAccount: key: '156' id: '2200' name: Customer Advances href: /objects/general-ledger/account/156 accountLabel: name: Customer Advances id: '' baseAmount: '100.00' txnAmount: '100.00' dimensions: department: key: '' id: '' name: '' location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 project: key: '' id: '' name: '' customer: key: '36' id: C-00045 name: MetroArtic, Inc. href: /objects/accounts-receivable/customer/36 vendor: key: '' id: '' name: '' employee: key: '' id: '' name: '' item: key: '' id: '' name: '' class: key: '' id: '' name: '' baseLocation: name: United States of America key: '1' href: /objects/company-config/location/1 createdDate: '2023-04-25' memo: New contract down payment currency: exchangeRate: date: '2023-04-25' typeId: '' rate: 1 baseCurrency: USD txnCurrency: USD lineNumber: 1 paymentInformation: totalPaid: '100.00' txnTotalPaid: '100.00' totalSelected: '100.00' txnTotalSelected: '100.00' audit: createdDateTime: '2023-06-13T06:42:36Z' modifiedDateTime: '2023-06-13T07:31:51Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/advance-line/2067 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/billback-template: get: summary: List billback templates description: >- Returns a collection with a key, ID, and link for each billback template. tags: - 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 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/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 of billback template lines: value: ia::result: - key: '1' id: '1' href: /objects/accounts-receivable/billback-template-line/1 - key: '8' id: '8' href: /objects/accounts-receivable/billback-template-line/8 - key: '9' id: '9' href: /objects/accounts-receivable/billback-template-line/9 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/billback-template-line/{key}: parameters: - name: key description: System-assigned key for the billback template line. in: path required: true schema: type: string get: summary: Get a/an billback template line description: Returns detailed information for a particular billback template line. tags: - Billback template lines operationId: get-accounts-receivable-billback-template-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the billback-template-line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-billback-template-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the billback template line: value: ia::result: key: '1' id: '1' billbackTemplate: id: '1' key: '1' href: /objects/accounts-receivable/billback-template/1 lineNumber: '0' invoiceGLAccount: key: '194' id: '4000' name: Sales href: /objects/general-ledger/account/194 billGLAccount: key: '207' id: '5001' name: Construction href: /objects/general-ledger/account/207 department: key: '9' id: '11' name: Accounting href: /objects/company-config/department/9 memo: line 1 href: /objects/accounts-receivable/billback-template-line/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice-summary: get: summary: List invoice summaries description: >+ Returns a collection with a key, ID, and link for each AR invoice summary. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Summaries
tags: - Invoice summaries operationId: list-accounts-receivable-invoice-summary responses: '200': description: OK content: application/json: schema: type: object title: List invoice summaries properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List invoice summaries: value: ia::result: - key: '9' id: '9' href: /objects/accounts-receivable/invoice-summary/9 - key: '13' id: '13' href: /objects/accounts-receivable/invoice-summary/13 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/invoice-summary/{key}: parameters: - name: key description: System-assigned unique key for the invoice summary. in: path required: true schema: type: string get: summary: Get an invoice summary description: |+ Returns detailed information for a specified AR invoice summary.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Summaries
tags: - Invoice summaries operationId: get-accounts-receivable-invoice-summary-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the ar-invoice-summary properties: ia::result: $ref: '#/components/schemas/accounts-receivable-invoice-summary' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an invoice summary: value: ia::result: key: '13' id: '13' name: Contract Invoice April Summary glPostingDate: '2023-05-06' status: active recordType: ri totalAmount: '0' state: open parent: key: '13' id: '13' preventGLPosting: false bankAccount: key: '1' id: '1' summaryCreationType: manual isQuickPaymentSummary: false href: /objects/accounts-receivable/invoice-summary/13 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment: get: summary: List payments description: >+ Returns a collection with a key, ID, and link for each payment. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View payments
tags: - Payments operationId: list-accounts-receivable-payment responses: '200': description: OK content: application/json: schema: type: object title: List of payment objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List payments: value: ia::result: - key: '212' id: '212' href: /objects/accounts-receivable/payment/212 - key: '201' id: '201' href: /objects/accounts-receivable/payment/201 - key: '289' id: '289' href: /objects/accounts-receivable/payment/289 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a payment description: >+ Creates a new payment. To successfully create a payment, you must include either the `entityId` for a `financialEntity` or the `id` for an `undepositedGLAccount` in your request.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View, Add payments
tags: - Payments operationId: create-accounts-receivable-payment requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-payment' - $ref: '#/components/schemas/accounts-receivable-paymentRequiredProperties' examples: Create a payment: value: financialEntity: entityId: BOA paymentMethod: cash customer: id: Cust-00064 documentNumber: '1567' paymentSummary: id: '1259' receiptDate: '2023-03-23' paidDate: '2023-03-23' baseCurrency: currency: USD amountToPay: '0.06' txnCurrency: currency: USD amountToPay: '1' paymentDetails: - arInvoice: id: '2085' - arInvoiceLine: id: '4313' responses: '201': description: Created content: application/json: schema: type: object title: New payment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new payment: value: ia::result: id: '2096' key: '2096' href: /objects/accounts-receivable/payment/2096 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment/{key}: parameters: - name: key description: System-assigned unique key for the payment. in: path required: true schema: type: string get: summary: Get a payment description: |+ Returns detailed information for a specified payment.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View payments
tags: - Payments operationId: get-accounts-receivable-payment-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the payment properties: ia::result: $ref: '#/components/schemas/accounts-receivable-payment' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a payment: value: ia::result: id: '464' key: '464' paymentSummary: key: '281' id: '281' title: 'Receipts(Bank-BOA): 2022/10/10 Batch' receiptDate: '2022-10-10' name: 'Receipts(Bank-BOA): 2022/10/10 Batch' undepositedGLAccount: key: null id: null recordType: rp financialEntity: entityId: BOA entityType: ba name: Bank of America currency: USD state: null paymentMethod: cash customer: key: '8' id: C-000012 name: Power Aerospace Materials href: objects/customer/8 documentNumber: '1567' description: Regular payment for services audit: createdDateTime: '2022-10-10T00:00:00Z' modifiedDateTime: '2022-12-12T06:51:22Z' createdBy: '39' modifiedBy: '39' paidDate: '2022-11-20' baseCurrency: currency: USD totalAmount: '250' totalSelected: '0' totalPaid: '250' totalDue: '0' txnCurrency: currency: USD totalAmount: '250' totalSelected: '0' totalPaid: '250' totalDue: '0' exchangeRate: date: '2020-08-01' typeId: null rate: 1 contacts: payTo: id: Klay Vanderbilt key: '8' bankReconciliationStatus: 'false' bankReconciliationDate: null referenceNumber: null attachment: id: '123' key: '123' multiEntityPayment: key: '1077' id: PAY-00136 href: /objects/accounts-receivable/payment/1077 lines: - id: '1011' key: '1011' arPayment: key: '464' href: /objects/accounts-receivable/payment/464 glAccount: key: '36' id: '1200' name: Accounts Receivable href: /objects/general-ledger/account/36 baseCurrency: amount: '10' currency: USD totalPaid: '10' totalSelected: '0' txnCurrency: amount: '10' currency: USD totalPaid: '10' totalSelected: '0' dimensions: department: key: null id: null name: null location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 project: key: null id: null name: null customer: key: C-00013 id: C-00013 name: Power Aerospace Materials href: /objects/accounts-receivable/customer/1 vendor: key: null id: null name: null employee: key: null id: null name: null item: key: null id: null name: null class: key: null id: null name: null memo: Regular payment for services exchangeRate: date: 10/10/2022 typeId: null rate: 1 lineNumber: '1' recordType: rp offsetGLAccount: key: '9' href: /objects/general-ledger/account/9 audit: createdDateTime: '2022-12-12T06:51:21Z' modifiedDateTime: '2022-12-12T06:51:22Z' createdBy: '38' modifiedBy: '38' href: /objects/accounts-receivable/payment-line/1011 paymentDetails: - id: '127' key: '127' baseCurrency: paymentAmount: '10' inlineAmount: null postedAdvanceAmount: null postedOverPaymentAmount: null negetiveInvoiceAmount: null adjustmentAmount: null txnCurrency: inlineAmount: null postedAdvanceAmount: null postedOverPaymentAmount: null negetiveInvoiceAmount: null adjustmentAmount: null paymentAmount: '10.00' currency: USD arInvoice: id: '406' key: '406' href: /objects/accounts-receivable/invoice/406 arInvoiceLine: id: '886' key: '886' href: /objects/accounts-receivable/invoice-line/886 positiveAdjustment: key: null id: null positiveAdjustmentLine: id: null key: null inlineTxn: key: null id: null inlineTxnLine: id: null key: null postedAdvance: key: null id: null postedAdvanceLine: id: null key: null postedOverPayment: key: null id: null postedOverPaymentLine: id: null key: null arAdjustment: key: null id: null arAdjustmentLine: id: null key: null arPayment: id: '464' key: '464' href: /objects/accounts-receivable/payment/464 arPaymentLine: id: '1011' key: '1011' href: /objects/accounts-receivable/payment-line/1011" paymentDate: '2019-03-20' audit: createdDateTime: '2022-12-12T06:51:21Z' modifiedDateTime: '2022-12-12T06:51:21Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/payment-detail/127 href: /objects/accounts-receivable/payment/464 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment-line: get: summary: List payment lines description: >+ Returns a collection with a key, ID, and link for each payment line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Manage payments
tags: - Payment lines operationId: list-accounts-receivable-payment-line responses: '200': description: OK content: application/json: schema: type: object title: List of payment line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List payment lines: value: ia::result: - key: '7' id: '7' href: /objects/accounts-receivable/payment-line/7 - key: '13' id: '13' href: /objects/accounts-receivable/payment-line/13 - key: '28' id: '28' href: /objects/accounts-receivable/payment-line/28 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment-line/{key}: parameters: - name: key description: System-assigned key for the payment line. in: path required: true schema: type: string get: summary: Get a payment line description: >+ Returns detailed information for a specified payment line.
Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Manage payments
tags: - Payment lines operationId: get-accounts-receivable-payment-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the payment line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-payment-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a payment line: value: ia::result: id: '1369' key: '1369' arPayment: key: '121' id: '121' href: /objects/accounts-receivable/payment/121 glAccount: key: '263' id: '1103' name: Accounts Receivable - Microcomputer href: /objects/general-ledger/account/263 dimensions: department: key: '1' id: '01' name: Sales href: /objects/company-config/department/1 location: key: '2' id: TX name: Texas href: /objects/company-config/location/2 customer: key: '13' id: C-00019 name: sForce href: /objects/accounts-receivable/customer/13 vendor: key: '512' id: V-00008 name: SF Seals href: /objects/accounts-payable/vendor/512 item: key: '6' id: LIC02-06 name: License 6 month contract href: /objects/inventory-control/item/6 memo: null, exchangeRate: date: '2022-04-15' typeId: '-1' rate: 1 baseCurrency: amount: '100' currency: USD totalPaid: '0' totalSelected: '100' txnCurrency: amount: '100' currency: USD totalPaid: '0' totalSelected: '100' lineNumber: 1 offsetGLAccount: key: '9' href: /objects/general-ledger/account/9 audit: createdDateTime: '2022-04-21T12:34:02Z' modifiedDateTime: '2022-07-04T08:18:29Z' createdBy: '39' modifiedBy": '39' href: /objects/accounts-receivable/payment-line/1369 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment-detail: get: summary: List payment details description: >- Returns a collection with a key, ID, and link for each payment detail object. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Payment details operationId: list-accounts-receivable-payment-detail responses: '200': description: OK content: application/json: schema: type: object title: List payment detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List payment details: value: ia::result: - key: '117' id: '117' href: /objects/accounts-receivable/payment-detail/117 - key: '118' id: '118' href: /objects/accounts-receivable/payment-detail/118 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment-detail/{key}: parameters: - name: key description: System-assigned key for the payment details. in: path required: true schema: type: string get: summary: Get payment details description: Returns detailed information for a specified payment details object. tags: - Payment details operationId: get-accounts-receivable-payment-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the payment detail properties: ia::result: $ref: '#/components/schemas/accounts-receivable-payment-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get payment details: value: ia::result: id: '117' key: '117' arInvoice: id: '426' key: '426' href: /objects/accounts-receivable/invoice/426 arInvoiceLine: id: '929' key: '929' href: /objects/accounts-receivable/invoice-line/929 positiveAdjustment: key: null id: null positiveAdjustmentLine: id: null key: null inlineTxn: key: '428' id: '428' href: /objects/accounts-receivable/invoice/428 inlineTxnLine: id: '933' key: '933' href: /objects/accounts-receivable/invoice-line/933 postedAdvance: key: null id: null postedAdvanceLine: id: null key: null postedOverPayment: key: null id: null postedOverPaymentLine: id: null key: null arAdjustment: key: null id: null arAdjustmentLine: id: null key: null arPayment: id: '433' key: '433' href: /objects/accounts-receivable/payment/433 arPaymentLine: id: '1011' key: '1011' href: /objects/accounts-receivable/payment-line/1011 paymentDate: '2022-11-25' baseCurrency: paymentAmount: '50' inlineAmount: '10' postedAdvanceAmount: null postedOverPaymentAmount: null negativeInvoiceAmount: null adjustmentAmount: null txnCurrency: inlineAmount: '10.10' postedAdvanceAmount: null postedOverPaymentAmount: null negativeInvoiceAmount: null adjustmentAmount: null paymentAmount: '50.00' currency: USD audit: createdDateTime: '2022-11-25T07:09:13Z' modifiedDateTime: '2022-11-25T07:09:13Z' createdBy: '39' modifiedBy: '39' href: /objects/accounts-receivable/payment-detail/117 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment-summary: get: summary: List payment summaries description: Returns a collection with a key, ID, and link for each payment summary. tags: - Payment summaries operationId: list-accounts-receivable-payment-summary responses: '200': description: OK content: application/json: schema: type: object title: List of ar-payment-summary objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of payment summaries: value: ia::result: - key: '4' id: '4' href: /objects/accounts-receivable/payment-summary/4 - key: '5' id: '5' href: /objects/accounts-receivable/payment-summary/5 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/payment-summary/{key}: parameters: - name: key description: System-assigned unique key for the payment summary. in: path required: true schema: type: string get: summary: Get a payment summary description: Returns detailed information for a particular payment summary. tags: - Payment summaries operationId: get-accounts-receivable-payment-summary-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the ar-payment-summary properties: ia::result: $ref: '#/components/schemas/accounts-receivable-payment-summary' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the payment summary: value: ia::result: key: '5' id: '5' name: 'Reversed Receipts(Bank-BOA): 2023/04/12 Batch' glPostingDate: '2023-04-12' status: active recordType: rp totalAmount: '200' state: open parent: key: '13' id: '13' preventGLPosting: false bankAccount: key: '1' id: BOA summaryCreationType: manual isQuickPaymentSummary: false href: /objects/accounts-receivable/payment-summary/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/summary: get: summary: List summaries description: >- Returns a collection with a key, ID, and link for each AR summary. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - 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: batch2 glPostingDate: '2023-05-10' status: active recordType: ri state: open preventGLPosting: false isQuickPaymentSummary: false responses: '201': description: Created content: application/json: schema: type: object title: New ar-summary properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New summary: value: ia::result: key: '14' id: '14' href: /objects/accounts-receivable/summary/14 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/summary/{key}: parameters: - name: key description: System-assigned key for the summary. in: path required: true schema: type: string get: summary: Get a summary description: Returns detailed information for a specified AR summary. tags: - Summaries operationId: get-accounts-receivable-summary-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the ar-summary properties: ia::result: $ref: '#/components/schemas/accounts-receivable-summary' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a summary: value: ia::result: key: '14' id: '14' name: batch5 glPostingDate: '2023-05-10' status: active recordType: ra totalAmount: '100' state: open parent: id: '11' key: '11' preventGLPosting: false bankAccount: id: '13' key: '13' summaryCreationType: manual isQuickPaymentSummary: false href: /objects/accounts-receivable/summary/14 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a summary description: >- Updates an existing AR summary by setting field values. Any fields not provided remain unchanged. tags: - Summaries operationId: update-accounts-receivable-summary-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-summary' - type: object properties: id: readOnly: true examples: Update a summary: value: name: batch4 glPostingDate: '2023-05-10' status: active recordType: ra state: open preventGLPosting: false isQuickPaymentSummary: false responses: '200': description: OK content: application/json: schema: type: object title: Updated ar-summary properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated summary: value: ia::result: key: '14' id: '14' href: /objects/accounts-receivable/summary/14 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a summary description: Deletes an AR summary. tags: - Summaries operationId: delete-accounts-receivable-summary-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/territory: get: summary: List territories description: >+ Returns up to 100 object references from the collection with a key, ID, and link for each territory. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsList, View Territories
tags: - Territories operationId: list-accounts-receivable-territory responses: '200': description: OK content: application/json: schema: type: object title: List of territory objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List territories: value: ia::result: - key: '10' id: PNW href: /objects/accounts-receivable/territory/10 - key: '11' id: SW href: /objects/accounts-receivable/territory/11 - key: '12' id: ESB href: /objects/accounts-receivable/territory/12 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a territory description: >+ Creates a new territory.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsList, View, Add Territories
tags: - Territories operationId: create-accounts-receivable-territory requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-territory' examples: Create a territory: value: id: T-12 name: Territory India parent: id: '12755' manager: id: Raser status: active responses: '201': description: Created content: application/json: schema: type: object title: New territory properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New Territory: value: ia::result: key: '19' id: T-12 href: /objects/accounts-receivable/territory/19 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/territory/{key}: parameters: - schema: type: string example: '81' name: key in: path required: true description: System-assigned key for the territory. get: summary: Get a territory description: |+ Returns detailed information for a specified territory.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsList, View Territories
tags: - Territories responses: '200': description: OK content: application/json: schema: type: object title: Details of the territory properties: ia::result: $ref: '#/components/schemas/accounts-receivable-territory' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a territory: value: ia::result: key: '17' id: TT-SW name: Southwest parent: id: TT-US key: '14' href: /objects/accounts-receivable/territory/14 manager: key: '5' id: dwilson href: /objects/company-config/employee/5 status: active href: /objects/accounts-receivable/territory/17 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' operationId: get-accounts-receivable-territory-key security: - OAuth2: [] patch: summary: Update a territory description: >+ Updates an existing territory by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsList, View, Edit Territories
tags: - Territories operationId: update-accounts-receivable-territory-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-territory' - type: object properties: id: readOnly: true examples: Update a single value: value: name: Southwest United States responses: '200': description: OK content: application/json: schema: type: object title: Updated territory properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a single value: value: ia::result: key: '17' id: TT-SW href: /objects/accounts-receivable/territory/17 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a territory description: >+ Deletes a territory. A territory can be deleted if it hasn't been associated with a customer, transaction, or other record.
Permissions and other requirements
SubscriptionCompany
User ypeBusiness
PermissionsList, View, Delete Territories
tags: - Territories operationId: delete-accounts-receivable-territory-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/territory-group: get: summary: List territory groups description: Returns a collection with a key, ID, and link for each territory group. tags: - Territory groups operationId: list-accounts-receivable-territory-group responses: '200': description: OK content: application/json: schema: type: object title: List of territory-group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List territory groups: value: ia::result: - key: '8' id: TG-1 href: /objects/accounts-receivable/territory-group/8 - key: '9' id: TG-2 href: /objects/accounts-receivable/territory-group/9 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a territory group description: Creates a new territory group. tags: - Territory groups operationId: create-accounts-receivable-territory-group requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-territory-group' - $ref: '#/components/schemas/accounts-receivable-territory-groupRequiredProperties' examples: Create a territory group: value: id: TG-1 name: Territory Group NG-1 description: Territory group NG-1 members: - territory: id": TT-NG2 - territory: id: TT-NG1 responses: '201': description: Created content: application/json: schema: type: object title: New territory-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New territory group: value: ia::result: key: '8' id: TG-1 href: /objects/accounts-receivable/territory-group/8 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/territory-group/{key}: parameters: - name: key description: System-assigned unique key for the territory group. in: path required: true schema: type: string get: summary: Get a territory group description: Returns detailed information for a specified territory group. tags: - Territory groups operationId: get-accounts-receivable-territory-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the territory-group properties: ia::result: $ref: '#/components/schemas/accounts-receivable-territory-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a territory group: value: ia::result: key: '9' id: TG-2 name: Territory Group NG-3 Updated description: This description is updated via Nextgen API audit: createdDateTime: '2023-09-18T10:53:14Z' modifiedDateTime: '2023-09-18T15:53:36Z' createdBy: '1' modifiedBy: '1' members: - id: '30' key: '30' territoryGroup: key: '9' id: TG-2 href: /objects/accounts-receivable/territory-group/9 territory: key: '11' id: '6345' name: South Central href: /objects/accounts-receivable/territory/11 sortOrder: '0' audit: createdDateTime: '2023-09-18T15:53:36Z' modifiedDateTime: '2023-09-18T15:53:36Z' createdBy: '1' modifiedBy: '1' href: '/objects/accounts-receivable/territory-group-member/30' href: /objects/accounts-receivable/territory-group/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a territory group description: >- Updates an existing territory group by setting field values. Any fields not provided remain unchanged. tags: - Territory groups operationId: update-accounts-receivable-territory-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-territory-group' - type: object properties: id: readOnly: true examples: Update a territory group: value: name: Territory Group NG-3 Updated description: This description is updated via Nextgen API members: - ia::operation: delete id: '23' - ia::operation": delete id: '24' - territory: id: '6345' responses: '200': description: OK content: application/json: schema: type: object title: Updated territory-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated territory group: value: ia::result: key: '9' id: TG-2 href: /objects/accounts-receivable/territory-group/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a territory group description: Deletes a territory group. tags: - Territory groups operationId: delete-accounts-receivable-territory-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/territory-group-member: get: summary: List territory group members description: >- Returns a collection with a key, ID, and link for each territory group member. tags: - Territory group members operationId: list-accounts-receivable-territory-group-member responses: '200': description: OK content: application/json: schema: type: object title: List of territory-group-member objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List territory group members: value: ia::result: - key: '20' id: '20' href: /objects/accounts-receivable/territory-group-member/20 - key: '25' id: '25' href: /objects/accounts-receivable/territory-group-member/25 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/territory-group-member/{key}: parameters: - name: key description: System-assigned unique key for the territory group member. in: path required: true schema: type: string get: summary: Get a territory group member description: Returns detailed information for a specified territory group member. tags: - Territory group members operationId: get-accounts-receivable-territory-group-member-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the territory-group-member properties: ia::result: $ref: '#/components/schemas/accounts-receivable-territory-group-member' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a territory group member: value: ia::result: id: '2' key: '2' territoryGroup: key: '1' id: TG-1 href: /objects/accounts-receivable/territory-group/1 territory: key: '8' id: T-8 name: Central href: /objects/accounts-receivable/territory/8 sortOrder: '1' audit: createdDateTime: '2016-05-02T21:49:11Z' modifiedDateTime: '2016-05-02T21:49:11Z' createdBy: '1' modifiedBy: '1' href: /objects/accounts-receivable/territory-group-member/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/customer-item-cross-reference: get: summary: List customer item cross references description: >- Returns a collection with a key, ID, and link for each customer item cross reference. tags: - 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 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-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-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: New customer account group: value: ia::result: key: '18' id: 1099 Customer Group href: /objects/accounts-receivable/customer-account-group/18 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' description: Creates a new customer account group. requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-customer-account-group' - $ref: '#/components/schemas/customerAccountGroupRequiredProperties' examples: Create a customer account group: value: id: 1099 Customer Group groupType: customer status: active security: - OAuth2: [] /objects/accounts-receivable/customer-account-group/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned unique key for the customer account group. get: summary: Get a customer account group tags: - 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: 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/recurring-invoice: get: summary: List recurring invoices description: >- Returns a collection with a key, ID, and link for each recurring invoice. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Recurring invoices operationId: list-accounts-receivable-recurring-invoice responses: '200': description: OK content: application/json: schema: type: object title: List of recurring invoice objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List recurring invoices: value: ia::result: - key: '3' id: '3' href: /objects/accounts-receivable/recurring-invoice/3 - key: '4' id: '4' href: /objects/accounts-receivable/recurring-invoice/4 - key: '7' id: '7' href: /objects/accounts-receivable/recurring-invoice/7 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a recurring invoice description: Creates a new recurring invoice. tags: - Recurring invoices operationId: create-accounts-receivable-recurring-invoice requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-recurring-invoice' - $ref: '#/components/schemas/accounts-receivable-recurring-invoiceRequiredProperties' examples: Create a recurring invoice: value: description: Reccurring invoice 1 term: key: '25' invoiceNumber: Invoice referenceNumber: ARRecur2 status: active customer: key: '1' contacts: shipTo: id: Abhilash currency: txnCurrency: USD baseCurrency: USD payment: paymentMethod: cash payInFull: true accountType: bank bankAccountID: BOA schedule: startDate: '2024-03-11' repeatCount: '2' repeatBy: day repeatInterval: '1' lines: - description: line 1 glAccount: key: '194' amount: '100.00' txnAmount: '100.00' responses: '201': description: Created content: application/json: schema: type: object title: New recurring invoice properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New recurring invoice: value: ia::result: id: '4' key: '4' href: /objects/accounts-receivable/recurring-invoice/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/recurring-invoice/{key}: parameters: - name: key description: System-assigned key for the recurring invoice. in: path required: true schema: type: string get: summary: Get an recurring invoice description: Returns detailed information for a specified recurring invoice. tags: - Recurring invoices operationId: get-accounts-receivable-recurring-invoice-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the recurring invoice properties: ia::result: $ref: '#/components/schemas/accounts-receivable-recurring-invoice' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a recurring invoice: value: ia::result: id: '3' key: '3' description: null audit: createdDateTime: '2021-08-24T00:00:00Z' modifiedDateTime: '2021-08-24T10:52:33Z' createdBy: '1' modifiedBy: '1' term: key: '25' id: 15DaysAfterEOM href: /objects/accounts-receivable/term/25 invoiceNumber: Invoice totalEntered: '100.00' referenceNumber: ARRecur1 status: active customer: name: Power Aerospace Materials key: '1' id: '1' href: /objects/accounts-receivable/customer/1 contract: id: contract 1 description: first contract contacts: shipTo: id: Abhilash currency: txnCurrency: USD baseCurrency: USD txnTotalEntered: '100.00' customerMessage: message 1 payment: paymentMethod: cash payInFull: true paymentAmount: '100.00' customerCreditCard: key: null creditCardType: null accountType: null bankAccountID: null undepositFundsAccountId: null schedule: startDate: '2021-08-22' endDate: null nextExecutionDate: '2021-08-25' lastExecutionDate: '2021-08-24' repeatCount: null repeatBy: day repeatInterval: '1' attachment: key: '5' id: Attach1 lines: - recurringInvoice: id: '3' key: '3' offsetGLAccount: key: '10' description: Line 1 glAccount: key: '194' id: '4000' name: Sales amount: '100.00' lineNumber: 0 accountLabel: id: Accounting Fees currency: txnCurrency: USD baseCurrency: USD exchangeRateDate: '2021-08-24' exchangeRateTypeId: Intacct Daily Rate exchangeRate: 1 txnAmount: '100.00' allocation: key: '2' id: Alloc50-50 isBillable: false audit: createdDateTime: '2021-08-24T10:52:33Z' modifiedDateTime: '2021-08-24T10:52:33Z' createdBy: '1' modifiedBy: '1' isSubTotal: false href: /objects/accounts-receivable/recurring-invoice/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a recurring invoice description: >- Updates an existing recurring invoice by setting field values. Any fields not provided remain unchanged. tags: - Recurring invoices operationId: update-accounts-receivable-recurring-invoice-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/accounts-receivable-recurring-invoice' - type: object properties: id: readOnly: true examples: Update a recurring invoice: value: description: updated description status: active responses: '200': description: OK content: application/json: schema: type: object title: Updated recurring invoice properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated recurring invoice: value: ia::result: id: '4' key: '4' href: /objects/accounts-receivable/recurring-invoice/4 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a recurring invoice description: Deletes a recurring invoice. tags: - Recurring invoices operationId: delete-accounts-receivable-recurring-invoice-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/recurring-invoice-line: get: summary: List recurring invoice lines description: >- Returns a collection with a key, ID, and link for each recurring invoice line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Recurring invoice lines operationId: list-accounts-receivable-recurring-invoice-line responses: '200': description: OK content: application/json: schema: type: object title: List of recurring invoice line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List recurring invoice lines: value: ia::result: - key: '9' id: '9' href: /objects/accounts-receivable/recurring-invoice-line/9 - key: '10' id: '10' href: /objects/accounts-receivable/recurring-invoice-line/10 - key: '13' id: '13' href: /objects/accounts-receivable/recurring-invoice-line/13 - key: '14' id: '14' href: /objects/accounts-receivable/recurring-invoice-line/14 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/recurring-invoice-line/{key}: parameters: - name: key description: System-assigned key for the recurring invoice line. in: path required: true schema: type: string get: summary: Get a recurring invoice line description: >- Returns detailed information for a specified line item in a recurring invoice. tags: - Recurring invoice lines operationId: get-accounts-receivable-recurring-invoice-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the recurring-invoice-line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-recurring-invoice-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a recurring invoice line: value: ia::result: id: '9' key: '9' recurringInvoice: id: '2' key: '2' href: /objects/accounts-receivable/recurring-invoice/2 description: Line 1 glAccount: key: '194' id: '4000' name: Sales href: /objects/general-ledger/account/194 amount: '50.00' dimensions: location: key: '19' id: '1' name: United States of America href: /objects/company-config/location/19 department: key: '1' id: '11' name: Accounting href: objects/company-config/department/1 customer: key: '11' id: '1' name: Power Aerospace Materials href: /objects/company-config/customer/11 lineNumber: 0 accountLabel: id: Accounting Fees currency: txnCurrency: USD baseCurrency: USD exchangeRateDate: '2021-08-24' exchangeRateTypeId: Intacct Daily Rate exchangeRate: 1 txnAmount: '50.00' allocation: key: '2' id: Alloc50-50 href: /objects/general-ledger/txn-allocation-template/2 isBillable: false audit: createdDateTime: '2021-08-24T10:24:19Z' modifiedDateTime: '2021-08-24T10:24:19Z' createdBy: '1' modifiedBy: '1' isTax: false isSubTotal: false href: /objects/accounts-receivable/recurring-invoice-line/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/posted-over-payment: get: summary: List posted overpayments description: >- Returns a collection with a key, ID, and link for each posted overpayment. tags: - Posted overpayments operationId: list-accounts-receivable-posted-over-payment responses: '200': description: OK content: application/json: schema: type: object title: List of ar-posted-over-payment objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List posted overpayments: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/posted-over-payment/{key}: parameters: - name: key description: System-assigned unique key for the posted overpayment. in: path required: true schema: type: string get: summary: Get a posted overpayment description: Returns detailed information for a specified posted overpayment. tags: - Posted overpayments operationId: get-accounts-receivable-posted-over-payment-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the ar-posted-over-payment properties: ia::result: $ref: '#/components/schemas/accounts-receivable-posted-over-payment' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a posted overpayment: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/posted-over-payment-line: get: summary: List posted overpayment lines description: >- Returns a collection with a key, ID, and link for each posted overpayment line. tags: - Posted overpayment lines operationId: list-accounts-receivable-posted-over-payment-line responses: '200': description: OK content: application/json: schema: type: object title: List of ar-posted-over-payment-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List posted overpayment lines: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/posted-over-payment-line/{key}: parameters: - name: key description: System-assigned unique key for the posted overpayment line. in: path required: true schema: type: string get: summary: Get a posted overpayment line description: Returns detailed information for a specified posted overpayment line. tags: - Posted overpayment lines operationId: get-accounts-receivable-posted-over-payment-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the posted overpayment line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-posted-over-payment-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an overpayment line: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/revenue-recognition-template/{key}: parameters: - schema: type: string name: key in: path required: true example: '1' description: System-assigned key for the revenue recognition template. get: summary: Get a revenue recognition template description: >- Returns detailed information for a specified revenue recognition template. tags: - Revenue recognition templates responses: '200': description: OK content: application/json: schema: type: object title: Details of the revenue recognition template properties: ia::result: $ref: '#/components/schemas/accounts-receivable-revenue-recognition-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a revenue recognition template: value: ia::result: key: '1' id: '1001' href: '/objects/accounts-receivable/revenue-recognition-template/1' status: active audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' operationId: get-accounts-receivable-revenue-recognition-template-key security: - OAuth2: [] /objects/accounts-receivable/revenue-recognition-template: get: summary: List revenue recognition templates description: >- Returns a collection with a key, ID, and link for each revenue recognition template. This operation is mostly for use in testing. Use query to fnd objects that meet certain criteria and to specify properties that are returned. tags: - Revenue recognition templates responses: '200': description: OK content: application/json: schema: type: object title: List of revenue-recognition-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List revenue recognition templates: value: ia::result: - key: '1' id: '1001' href: '/objects/accounts-receivable/revenue-recognition-template/1' - key: '2' id: '1001.01' href: '/objects/accounts-receivable/revenue-recognition-template/2' ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' operationId: list-accounts-receivable-revenue-recognition-template security: - OAuth2: [] /objects/accounts-receivable/revenue-recognition-template-line: get: summary: List revenue recognition template lines description: >- Returns a collection with a key, ID, and link for each revenue recognition template line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Revenue recognition template lines operationId: list-accounts-receivable-revenue-recognition-template-line responses: '200': description: OK content: application/json: schema: type: object title: List of revenue-recognition-template-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List revenue recognition template lines: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/REVRECTEMPLENTRY/{key}: parameters: - name: key description: System-assigned key for the revenue recognition template line. in: path required: true schema: type: string get: summary: Get a revenue recognition template line description: >- Returns detailed information for a specified revenue recognition template line. tags: - Revenue recognition template lines operationId: get-accounts-receivable-revenue-recognition-template-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the revenue-recognition-template-line properties: ia::result: $ref: '#/components/schemas/accounts-receivable-revenue-recognition-template-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a revenue recognition template line: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/revenue-recognition-template-milestone: get: summary: List revenue recognition template milestones description: >- Returns a collection with a key, ID, and link for each revenue recognition template milestone. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Revenue recognition template milestones operationId: list-accounts-receivable-revenue-recognition-template-milestone responses: '200': description: OK content: application/json: schema: type: object title: List of revenue-recognition-template-milestone objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List revenue recognition template milestones: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/accounts-receivable/revenue-recognition-template-milestone/{key}: parameters: - name: key description: System-assigned key for the revenue recognition template milestone. in: path required: true schema: type: string get: summary: Get a revenue recognition template milestone description: >- Returns detailed information for a specified revenue recognition template milestone. tags: - Revenue recognition template milestones operationId: get-accounts-receivable-revenue-recognition-template-milestone-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the revenue-recognition-template-milestone properties: ia::result: $ref: '#/components/schemas/accounts-receivable-revenue-recognition-template-milestone' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a revenue recognition template milestone: {} '400': $ref: '#/components/responses/400error' security: - OAuth2: [] components: schemas: accounts-receivable-invoiceRequiredProperties: type: object properties: customer: required: - id example: '1' lines: type: array items: type: object properties: glAccount: required: - id example: '4010' dimensions: properties: location: required: - id example: '1' required: - txnAmount example: '100' required: - invoiceDate - dueDate object-reference: type: object description: Reference to created or updated object properties: key: type: string example: '12345' id: type: string example: ID123 href: type: string readOnly: true example: /objects///12345 metadata-pages: description: Metadata for collection response type: object properties: totalCount: type: integer description: Total count readOnly: true example: 3 start: type: integer description: Start element number readOnly: true example: 1 pageSize: type: integer description: Page size readOnly: true example: 100 next: type: integer description: Next element number readOnly: true nullable: true example: 101 previous: type: integer description: Previous element number readOnly: true nullable: true example: null error-response: type: object description: Error response properties: ia::result: type: object properties: ia::error: type: object properties: code: type: string example: invalidRequest message: type: string example: Payload contains errors supportId: type: string example: sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ errorId: type: string example: REST-1064 additionalInfo: type: object properties: messageId: type: string example: IA.PAYLOAD_CONTAINS_ERRORS placeholders: type: string propertySet: type: string details: type: array items: type: object properties: code: type: string example: invalidRequest message: type: string example: /testDate is not a valid field errorId: type: string example: REST-1043 target: type: string example: /testDate additionalInfo: type: object properties: messageId: type: string example: IA.NOT_A_VALID_FIELD placeholders: type: string example: FIELD: /testDate propertySet: type: string ia::meta: $ref: '#/components/schemas/metadata' location-ref: type: object properties: key: type: string description: Location Key example: '1' id: type: string description: Location example: US name: type: string description: Location Name readOnly: true example: United States of America href: type: string example: /objects/company-config/location/1 readOnly: true dimension-ref: type: object properties: location: type: object properties: key: type: string description: Location key example: '22' nullable: true id: type: string description: Location example: LOC-22 nullable: true name: type: string description: Location name readOnly: true example: California nullable: true href: type: string readOnly: true example: /objects/company-config/location/22 department: type: object properties: key: type: string description: Department key example: '11' nullable: true id: type: string description: Department example: DEP-11 nullable: true name: type: string description: Department name readOnly: true example: Sales and Marketing nullable: true href: type: string readOnly: true example: /objects/company-config/department/11 employee: type: object properties: key: type: string description: Employee key example: '10' nullable: true id: type: string description: Employee ID example: EMP-10 nullable: true name: type: string description: Employee name readOnly: true example: Thomas, Glenn nullable: true href: type: string example: /objects/company-config/employee/10 readOnly: true project: type: object properties: key: type: string description: Project key example: '2' nullable: true id: type: string description: Project ID example: NET-XML30-2 nullable: true name: type: string description: Project name readOnly: true example: Talcomp training nullable: true href: type: string readOnly: true example: /objects/projects/project/2 customer: type: object properties: key: type: string description: Customer key example: '13' nullable: true id: type: string description: Customer ID example: CUST-13 nullable: true name: type: string description: Customer name readOnly: true example: Jack In the Box nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/customer/13 vendor: type: object properties: key: type: string description: Vendor key example: '357' nullable: true id: type: string description: Vendor ID example: '1605212096809' nullable: true name: type: string description: Vendor name readOnly: true example: GenLab nullable: true href: type: string readOnly: true example: /objects/accounts-payable/vendor/357 item: type: object properties: key: type: string description: Item key example: '13' nullable: true id: type: string description: Item ID example: Case 13 nullable: true name: type: string description: Item name readOnly: true example: Platform pack nullable: true href: type: string readOnly: true example: /objects/inventory-control/item/13 warehouse: type: object properties: key: type: string description: Warehouse key example: '6' nullable: true id: type: string description: Warehouse ID example: WH01 nullable: true name: type: string description: Warehouse name readOnly: true example: WH01 nullable: true href: type: string readOnly: true example: /objects/inventory-control/warehouse/6 class: type: object properties: key: type: string description: Class key example: '731' nullable: true id: type: string description: Class ID example: REST_CLS_001 nullable: true name: type: string description: Class name readOnly: true example: Enterprises nullable: true href: type: string readOnly: true example: /objects/company-config/class/731 task: type: object properties: id: type: string description: Task ID example: '1' nullable: true key: type: string description: Task key example: '1' nullable: true name: type: string description: Task name readOnly: true example: Project Task nullable: true href: type: string readOnly: true example: /objects/projects/task/1 costType: type: object properties: id: type: string description: Cost Type ID example: '2' nullable: true key: type: string description: Cost Type key example: '2' nullable: true name: type: string description: Cost Type name readOnly: true example: Project Expense nullable: true href: type: string readOnly: true example: /objects/construction/cost-type/2 asset: type: object properties: id: type: string description: Asset ID example: A001 nullable: true key: type: string description: Asset key example: '1' nullable: true name: type: string description: Asset name readOnly: true example: Laptop 1 nullable: true href: type: string readOnly: true example: /objects/fixed-assets/asset/1 contract: type: object properties: id: type: string description: Contract ID example: CON-0045-1 nullable: true key: type: string description: Contract key example: '12' nullable: true name: type: string description: Contract name readOnly: true example: ACME Widgets - Service nullable: true href: type: string readOnly: true example: /objects/contracts/contract/12 audit: type: object properties: createdDateTime: description: Time of the submission type: string format: date-time example: '2022-04-20T16:20:00Z' readOnly: true modifiedDateTime: description: Time of the modification type: string format: date-time example: '2022-04-20T16:20:00Z' readOnly: true createdBy: description: User who created this type: string example: '1' readOnly: true nullable: true modifiedBy: description: User who modified this type: string example: '95' readOnly: true nullable: true readOnly: true accounts-receivable-invoice-line: type: object description: >- Line items in an AR invoice represent transactions captured in that invoice. properties: key: type: string description: System-assigned key for the AR invoice line item. readOnly: true example: '103' id: type: string description: Identifier for the AR invoice line item. readOnly: true example: '103' glAccount: type: object description: General Ledger (GL) account associated with the line item. properties: key: type: string description: System-assigned key for the GL account. example: '163' id: type: string description: User-assigned number for the GL account. example: '4010' name: type: string description: Name of the GL account. readOnly: true example: Sales Revenue Licensing href: type: string readOnly: true example: /objects/general-ledger/account/163 overrideOffsetGLAccount: type: object description: >- An alternative AR account to override the default GL AR account for the invoice line item. properties: key: type: string description: System-assigned key for the GL account. example: '263' id: type: string description: GL account number. example: '1103' name: type: string description: GL account name. readOnly: true example: Accounts Receivable - Microcomputer href: type: string description: URL for the GL account. readOnly: true example: /objects/general-ledger/account/263 baseAmount: type: string format: decimal-precision-2 description: >- For multi-currency companies, Sage Intacct calculates the base amount by applying the exchange rate from the header to the transaction amount. readOnly: true example: '24115.65' txnAmount: type: string description: Amount for the AR invoice line item in the transaction currency. format: decimal-precision-2 example: '16740.00' memo: type: string description: Memo or notes about the AR invoice line item. example: Replaces discontinued part currency: type: object description: Currency details for multi-currency companies. readOnly: true properties: baseCurrency: type: string description: Base currency for the invoice line item. readOnly: true example: USD txnCurrency: type: string description: Transaction currency for the invoice line item. readOnly: true example: EUR exchangeRate: type: object title: exchangeRate description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' paymentInformation: type: object description: Payment information for the line item. readOnly: true properties: totalBaseAmountPaid: type: string format: decimal-precision-2 description: Total base amount that was paid. readOnly: true example: '100.00' totalTxnAmountPaid: type: string format: decimal-precision-2 description: Total transaction amount that was paid. readOnly: true example: '100.00' totalBaseAmountSelectedForPayment: type: string format: decimal-precision-2 description: Total base amount selected for the payment. readOnly: true example: '100.00' totalTxnAmountSelectedForPayment: type: string format: decimal-precision-2 description: Total transaction amount selected for the payment. readOnly: true example: '100.00' allocation: type: object description: >- Transaction allocation template for the line item, which distributes the invoice amount across specified dimensions. properties: key: type: string description: System-assigned key for the allocation. example: '22' nullable: true id: type: string description: System-assigned ID for the allocation. example: Premium Allocation nullable: true lineNumber: type: number description: Line number readOnly: true example: 1 isSubtotal: type: string description: | Indicates if the line item is a subtotal, tax item, or neither. enum: - null - subtotal - tax readOnly: true example: subtotal nullable: true default: null baseLocation: type: object readOnly: true allOf: - $ref: '#/components/schemas/location-ref' - type: object properties: key: type: string description: Base location key. example: '4' createdDate: type: string format: date example: '2021-01-23' description: Entry date for the line item. readOnly: true accountLabel: type: object description: Meaningful name of AR account. properties: key: type: string description: System-assigned key for the account label. example: '14' id: type: string description: Meaningful name of the account. example: Accounts Receivable - Microcomputer name: type: string description: Name of the account label. readOnly: true example: Sales Midwest href: type: string description: URL for the account label. readOnly: true example: /objects/accounts-receivable/account-label/14 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of locations to reflect how your company is organized. title: location properties: key: type: string description: System-assigned key for the location. example: '4' id: type: string description: Unique identifier of the location. example: AU name: type: string description: Name of the location. readOnly: true example: Australia href: type: string readOnly: true example: /objects/company-config/location/4 department: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string description: System-assigned key for the department. example: '9' id: type: string description: Unique identifier of the department. example: '01' name: type: string description: Name of the department. readOnly: true example: Sales href: type: string readOnly: true example: /objects/company-config/department/9 invoice: description: Header level details for the AR invoice's line items. type: object readOnly: true properties: id: type: string description: Identifier for the AR invoice. readOnly: true example: '6' key: type: string description: System-assigned key for the AR invoice. readOnly: true example: '6' href: type: string description: URL for the AR invoice. readOnly: true example: /objects/accounts-receivable/invoice/6 audit: $ref: '#/components/schemas/audit' entity-ref: type: object properties: key: type: string description: System-assigned key for the objects Entity Location. readOnly: true nullable: true example: '46' id: type: string description: User-assigned ID for the objects Entity Location readOnly: true nullable: true example: CORP name: type: string description: User-assigned NAME for the objects Entity Location readOnly: true nullable: true example: Corp href: type: string readOnly: true example: /objects/company-config/entity/46 readOnly: true accounts-receivable-invoice: type: object description: >- An AR invoice object represents an invoice sent to a customer for goods or services provided. properties: key: type: string description: System-assigned key for the AR invoice. readOnly: true example: '11' id: type: string description: Unique identifier for the AR invoice. readOnly: true example: '11' recordType: type: string description: The record type for the invoice. readOnly: true example: ri moduleKey: type: string description: Key of the module from which the invoice was created. enum: - accountsReceivable - orderEntry example: accountsReceivable readOnly: true invoiceNumber: type: string description: >- Specify a unique invoice number while creating an invoice unless document sequencing is configured, in which case the number is auto-generated. example: INV-001 state: type: string description: > A invoices's state shows the current status of the invoice within the workflow. enum: - reversed - reversal - draft - noValue - posted - paid - partiallyPaid - selected example: posted readOnly: true dueInDays: type: integer description: Number of days until the invoice is due. readOnly: true example: 108 referenceNumber: type: string description: Customer purchase order number or another reference number. example: PO6917 description: type: string description: >- Description of the invoice, which prints on the Customer Ledger report. example: Regular invoice documentId: type: string description: ID of the associated document. example: Sales Invoice-SI-00188 discountCutOffDate: type: string format: date example: '2022-12-13' description: Date of the discount. readOnly: true invoiceDate: type: string format: date description: Date the invoice was created. example: '2022-12-06' dueDate: type: string format: date example: '2022-12-31' description: Date the invoice is due. currency: type: object description: Currency details for this invoice. properties: baseCurrency: type: string description: Base currency for the invoice. example: USD txnCurrency: type: string description: >- The transaction currency to use for this invoice. If this currency is different from the base currency, provide an exchange rate. example: USD exchangeRate: type: object description: Exchange rate details used to calculate the base amount. title: exchangeRate properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: Intacct Daily Rate totalBaseAmount: type: string format: decimal-precision-2 description: >- For multi-currency companies, total entered in the base currency of the company. readOnly: true example: '700000' totalBaseAmountDue: type: string format: decimal-precision-2 description: >- For multi-currency companies, total due in the base currency of the company. readOnly: true example: '700000' totalTxnAmount: type: string format: decimal-precision-2 description: Total transaction amount in the currency of the invoice. readOnly: true example: '700000' totalTxnAmountDue: type: string format: decimal-precision-2 description: Total transaction amount due in the currency of the invoice. readOnly: true example: '700000' dunningCount: type: integer description: Number of associated dunning notices. readOnly: true example: 1 customerMessageId: type: string example: Greeting01 customerMessage: type: string description: Information to communicate to the customer via the invoice. readOnly: true example: Thank you for your business. recurringSchedule: type: object description: Recurring schedule used to automate the billing process. readOnly: true properties: key: type: string description: System-assigned key to uniquely identify the recurring schedule. readOnly: true example: '20' paymentInformation: type: object description: Payment information for the invoice. readOnly: true properties: fullyPaidDate: type: string format: date example: '2021-01-23' description: Date the invoice was paid. readOnly: true nullable: true totalBaseAmountPaid: type: string format: decimal-precision-2 description: Total paid in the company's base currency. readOnly: true example: '500' totalBaseAmountSelectedForPayment: type: string format: decimal-precision-2 description: Total selected for payment in the company's base currency. readOnly: true example: '500' totalTxnAmountSelectedForPayment: type: string format: decimal-precision-2 description: Total amount selected for payment in the invoice currency. readOnly: true example: '500' totalTxnAmountPaid: type: string format: decimal-precision-2 description: Total amount paid in the invoice currency. readOnly: true example: '500' contacts: type: object description: Associated contacts properties: payTo: type: object description: Pay to contact information from the customer record. title: payTo properties: key: type: string description: System-assigned key to uniquely identify the contact. example: '176' id: type: string description: Name of the contact. example: Power Aerospace Materials(C1) returnTo: type: object title: returnTo description: Return to contact information from the customer record. properties: key: type: string description: System-assigned key to uniquely identify the contact. example: '176' id: type: string description: Name of the contact example: Power Aerospace Materials(C1) isSystemGeneratedDocument: type: boolean readOnly: true description: > If `true`, this invoice record is created by the system internally and not created based on user input. example: true default: false billbackTemplate: type: object description: >- If AR is configured for inter-entity bill back, the template to use to create a matching bill. properties: key: type: string description: System-assigned key for the template. example: '18' id: type: string description: ID for the template. example: BBT-error5 href: type: string description: URL for the template. readOnly: true example: /objects/accounts-receivable/billback-template/18 attachment: type: object description: Supporting document attached to the invoice. properties: key: type: string description: System-assigned key for the supporting document. example: '11' id: type: string description: System-assigned ID for the supporting document. example: '11' href: type: string description: URL for the attachment. readOnly: true example: /objects/company-config/attachment/11 customer: type: object description: Customer to receive the invoice. properties: key: type: string description: System-assigned key for the customer. example: '14' id: type: string description: Unique identifier of the customer. example: C-00019 name: type: string description: Name of the customer. readOnly: true example: Haversham Textiles Corp emailOption: type: boolean description: Indicates whether email is a delivery option for the customer. readOnly: true default: false example: false customerDue: type: string format: decimal-precision-2 description: Amount due from the customer. readOnly: true example: '124041.29' deliveryOptions: type: string description: Invoice delivery options for the customer. enum: - print - email - both default: print example: both href: type: string description: URL for the customer. readOnly: true example: /objects/accounts-receivable/customer/14 term: type: object description: Term details for the invoice. properties: key: type: string description: System-assigned key for the term. example: '16' id: type: string description: Name of the term. example: 30 Days href: type: string description: URL for the term. readOnly: true example: /objects/accounts-receivable/term/16 invoiceSummary: type: object description: >- Summary details for this invoice. Summaries are collections of the same types of transactions grouped together for processing. properties: key: type: string description: System-assigned key to uniquely identify the summary. example: '33' id: type: string description: System-assigned ID for the summary. example: '33' glPostingDate: type: string description: GL posting date for the summary. format: date readOnly: true example: '2023-02-06' title: type: string description: Name of the summary. readOnly: true example: 'OE Sales Invoice: 2023 Batch 1' isSummaryOpen: type: string description: >- A summary can be `open` or `closed`. Items, such as invoices, can be added to open summaries. enum: - open - closed example: open readOnly: true isSummaryPosted: type: string description: If `true`, the summary has been posted to the General Ledger. readOnly: true example: 'false' lines: type: array description: Line items of the invoice. items: $ref: '#/components/schemas/accounts-receivable-invoice-line' entity: $ref: '#/components/schemas/entity-ref' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true 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 accounts-receivable-account-labelRequiredProperties: type: object required: - id 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 accounts-receivable-account-label: type: object description: AR account labels provide more descriptive names for accounts. properties: key: type: string description: System-assigned key for the AR account label. readOnly: true example: '8' id: type: string description: >- Name or other unique identifier for the account label. This unique identifier cannot be modified. example: Software description: type: string description: A note about the purpose and use of the account label. example: Software sales href: type: string description: URL for the AR account label. readOnly: true example: /objects/accounts-receivable/account-label/8 status: $ref: '#/components/schemas/status' description: Status of the account label. default: active glAccount: type: object description: General ledger account this AR account label is assigned to. properties: id: type: string description: General ledger account number. example: '1501' key: type: string description: System-assigned key for the general ledger account. example: '356' href: type: string readOnly: true example: /objects/general-ledger/account/356 offsetGLAccount: type: object description: >- The general ledger account where the system posts offsets to this label. properties: id: type: string description: Account number for the offset general ledger account. example: '9999' key: type: string description: System-assigned key for the offset general ledger account. example: '406' href: type: string readOnly: true example: /objects/general-ledger/account/406 accounts-receivable-termRequiredProperties: type: object required: - id accounts-receivable-term: type: object description: >- Accounts Receivable (AR) terms are the rules a company establishes for extending credit to customers. properties: key: type: string description: System-assigned key for the AR term. readOnly: true id: type: string description: Name or other unique identifier for the AR term. status: $ref: '#/components/schemas/status' description: type: string description: Note about the purpose and use of the AR term. value: type: string description: Value readOnly: true audit: $ref: '#/components/schemas/audit' due: type: object description: >- The due date is a combination of a number of days and a reference point. For example, to set terms that reference the number of days from the invoice date, set the number of days in `day`, and set `fromBillbillDate` in `from`. properties: days: type: integer description: Number of days until the term is due. from: type: string description: >- The reference point from which to begin counting the number of days until the term is due. enum: - null - fromInvoiceDate - ofTheMonthOfInvoiceDate - ofNextMonthFromInvoiceDate - of2ndMonthFromInvoiceDate - of3rdMonthFromInvoiceDate - of4thMonthFromInvoiceDate - of5thMonthFromInvoiceDate - of6thMonthFromInvoiceDate - afterEndOfMonthOfInvoiceDate - fromInvoiceDateExtendingToEom nullable: true default: null discount: type: object description: >- A discount is a combination of a number of days, a reference point, and the amount of the discount. properties: days: type: integer description: Number of days until the discount goes into effect. amount: type: integer description: Amount of the discount. from: type: string description: >- The reference point from which to begin counting the number of days until the discount goes into effect. enum: - null - fromInvoiceDate - ofTheMonthOfInvoiceDate - ofNextMonthFromInvoiceDate - of2ndMonthFromInvoiceDate - of3rdMonthFromInvoiceDate - of4thMonthFromInvoiceDate - of5thMonthFromInvoiceDate - of6thMonthFromInvoiceDate - afterEndOfMonthOfInvoiceDate - fromInvoiceDateExtendingToEom nullable: true default: null unit: type: string enum: - null - amount - percentage description: >- The type of discount, which can be a dollar amount or a percentage. nullable: true default: null graceDays: type: integer description: Number of days before the discount is withdrawn. calculateOn: type: string enum: - lineItemsTotal - invoiceTotal description: >- How the system calculates discounts in transactions that use this term. The calculation can be based on the line item total, excluding added charges (such as shipping and taxes), or on the invoice total, including all charges. default: invoiceTotal penalty: type: object description: Penalty for paying after the due date. properties: cycle: type: string enum: - noPenalty - daily - weekly - biweekly - monthly - bimonthly - quarterly - halfYearly - annually description: Time span in which the penalty accrues. default: noPenalty amount: type: integer description: Amount of the penalty. unit: type: string enum: - null - amount - percentage description: >- The type of penalty, which can be a dollar amount or a percentage. nullable: true default: null graceDays: type: integer description: >- The number of days after the due date that the penalty takes effect. accounts-receivable-customerRequiredProperties: type: object required: - name 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 contact-ref: type: object properties: key: type: string description: System-assigned unique key for the contact readOnly: true example: '21' id: type: string description: Contact ID example: jsmith href: type: string description: URL endpoint for the contact readOnly: true example: /objects/company-config/contact/21 lastName: type: string description: Last name example: Smith firstName: type: string description: First name example: John middleName: type: string description: Middle name example: Archibald prefix: type: string description: Prefix example: Mr printAs: type: string description: Print as example: John Smith email1: type: string description: Primary email example: jsmith@company.com email2: type: string description: Secondary email example: john@aol.com phone1: type: string description: Primary phone example: '14085551212' phone2: type: string description: Secondary phone example: '14085559876' mobile: type: string description: Mobile phone example: '14085554420' pager: type: string description: Pager example: '14085559987' fax: type: string description: Fax example: '14085555309' URL1: type: string description: Primary URL example: https://mycompany.com URL2: type: string description: Secondary URL example: https://anothercompany.com companyName: type: string description: Company name example: AlcoSoft Inc mailingAddress: type: object description: Mailing Address properties: addressLine1: type: string description: Address 1 example: 300 Park Avenue addressLine2: type: string description: Address 2 example: Suite 1400 addressLine3: type: string description: Address 3 example: Western industrial area city: type: string description: City example: San Jose state: type: string description: State example: California postCode: type: string description: Zip or Postal Code example: '95110' country: type: string description: Country example: USA accounts-receivable-customer-contact: type: object description: A customer-contact is a contact record on a customer's `contactList`. properties: key: type: string description: System-assigned key for the customer contact information. readOnly: true example: '1' id: type: string description: >- Unique identifier for the customer contact information. This value is the same as `key` for this object. readOnly: true example: '1' categoryName: type: string description: User-defined category for grouping and sorting contacts. example: Billing contact href: type: string readOnly: true example: /objects/accounts-receivable/customer-contact/1 contact: type: object description: Contact to associate with the customer. properties: key: type: string description: System-assigned key for the contact. example: '197' id: type: string description: Unique identifier for the contact example: Jeffrey Palms href: type: string readOnly: true example: /objects/company-config/contact/197 audit: $ref: '#/components/schemas/audit' customer: type: object description: Customer that has the contactList where this contact appears. properties: key: type: string description: System-assigned key for the customer. example: '15' id: type: string description: ID for the customer. example: '15' href: type: string readOnly: true example: /objects/accounts-receivable/customer/15 accounts-receivable-customer-email-template: type: object description: >- Customer email templates can be used to automate standard messages sent to multiple customers. properties: key: type: string description: System-assigned unique key for the customer email template. readOnly: true example: '1' id: type: string description: >- Identifier for the customer email template. This value is the same as `key` for this object. readOnly: true example: '1' href: type: string description: URL endpoint for the customer email template. readOnly: true example: /objects/accounts-receivable/customer-email-template/1 customer: type: object description: > [Customer](/openapi/ar/accounts-receivable-customer/tag/Customers) associated with the email template. properties: key: type: string description: System-assigned key for the customer. example: '127' id: type: string description: Unique identifier for the customer. example: '014' href: type: string description: URL endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/127 txnDefinition: type: object description: >- Transaction definition, which is the template that contains accounting settings, workflow rules, and other configuration settings for a transaction. properties: href: type: string description: URL for the order-entry-txn-definition. readOnly: true example: /objects/order-entry/txn-definition/23 key: type: string description: Document template Key. example: '23' readOnly: true id: type: string description: Document template ID. example: Customer Invoice templateType: type: string description: Specify the type of transaction that will use the email template. enum: - arInvoice - arStatement - contract - soDocument - poDocument example: arInvoice default: arInvoice readOnly: true emailTemplate: type: object description: Associated email template. properties: key: type: string description: System-assigned key for the email template. example: '1' id: type: string description: Unique identifier for the email template. example: '1' name: type: string description: Name of the email template. readOnly: true example: Customer Trial href: type: string description: URL of the email template. readOnly: true example: /objects/company-config/email-template/1 accounts-receivable-customer: type: object description: A customer is any company to which you sell goods and services. properties: key: type: string description: System-assigned key for the customer. readOnly: true example: '24' id: type: string description: Unique identifier for the customer. example: C-00003 name: description: Name of the customer, which is usually the company name. type: string example: Gomez Manufacturers href: type: string description: URL for the customer. readOnly: true example: /objects/accounts-receivable/customer/24 status: $ref: '#/components/schemas/dimension-status' customerType: type: object description: >- The category assigned to the customer (for example, Consultants, Subcontractors, or Equipment). properties: key: type: string description: System-assigned key for the customer type. example: '1' id: type: string description: ID for the customer type. example: Customer - Direct href: type: string description: URL for the customer type. readOnly: true example: /objects/accounts-receivable/customer-type/1 parent: type: object description: Parent customer, which creates a customer hierarchy. properties: key: type: string description: System-assigned key for the parent customer. example: '10' id: type: string description: ID of the parent customer. example: C-00014 name: type: string description: Name of the parent customer. readOnly: true example: Pan American Global Partners href: type: string description: URL for the parent customer. readOnly: true example: /objects/accounts-receivable/customer/10 salesRepresentative: type: object description: Name of the employee responsible for this customer account. properties: key: type: string description: System-assigned key for the employee. example: '39' id: type: string description: ID of the employee. example: awong name: type: string description: Name of the employee. readOnly: true example: Anna Wong href: type: string description: URL for the employee. readOnly: true example: /objects/company-config/employee/39 taxId: type: string description: Tax identification number for the customer. example: 12-3434900 defaultRevenueGLAccount: type: object description: GL account for customer revenue. properties: key: type: string description: System-assigned key for the GL account. example: '41' id: type: string description: ID of the GL account. example: '1001' name: type: string description: Name of the GL account. readOnly: true example: Sterling Bank Operating href: type: string description: URL of the GL account. readOnly: true example: /objects/general-ledger/account/41 shippingMethod: type: object description: How goods are shipped to the customer. properties: key: type: string description: System-assigned key for the shipping method. example: '3' id: type: string description: ID of the shipping method. example: Fedex href: type: string description: URL of the shipping method. readOnly: true example: /objects/accounts-receivable/shipping-method/3 creditLimit: type: number description: Credit limit extended to the customer. example: 10000 isOnHold: type: boolean description: Indicates whether customer is on credit hold. default: false example: true contacts: type: object description: Contacts for the customer. properties: default: type: object description: > Display contact for this customer. Used as the default for other customer contacts, such as `shipTo`, that are not defined. allOf: - $ref: '#/components/schemas/contact-ref' - type: object properties: hideContactList: type: boolean description: Set to `true` to exclude from the company contact list. default: false example: true tax: type: object title: tax properties: isTaxable: type: boolean description: Indicates whether the contact is taxable. default: false example: true group: type: object description: Tax group the contact belongs to. properties: key: type: string description: System-assigned key for the tax group. example: '90' id: type: string description: Identifier for the tax group. example: Los Angeles href: type: string description: URL for the tax group. readOnly: true example: /objects/tax/contact-tax-group/90 primary: type: object description: Primary contact for the customer. title: primary properties: key: type: string description: System-assigned key for the contact. example: '87' id: type: string description: ID of the contact. example: Ben Jones href: type: string description: URL for the contact. readOnly: true example: /objects/company-config/contact/87 billTo: type: object description: >- Customer contact for company activity such as sales transactions, invoice creation, and manual deposits. title: billTo properties: key: type: string description: System-assigned key for the contact. example: '63' id: type: string description: ID of the contact. example: Rose Garcia href: type: string description: URL for the contact. readOnly: true example: /objects/company-config/contact/63 shipTo: type: object title: shipTo description: >- Customer contact for company activity such as sales transactions, invoice creation, and tax calculations. properties: key: type: string description: System-assigned key for the contact. example: '29' id: type: string description: ID of the contact. example: Veronica Clark href: type: string description: URL for the contact. readOnly: true example: /objects/company-config/contact/29 contactList: type: array description: List of contacts for the customer. items: $ref: '#/components/schemas/accounts-receivable-customer-contact' restrictions: type: object properties: restrictionType: type: string description: > Restrict customers to only the top-level company or for specific locations and departments. These restriction options are valid only for multi-entity companies that are [configured for restrictions](https://www.intacct.com/ia/docs/en_US/help_action/Multi-entity/Setup/configure-multi-entity.htm). Learn more about [restricting customers](https://www.intacct.com/ia/docs/en_US/help_action/Accounts_Receivable/Setup/Customers/setup-customers-in-ME.htm). The following values specify who can view and post transactions against this customer. **Valid values:** - `unrestricted` - The top level and all entities within the multi-entity structure. - `rootOnly` - Only the top level of the multi-entity structure. - `restricted` - Only the chosen locations, location groups, departments, or department groups within the multi-entity structure. enum: - null - unrestricted - rootOnly - restricted example: restricted nullable: true default: null locations: type: array description: Locations to which the customer can be restricted. example: - Dallas - Santa Fe - Las Vegas items: type: string departments: type: array description: Departments to which the customer can be restricted. example: - Sales - RDA - BD items: type: string audit: $ref: '#/components/schemas/audit' customerEmailTemplates: type: array description: Email templates for the customer. items: $ref: '#/components/schemas/accounts-receivable-customer-email-template' discountPercent: type: string description: Discount percentage for the customer. example: '10' term: type: object description: >- AR term for the customer, which are the rules for extending credit to the customer. properties: key: type: string description: System-assigned key for the term. example: '20' id: type: string description: Name of the term. example: Net 15 href: type: string description: URL for the term. readOnly: true example: /objects/accounts-receivable/term/20 advanceBillBy: type: string description: >- Bill in advance setting, which instructs Sage Intacct to create billing schedules that automatically start before a contract line starts. example: '7' advanceBillByType: type: string description: >- Bill in advance type to indicate whether the advance value is number of days or months. enum: - '' - days - months example: days totalDue: type: string description: Total amount currently due from the customer. readOnly: true example: '3250.00' lastInvoiceCreatedDate: type: string format: date description: Date the most recent invoice was created. readOnly: true example: '2023-05-15' lastStatementGeneratedDate: type: string format: date description: Date the most recent statement was generated. readOnly: true example: '2023-01-01' resaleNumber: type: number description: >- Resale number, which applies to customers who are resellers of your company's products or services. example: 1534 deliveryOptions: type: string description: Delivery option for the customer's statements. enum: - print - email - both example: both overridePriceList: type: string description: >- By default, the customer price list is assigned to the entire customer, including the customer contacts. But, you can override the customer price list with the corresponding options for either the billing or shipping contact. enum: - Customer - Billing contact - Shipping contact default: Customer example: Billing contact customerMessageId: type: string description: ID of the default message to print on the customer's invoices. example: StndMsg1 currency: type: string description: Currency for the customer. example: CAD emailOptIn: type: boolean description: Indicates whether the customer accepts emailed invoices. default: false example: true activationDate: type: string format: date description: Monthly recurring revenue activation date. readOnly: true example: '2022-04-03' subscriptionEndDate: type: string format: date description: Monthly recurring revenue end date. readOnly: true example: '2023-03-31' territory: type: object description: The sales territory to which the customer is assigned. properties: key: type: string description: Territory key. example: '6' id: type: string description: Territory ID. example: NE name: type: string description: Territory name. example: Northeast enableOnlineACHPayment: type: boolean description: Set to `true` to enable automation of customer payments using ACH. default: true example: true enableOnlineCardPayment: type: boolean description: Set to `true` to automate customer payments using a credit card. default: true example: true isOneTimeUse: type: boolean description: >- Set to `true` to designate the customer as a one-time use customer that should not be included in standard look-up lists. default: false example: false accountGroup: type: object description: >- Customer GL group to control the GL account that transactions with the customer should post to. properties: key: type: string description: System-assigned key for the customer GL group. example: '41' id: type: string description: ID for the customer GL group. example: Direct href: type: string description: URL for the customer GL group. readOnly: true example: /objects/accounts-receivable/customer-account-group/41 accountLabel: type: object description: Label for the AR account associated with the customer. properties: key: type: string description: System-assigned key for the AR account label. example: '38' id: type: string description: ID for the account label. example: SW Sales href: type: string description: URL for the account label. readOnly: true example: /objects/accounts-receivable/account-label/38 attachment: type: object description: Attachment that serves as a supporting document for the customer. properties: key: type: string description: System-assigned key for the attachment. example: '51' id: type: string description: ID for the attachment. example: '123' href: type: string description: URL for the attachment. readOnly: true example: /objects/company-config/attachment/51 retainagePercentage: type: number description: >- Default retainage percentage for the customer. Retainage must be enabled for a customer and a Construction subscription is required to enable this capability. example: 25 notes: type: string description: Notes or comments about the customer. example: Service tier 1 priceList: type: object description: Price list associated with the customer. properties: key: type: string description: System-assigned key for the price list. example: '7' id: type: string description: ID for the price list. example: Base Price List href: type: string description: URL for the price list. readOnly: true example: /objects/order-entry/price-list/7 priceSchedule: type: object description: Price schedule associated with the customer. properties: key: type: string description: System-assigned key for the price schedule. example: '4' id: type: string description: ID for the price schedule. example: PREF href: type: string description: URL for the price schedule. readOnly: true example: /objects/purchasing/price-schedule/4 overrideOffsetGLAccount: type: object description: Default AR override offset account for this customer. properties: key: type: string description: System-assigned key for the GL account. example: '12' id: type: string description: ID for the GL account. example: '134' name: type: string description: Name of the GL account. readOnly: true example: 1225 - Sales href: type: string description: URL for the GL account. readOnly: true example: /objects/general-ledger/account/12 accounts-receivable-customer-typeRequiredProperties: type: object required: - id accounts-receivable-customer-type: type: object description: >- Customer types provide a way to group customers into categories, such as reseller and end user. properties: key: type: string description: System-assigned key for the customer type. readOnly: true example: '16' id: type: string description: Name of the customer type. example: Top Level Customer href: type: string description: URL for the customer type. readOnly: true example: /objects/accounts-receivable/customer-type/16 status: $ref: '#/components/schemas/status' parent: type: object description: Parent of a subordinate customer type. properties: key: type: string description: System-assigned key for the parent customer type. example: '5' id: type: string description: Identifier for the parent customer type. example: Level 1 Customer href: type: string description: URL for the parent customer type. readOnly: true example: /objects/accounts-receivable/customer-type/5 audit: $ref: '#/components/schemas/audit' accounts-receivable-customer-email-templateRequiredProperties: type: object properties: customer: required: - key example: '127' emailTemplate: required: - key example: '1' accounts-receivable-adjustmentRequiredProperties: type: object required: - createdDate properties: customer: required: - id example: '1' txnCurrency: required: - currency example: USD lines: type: array items: type: object properties: glAccount: required: - id example: '2995' txnCurrency: required: - amount example: '100' dimensions: properties: location: required: - id example: '1' 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 readOnly: true example: '120.20' txnCurrency: type: object description: Transaction currency for the line item. properties: currency: type: string description: Transaction currency example: INR amount: type: string description: Transaction amount example: '145' exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: string description: >- Exchange rate used to calculate the base amount from the transaction amount. example: '1.0789' typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: '1' adjustmentType: type: string description: Record type readOnly: true example: ra isTax: type: boolean description: Indicates whether the line item amount includes taxes. default: false readOnly: true example: false accountLabel: type: object description: Label for the AR account. properties: key: type: string description: System-assigned key for the AR account label. example: '1' id: type: string description: ID for the AR account label. example: '1' href: type: string description: Endpoint for the AR account label. readOnly: true example: /objects/accounts-receivable/account-label/9 arAdjustment: type: object description: Header level details for the AR adjustment's line entries. properties: key: type: string description: System-assigned key for the AR adjustment. example: '10' id: type: string description: ID of the AR adjustment. example: '10' href: type: string description: Endpoint for the AR adjustment. readOnly: true example: /objects/accounts-receivable/adjustment/1 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: department: type: object description: Department to assign the expense amount to. properties: key: type: string description: System-assigned key for the department. example: '1' id: type: string description: ID of the department. example: '1' name: type: string description: Name of the department. example: Accounting href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/1 location: type: object description: Location to assign the expense amount to. properties: key: type: string description: System-assigned key for the location. example: '1' id: type: string description: ID of the location. example: '1' name: type: string description: Name of the location. example: India href: type: string description: Endpoint of the location. readOnly: true example: /objects/company-config/location/1 glAccount: $ref: '#/components/schemas/gl-account-ref' audit: $ref: '#/components/schemas/audit' accounts-receivable-adjustment: type: object description: >- An AR adjustment is a transaction that applies a credit or debit in order to modify the amount owed by a customer. properties: key: type: string description: System-assigned key for the AR adjustment. readOnly: true example: '15' id: type: string description: >- ID for the AR adjustment. This value is the same as key for this object. readOnly: true example: '15' txnType: type: string description: >- Record type to identify the type of transaction. An AR adjustment has a record type of `ra`. readOnly: true example: ra adjustmentNumber: type: string description: Number that can be used to track the AR adjustment. example: ADJ001 href: type: string description: URL endpoint for the AR adjustment. readOnly: true example: /objects/accounts-receivable/adjustment/15 contacts: type: object description: Associated contacts for the AR adjustment. properties: billTo: type: object description: Customer contact to invoice for this sale. title: billTo properties: key: type: string description: System-assigned key for the contact. example: '916' id: type: string description: Name of the contact. example: Power Aerospace Materials (C1) href: type: string description: URL endpoint for the contact. readOnly: true example: /objects/company-config/contact/916 shipTo: type: object description: Customer contact for shipping. title: shipTo properties: key: type: string description: System-assigned key for the contact. example: '312' id: type: string description: Name of the ship-to contact. example: Power Aerospace Materials(C1) href: type: string description: URL endpoint for the contact. readOnly: true example: /objects/company-config/contact/312 state: type: string description: Processing state of the AR adjustment. readOnly: true enum: - reversed - reversal - draft - noValue - posted - paid - partiallyPaid - selected example: paid description: type: string description: Description of the AR adjustment. example: >- Computer Hardware & Software Expenses 03/01/20 - 08/31/21 Subscription charges. documentNumber: type: string description: Invoice number selected as a reference for the adjustment. example: INV-1602 baseCurrency: type: object description: For multi-currency companies, the base currency for the adjustment. properties: currency: type: string description: Base currency example: USD totalPaid: type: string format: decimal-precision-2 description: Total paid amount. readOnly: true example: '1117.8' totalSelected: type: string format: decimal-precision-2 description: Total selected amount. readOnly: true example: '100.10' totalDue: type: string format: decimal-precision-2 description: Total amount due. example: '251464.01' totalAmountEntered: type: string format: decimal-precision-2 description: Total entered readOnly: true example: '100.20' paidDate: type: string format: date description: Payment date example: '2022-11-01' txnCurrency: type: object description: >- For multi-currency companies, the transaction currency for the adjustment. properties: currency: type: string description: Transaction currency example: INR totalEntered: type: string format: decimal-precision-2 description: Total transaction amount entered. readOnly: true example: '1000.20' totalSelected: type: string format: decimal-precision-2 description: Total transaction amount selected. readOnly: true example: '1000.05' totalPaid: type: string format: decimal-precision-2 description: Total transaction amount paid. readOnly: true example: '2000.50' totalDue: type: string format: decimal-precision-2 description: Total transaction amount due. readOnly: true example: '100.50' exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: string description: >- Exchange rate used to calculate the base amount from the transaction amount. example: '1.0789' typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: '1' moduleKey: type: string description: Key for the source module from which the transaction was created. readOnly: true example: 3.AR customer: type: object description: The customer who is the target of the AR adjustment. properties: key: type: string description: System-assigned key for the customer. example: '16' id: type: string description: ID of the customer. example: Customer_01 name: type: string description: Name of the customer. example: Logic Solutions totalDue: type: string format: decimal-precision-2 description: Transaction total due for the customer. readOnly: true example: '1125.10' href: type: string description: URL endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/16 createdDate: type: string format: date example: '2021-01-23' description: Date the adjustment was created. glPostingDate: type: string format: date description: GL posting date. example: '2023-03-24' attachment: type: object description: Supporting document for the adjustment. properties: key: type: string description: System-assigned key for the supporting document. example: '1' id: type: string description: ID for the supporting document. example: Sales01 href: type: string description: URL endpoint for the attachment. readOnly: true example: /objects/company-config/attachment/1 lines: type: array description: Line items of the AR adjustment. items: $ref: '#/components/schemas/accounts-receivable-adjustment-line' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Date and time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true accounts-receivable-advanceRequiredProperties: type: object required: - paymentMethod - paymentDate - receiptDate - financialEntity properties: customer: required: - id example: '1' items: type: array items: type: object properties: glAccount: required: - id example: '4010' dimensions: properties: location: required: - id example: '1' required: - txnAmount example: '100' state: type: string enum: - draft - submitted - partiallyApproved - partiallyPaid - approved - paid - posted - declined - reversalPending - reversed - reversal default: posted description: State to update the entry to. Posted to post to the GL example: draft 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-line: type: object description: Detail and header information for AR advance transactions. properties: key: type: string description: System-assigned key for the AR advance line. readOnly: true example: '23' id: type: string description: AR advance line ID. readOnly: true example: '23' href: type: string description: Endpoint for the AR advance line. readOnly: true example: /objects/accounts-receivable/advance-line/23 baseAmount: type: string format: decimal-precision-2 description: >- Amount for the line item in your company's base currency, which is calculated based on the exchange rate defined in the header. readOnly: true example: '100.00' txnAmount: type: string format: decimal-precision-2 description: Amount for the AR advance line item in the transaction currency. example: '100' memo: type: string description: Memo about the line item. example: Service charges currency: type: object description: Currency details for the advance. properties: baseCurrency: type: string description: Base currency for the company. readOnly: true example: USD txnCurrency: type: string description: Transaction currency for the advance. readOnly: true example: GBP exchangeRate: type: object title: exchangeRate description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' lineNumber: type: integer description: Line number readOnly: true example: 1 paymentInformation: type: object description: Payment information for the AR advance line item. properties: totalPaid: type: string format: decimal-precision-2 description: Total paid for the line item. readOnly: true example: '200' txnTotalPaid: type: string format: decimal-precision-2 description: Transaction total paid for the line item. readOnly: true example: '200' totalSelected: type: string format: decimal-precision-2 description: Total selected for the line item. readOnly: true example: '100' txnTotalSelected: type: string format: decimal-precision-2 description: Total transaction selected for the line item. readOnly: true example: '100' baseLocation: type: object allOf: - $ref: '#/components/schemas/location-ref' - type: object properties: key: type: string description: Base location key. example: '4' accountLabel: type: object properties: key: type: string description: System-assigned key for the account label. example: '14' id: type: string description: Meaningful name of the account. example: Accounting Fees name: type: string description: Name of the account label. readOnly: true example: Accounting Fees href: type: string description: Endpoint for the account label. readOnly: true example: /objects/accounts-receivable/account-label/14 glAccount: $ref: '#/components/schemas/gl-account-ref' dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of locations to reflect how your company is organized. title: location properties: key: type: string description: System-assigned key for the location. example: '4' id: type: string description: Unique identifier of the location. example: AU name: type: string description: Name of the location. readOnly: true example: Australia href: type: string description: Endpoint for the location. readOnly: true example: /objects/company-config/location/4 department: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string description: System-assigned key for the department. example: '9' id: type: string description: Unique identifier of the department. example: '01' name: type: string description: Name of the department. readOnly: true example: Accounting href: type: string description: Endpoint for the department. readOnly: true example: /objects/company-config/department/9 arAdvance: description: Header level details for the AR advance's line items. type: object readOnly: true properties: id: type: string description: Identifier for the AR advance. readOnly: true example: '23' key: type: string description: System-assigned key for the AR advence. readOnly: true example: '23' href: type: string description: Endpoint for the AR advance. readOnly: true example: /objects/accounts-receivable/advance/23 recordType: type: string description: Record type. readOnly: true example: rr audit: $ref: '#/components/schemas/audit' accounts-receivable-advance: type: object description: Header information for AR advance transactions. properties: key: type: string description: System-assigned key for the ar-advance. readOnly: true example: '23' id: type: string description: AR advance ID. readOnly: true example: '23' recordType: type: string description: >- Record type to identify the type of transaction. AR Advances record type refers to `rr`. readOnly: true example: rr href: type: string description: Endpoint for the ar-advance. readOnly: true example: /objects/accounts-receivable/advance/23 referenceNumber: type: string description: >- This is a number such as a purchase order or account number that might be useful in searches or reports. This number shows on the GL Details report. example: INV-902852 description: type: string description: Description of the AR advance. example: >- Computer Hardware & Software Expenses 03/01/20 - 08/31/21 Subscription charges. receiptDate: type: string format: date description: Receipt date. example: '2021-01-25' paymentDate: type: string format: date description: Payment date. example: '2021-01-25' state: $ref: '#/components/schemas/state' totalEntered: type: string format: decimal-precision-2 description: Total amount of the AR advance. example: '100' txnTotalEntered: type: string format: decimal-precision-2 description: Total transaction amount. example: '100.20' paymentInformation: type: object description: Payment information for the AR advance. properties: paidDate: type: string format: date example: '2021-01-23' description: Date the AR advance was paid. readOnly: true totalPaid: type: string format: decimal-precision-2 description: Total paid for the AR advance. readOnly: true example: '100' totalSelected: type: string format: decimal-precision-2 description: Total selected for the AR advance. readOnly: true example: '100.10' txnTotalSelected: type: string format: decimal-precision-2 description: Total transaction selected. readOnly: true example: '1000.05' txnTotalPaid: type: string format: decimal-precision-2 description: Transaction total paid. readOnly: true example: '2000.50' totalDue: type: string format: decimal-precision-2 description: Total amount due. readOnly: true example: '251464.01' totalTxnAmountDue: type: string format: decimal-precision-2 description: Total amount due for the advance. readOnly: true example: '10' reconciliationGroup: type: object properties: clearingDate: type: string format: date description: Automatically added when reconciliation is done. example: '2021-01-23' cleared: type: string enum: - 'true' - 'false' - matched description: Status to mark the reconciliation stage default: 'false' example: 'false' isSystemGenerated: type: boolean description: System generated example: false default: false accountType: type: string description: Account Type. example: bank enum: - bank - undepositedFundsAccount default: bank advanceSummary: type: object description: >- Summary details for this advance. Summaries are collections of the same types of transactions grouped together for processing. properties: href: type: string description: Endpoint for the batch. readOnly: true example: /objects/batch/23 key: type: integer description: System-assigned key to uniquely identify the summary. example: 280 id: type: string description: System-assigned ID for the summary. example: '280' name: type: string description: >- Name for the AR summary. The system uses this name to identify the summary throughout the Accounts Receivable application. example: 'Bills: 2022/01/01 Batch' glPostingDate: type: string format: date description: Posted date of the AR advance summary. example: '2021-01-23' isSummaryOpen: type: string description: >- A summary can be open or closed. Items, such as invoices, can be added to open summaries. enum: - open - closed example: open readOnly: true customer: type: object properties: href: type: string description: Endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/23 id: type: string description: ID of the customer. example: Customer_01 key: type: string description: System-assigned key for the customer. example: '15' name: type: string description: Customer name. example: Logic Solutions currency: $ref: '#/components/schemas/currency' financialEntity: type: string description: Financial entity. example: BOA glAccount: type: object properties: href: type: string description: Endpoint for the glaccount. readOnly: true example: /objects/glaccount/23 id: type: string description: General ledger account number. example: '1501' key: type: string description: System-assigned key for the general ledger account. example: '356' undepositedGLAccountNumber: type: string description: Undeposited funds account no.. example: '100444' paymentMethod: type: string description: Payment method. nullable: false example: printedCheck enum: - printedCheck - creditCard - eft - cash - ach attachment: type: object properties: key: type: string example: '21' id: type: string example: Sales01 href: type: string readOnly: true example: /objects/company-config/attachment/21 items: type: array description: Line items of the advance. items: $ref: '#/components/schemas/accounts-receivable-advance-line' audit: $ref: '#/components/schemas/audit' accounts-receivable-advance-lineRequiredProperties: type: object required: - txnAmount accounts-receivable-billback-templateRequiredProperties: type: object required: - id - description properties: lines: type: array items: type: object required: - txnAmount properties: invoiceGLAccount: type: object required: - key billGLAccount: type: object required: - key accounts-receivable-billback-template-line: type: object description: Billback template lines properties: key: type: string description: Record key readOnly: true example: '5' id: type: string description: BillBack Template Line Item ID readOnly: true example: '5' href: type: string description: URL for the billback template line. readOnly: true example: /objects/accounts-receivable/billback-template-line/5 lineNumber: type: string description: Line No readOnly: true example: '2' memo: type: string description: Memo example: Line number 2 invoiceGLAccount: type: object description: The account for the line item in the invoice properties: key: type: string example: '5' id: type: string example: '4000' name: type: string example: Sales href: type: string description: URL for the account. readOnly: true example: /objects/general-ledger/account/5 billGLAccount: type: object description: >- The bill GL Account is used in the corresponding line item of generated bill. properties: key: type: string example: '6' id: type: string example: '2000' name: type: string example: School Fees href: type: string description: URL for the account. readOnly: true example: /objects/general-ledger/account/6 department: type: object description: Department properties: key: type: string example: '9' id: type: string example: '11' name: type: string example: Accounting href: type: string description: URL for the account. readOnly: true example: /objects/company-config/department/9 billbackTemplate: description: Header level details for the Billback templete's line items. type: object properties: id: type: string description: Identifier for the billback template. readOnly: true example: '5' key: type: string description: System-assigned key for the Billback template. readOnly: true example: '5' href: type: string description: URL for the billback template. readOnly: true example: /objects/accounts-receivable/billback-template/5 readOnly: true accounts-receivable-billback-template: type: object description: Billback template properties: key: type: string description: BillBack Template Key readOnly: true example: '23' id: type: string description: BillBack Template ID example: Template 1 href: type: string description: URL for the billback template. readOnly: true example: /objects/accounts-receivable/billback-template/23 description: type: string description: Description example: Billback template for sales account enableInterEntityPostings: type: boolean description: >- Set to true to post directly to the mapped inter-entity offset accounts instead of the Accounts Receivable and Accounts Payable offset accounts. default: false example: true status: $ref: '#/components/schemas/status' lines: type: array description: Line items of the billback template. items: $ref: '#/components/schemas/accounts-receivable-billback-template-line' accounts-receivable-invoice-summary: type: object description: Collection of invoices grouped together for processing. properties: key: type: string description: System-assigned key for the invoice summary. readOnly: true example: '13' id: type: string description: >- ID for the invoice summary. This value is the same as key for this object. readOnly: true example: '13' href: type: string description: URL endpoint for the invoice summary. readOnly: true example: /objects/accounts-receivable/invoice-summary/23 name: type: string description: >- Name of the invoice summary. The system uses this name to identify the summary throughout the Accounts Receivable application. example: batch4 summaryCreationType: type: string description: >- If set to `manual`, the summary was created by a user and if set to `system`, the summary was created by Sage Intacct based on the summary frequency. example: manual enum: - system - manual default: manual readOnly: true glPostingDate: type: string format: date description: >- The date that the items included in the summary should post to the general ledger. example: '2023-05-06' recordType: type: string description: >- The record type determines the type of items the summary should contain. example: ri enum: - pi - pp - pa - pb - pd - ri - rp - ra - rd - ro - rc - ei - ep - ea - cm totalAmount: type: string description: Total amount of all transactions included in the summary. format: decimal-precision-2 example: '120.12' readOnly: true state: type: string description: >- State of the summary, which can be `open` or `closed`. An open summary can have items added to it. example: open enum: - open - closed parent: type: object description: Parent of the invoice summary. properties: key: type: string description: System-assigned key for the parent summary. example: '13' id: type: string description: Identifier for the parent summary. example: '13' href: type: string description: URL endpoint for the parent summary. readOnly: true example: /objects/accounts-receivable/summary/13 preventGLPosting: type: boolean description: >- Set to `true` to prevent posting the summary items to the general ledger. default: false example: false bankAccount: type: object description: Bank account associated with the invoice summary. properties: key: type: string description: System-assigned key for the bank account. example: '1' id: type: string description: ID for the bank account. example: '1' href: type: string description: URL endpoint for the bank account. readOnly: true example: /objects/cash-management/bank-account/1 isQuickPaymentSummary: type: boolean description: >- This field is set to `true` only for manual and quick payment summaries. example: false default: false status: $ref: '#/components/schemas/status' accounts-receivable-paymentRequiredProperties: type: object properties: paymentDetails: type: array items: type: object properties: arInvoice: required: - id example: '1' txnCurrency: required: - paymentAmount example: '100' paymentSummary: required: - receiptDate example: '2021-01-23' customer: required: - id example: '1' txnCurrency: required: - currency example: USD required: - paymentMethod example: cash accounts-receivable-payment-detail: type: object description: >- An AR payment detail object can specify either an object, like an invoice or an adjustment, as a whole (header level), or it can specify a line item. An AR payment detail object also provides the transaction amount that was received. properties: key: type: string description: System-assigned key for the AR payment detail. readOnly: true example: '94' id: type: string description: >- Identifier for the AR payment detail. This value is the same as `key` for this object. readOnly: true example: '94' href: type: string description: URL for the AR payment detail. readOnly: true example: /objects/accounts-receivable/payment-detail/94 paymentDate: type: string format: date description: >- Date the payment was received. For example, for a credit card payment, this date is the date the credit card transaction occurred. readOnly: true example: '2023-04-30' discountDate: type: string format: date description: Discount date example: '2023-04-30' baseCurrency: type: object description: For multi-currency companies, the company's base currency. properties: paymentAmount: type: string format: decimal-precision-2 description: The amount of the payment in the company's base currency. example: '10' inlineAmount: type: string format: decimal-precision-2 description: Inline transaction base amount. readOnly: true example: '10' adjustmentAmount: type: string format: decimal-precision-2 description: Adjustment transaction base amount. readOnly: true nullable: true example: '10' postedAdvanceAmount: type: string format: decimal-precision-2 description: Posted advance base amount. readOnly: true nullable: true example: '10' negativeInvoiceAmount: type: string format: decimal-precision-2 description: Negative invoice transaction base amount. readOnly: true nullable: true example: '10' postedOverPaymentAmount: type: string format: decimal-precision-2 description: Posted overpayment base amount. nullable: true readOnly: true example: '10' txnCurrency: type: object description: Transaction currency for the payment detail. properties: currency: type: string description: Payment currency. readOnly: true example: USD paymentAmount: type: string description: The amount of the transaction in the payment currency. format: decimal-precision-2 nullable: false example: '243.00' inlineAmount: type: string description: Inline transaction amount. format: decimal-precision-2 nullable: true example: '100.00' adjustmentAmount: type: string description: Adjustment transaction amount. format: decimal-precision-2 nullable: true example: '10' postedAdvanceAmount: type: string description: Posted advance transaction amount. format: decimal-precision-2 nullable: true example: '10' postedOverPaymentAmount: type: string description: Posted overpayment transaction amount. format: decimal-precision-2 nullable: true example: '40' negativeInvoiceAmount: type: string description: Negative invoice transaction amount. format: decimal-precision-2 nullable: true example: '30' inlineTxn: type: object description: Inline transaction record details. properties: key: type: string description: System generated key for the inline transaction. example: '89' id: type: string description: Inline transaction identifier. example: '89' href: type: string description: URL for the inline transaction. readOnly: true example: /objects/accounts-receivable/invoice/89 inlineTxnLine: type: object description: Inline transaction line item record. properties: key: type: string description: System generated key for the inline transaction line item. example: '4' id: type: string description: Identifier for the inline transaction line item. example: '4' href: type: string description: URL for the inline transaction line item. readOnly: true example: /objects/accounts-receivable/invoice-line/4 postedAdvance: type: object description: Posted advance record. readOnly: true properties: key: type: string description: System-generated key for the posted advance. readOnly: true nullable: true example: '25' id: type: string description: Identifier for the posted advance. readOnly: true nullable: true example: '25' href: type: string readOnly: true example: /objects/accounts-receivable/advance/25 postedAdvanceLine: type: object description: Posted advance line item record. readOnly: true properties: key: type: string description: System-assigned key for the posted advance line item. readOnly: true nullable: true example: '112' id: type: string description: Identifier for the posted advance line item. readOnly: true nullable: true example: '112' href: type: string readOnly: true example: /objects/accounts-receivable/advance-line/112 postedOverPayment: type: object description: Posted overpayment record. readOnly: true properties: key: type: string description: System-generated key for the posted overpayment record. readOnly: true nullable: true example: '3328' id: type: string description: Identifier for the posted overpayment record. readOnly: true nullable: true example: '3328' href: type: string description: URL for the posted overpayment record. readOnly: true example: /objects/accounts-receivable/payment/3328 postedOverPaymentLine: type: object description: Posted overpayment line item record. readOnly: true properties: key: type: string description: System generated key for the posted overpayment line item. readOnly: true nullable: true example: '56' id: type: string description: Identifer for the posted overpayment line item. readOnly: true nullable: true example: '56' href: type: string description: URL for the posted overpayment line item. readOnly: true example: /objects/accounts-receivable/payment-line/56 negativeInvoice: type: object description: Negative invoice transaction record properties: key: type: string description: System-generated key for the negative invoice transaction. example: '33' nullable: true id: type: string description: Identifier for the negative invoice transaction. example: '33' nullable: true href: type: string description: URL for the negative invoice transaction. readOnly: true example: /objects/accounts-receivable/invoice/33 negativeInvoiceLine: type: object description: Negative invoice transaction line item record. properties: key: type: string description: >- System-generated key for the negative invoice transaction line item. example: '4' nullable: true id: type: string description: Identifier for the negative invoice transaction line item. nullable: true example: '4' href: type: string description: URL for the invoice transaction line item. readOnly: true example: /objects/accounts-receivable/invoice-line/4 arAdjustment: type: object description: AR adjustment transaction record. properties: key: type: string description: System-generated key for the AR adjustment. example: '41' nullable: true id: type: string description: Identifier for the AR adjustment. nullable: true example: '41' href: type: string readOnly: true example: /objects/accounts-receivable/adjustment/41 arAdjustmentLine: type: object description: AR adjustment transaction line item record. properties: key: type: string description: System-generated key for the adjustment line item. example: '86' nullable: true id: type: string description: Identifier for the adjustment line item. example: '86' nullable: true href: type: string description: URL for the adjustment line item. readOnly: true example: /objects/accounts-receivable/adjustment-line/86 arInvoice: type: object description: AR invoice record. properties: key: type: string description: System-assigned key for the AR invoice. example: '1202' id: type: string description: Identifier for the AR invoice. example: '1202' href: type: string description: URL for the AR invoice. readOnly: true example: /objects/accounts-receivable/invoice/1202 arInvoiceLine: type: object description: AR invoice line item record. properties: key: type: string description: System-assigned key for the AR invoice line item. example: '6012' id: type: string description: Identifier for the AR invoice line item. example: '6012' href: type: string description: URL for the AR invoice line item readOnly: true example: /objects/accounts-receivable/invoice-line/6012 arAdvance: type: object description: AR advance record. properties: key: type: string description: System-generated key for the AR advance. example: '999' nullable: true id: type: string description: Identifier for the AR advance. example: '999' nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/advance/999 arAdvanceLine: type: object description: AR advance line item record. properties: key: type: string description: System-generated key for the AR advance line item. example: '59' nullable: true id: type: string description: Identifier for the AR advance line item. example: '59' nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/advance-line/59 arPostedOverPayment: type: object description: AR posted overpayment record. properties: key: type: string description: System-generated key for the posted overpayment. example: '4428' nullable: true id: type: string description: Identifier for the posted overpayment. example: '4428' nullable: true href: type: string description: URL for the posted overpayment. readOnly: true example: /objects/accounts-receivable/payment/4428 arPostedOverPaymentLine: type: object description: AR posted overpayment line item record. properties: key: type: string description: System-generated key for the posted overpayment line item. nullable: true example: '1642' id: type: string description: Identifier for the posted overpayment line item example: '1642' nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/payment-line/1642 arPayment: type: object description: AR payment record. readOnly: true properties: key: type: string description: System-assigned key for the AR payment. readOnly: true example: '2527' id: type: string description: Identifier for the AR payment. readOnly: true example: '2527' href: type: string description: URL for the AR payment. readOnly: true example: /objects/accounts-receivable/payment/2527 arPaymentLine: type: object description: AR payment line item record. readOnly: true properties: key: type: string description: System-assigned key for the AR payment line. readOnly: true example: '6663' id: type: string description: Identifier for the AR payment line. readOnly: true example: '6663' href: type: string description: URL for the AR payment line. readOnly: true example: /objects/accounts-receivable/payment-line/6663 positiveAdjustment: type: object description: Postive adjustment record. properties: key: type: string description: System-assigned key for the positive adjustment. example: '3379' nullable: true id: type: string description: Identifier for the positive adjustment. example: '3379' nullable: true href: type: string description: URL for the positive adjustment. readOnly: true example: /objects/accounts-payable/subledger-record/3379 positiveAdjustmentLine: type: object description: Positive adjustment line item record. properties: key: type: string description: System-assigned key for the positive adjustment line item. nullable: true example: '5678' id: type: string description: Identifier for the positive adjustment line item. nullable: true example: '5678' href: type: string description: URL for the positive adjustment line item. readOnly: true example: /objects/accounts-payable/subledger-record-line/5678 audit: $ref: '#/components/schemas/audit' accounts-receivable-payment-line: type: object description: >- Line items in a payment represent charges for items or services included in an invoice or adjustment. properties: id: type: string description: >- Identifier for the AR payment line item. This value is the same as `key` for this object. readOnly: true example: '98545678' key: type: string description: System-assigned key for the AR payment line item. readOnly: true example: '98545678' href: type: string description: URL for the AR payment line item. readOnly: true example: /objects/accounts-receivable/payment-line/98545678 memo: type: string description: Memo or brief description of the AR payment line item. example: Annual service charge baseCurrency: type: object description: >- For multi-currency companies, base currency information for the line item. readOnly: true properties: currency: type: string description: Base currency of the company. readOnly: true example: USD amount: type: string format: decimal-precision-2 description: >- For multi-currency companies, the amount of the line item in the company's base currency. readOnly: true example: '10' totalPaid: type: string format: decimal-precision-2 description: Total amount paid for the line item. readOnly: true example: '10' totalSelected: type: string format: decimal-precision-2 description: Total selected for the line item. readOnly: true example: '0' txnCurrency: type: object description: Transaction currency information for the line item. readOnly: true properties: currency: type: string description: Transaction currency. readOnly: true example: USD amount: type: string format: decimal-precision-2 description: >- For payment involving multi-currency, the amount of the item in the currency for the invoice. readOnly: true example: '10' totalPaid: type: string format: decimal-precision-2 description: Transaction total paid for the line item. readOnly: true example: '10' totalSelected: type: string format: decimal-precision-2 description: Total transaction selected for the line item. readOnly: true example: '0' exchangeRate: type: object description: >- Exchange rate details used to calculate the base amount for the line item. readOnly: true properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' lineNumber: type: number description: Line number of the AR payment line item. readOnly: true example: 1 arPayment: type: object description: Header level details for the AR payment's line entries. readOnly: true properties: key: type: string description: Parent payment record number. readOnly: true example: '310' id: type: string description: Parent payment record number. readOnly: true example: '310' href: type: string description: URL for the AR payment. readOnly: true example: /objects/accounts-receivable/payment/310 glAccount: type: object description: GL account associated with the line item. properties: key: type: string description: Account key example: '87' id: type: string description: Account number example: '1100' name: type: string description: GL account title example: Sales href: type: string description: GL account URL readOnly: true example: /objects/general-ledger/account/87 offsetGLAccount: type: object description: >- The general ledger account where the system posts offsets to this line item. properties: key: type: string description: Offset GL account key. example: '83' id: type: string description: Offset GL account number. example: '4000' href: type: string description: Offset GL account URL. readOnly: true example: /objects/general-ledger/account/83 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of locations to reflect how your company is organized. title: location properties: key: type: string description: Location key. example: '4' id: type: string description: Location ID. example: US name: type: string description: Location name. example: United States href: type: string description: Location URL. readOnly: true example: /objects/company-config/location/4 department: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string description: Department key. example: '9' id: type: string description: Department ID. example: ENG name: type: string description: Department name. example: Engineering href: type: string description: Department URL. readOnly: true example: /objects/company-config/department/9 audit: $ref: '#/components/schemas/audit' accounts-receivable-payment: type: object description: >- An AR payment is a transaction used to record a payment against an AR invoice or an AR adjustment/debit memo. properties: key: type: string description: System-assigned key for the AR payment. readOnly: true example: '310' id: type: string description: >- ID for the AR payment. This value is the same as the key for this object. readOnly: true example: '310' href: type: string description: URL endpoint for the AR payment. readOnly: true example: /objects/accounts-receivable/payment/310 recordType: type: string description: Type of payment record. readOnly: true example: rp payerName: type: string description: Name of the payer. example: NF Power and Light financialEntity: type: object description: Financial account from which the payment will be made. properties: entityId: type: string description: Financial entity ID, such as a checking account ID. example: CHK002 entityType: type: string description: Financial entity type. readOnly: true example: ba name: type: string description: Bank or other financial institution name. readOnly: true example: HSBC currency: type: string description: Bank currency readOnly: true example: USD state: type: string description: State of the AR payment. readOnly: true enum: - confirmed - reconciled - draft - reversed - reversal example: confirmed nullable: false default: null multiEntityPayment: type: object description: Multi-entity payment details. properties: key: type: string description: System-assigned key for the multi-entity payment. example: '123' readOnly: true nullable: true id: type: string description: Identifier for the multi-entity payment. readOnly: true nullable: true example: PAY-00136 href: type: string description: URL for the multi-entity payment. readOnly: true example: /objects/accounts-receivable/payment/123 paymentMethod: type: string description: Payment Method enum: - printedCheck - creditCard - eft - cash - onlineChargeCard - onlineACHDebit example: printedCheck documentNumber: type: string description: Document number, such as a check number. example: '1567' description: type: string description: Memo or notes about the AR payment. maxLength: 1000 example: Regular payment for services baseCurrency: type: object description: For multi-currency companies, the company's base currency. properties: currency: type: string description: The company's base currency. example: USD amountToPay: type: string format: decimal-precision-2 description: Amount to pay in the base currency. example: '500' totalAmount: type: string format: decimal-precision-2 description: Total base amount. readOnly: true example: '500' totalPaid: type: string format: decimal-precision-2 description: Total base amount paid. readOnly: true example: '500' totalDue: type: string format: decimal-precision-2 description: Total base amount due. readOnly: true example: '0' txnCurrency: type: object description: Transaction currency for the payment. properties: currency: type: string description: The currency in which the payment was made. example: USD amountToPay: type: string format: decimal-precision-2 description: Amount to pay in the transaction currency. example: '500' totalAmount: type: string description: Total transaction amount. format: decimal-precision-2 maxLength: 14 example: '100.00' totalPaid: type: string format: decimal-precision-2 description: Total transaction amount paid. readOnly: true example: '100.00' totalDue: type: string description: Total transaction amount due. format: decimal-precision-2 maxLength: 14 example: '0' readOnly: true exchangeRate: type: object description: Exchange rate details used to calculate the base amount. readOnly: true properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' bankReconciliationStatus: type: string description: If set to `true`, the payment has been reconciled. example: 'true' enum: - 'true' - 'false' default: 'false' readOnly: true bankReconciliationDate: type: string format: date description: Reconciliation date for the payment. readOnly: true example: '2022-04-30' referenceNumber: type: string description: >- Reference number, which can be a transaction number from the bank or a document number. maxLength: 21 example: '1234' paymentSummary: type: object description: >- AR summary the payment is part of. Summaries are collections of transactions grouped together for processing. properties: key: type: string description: System-assigned key for the AR summary. maxLength: 8 example: '1259' id: type: string description: Identifier for the AR summary. example: '1259' receiptDate: type: string format: date description: Posting date for the AR payment. example: '2021-01-23' title: type: string description: Title of the AR summary. example: 'Receipts (Bank-CHK0002): Batch 02-07-2023' name: type: string description: Name of the AR summary. maxLength: 100 example: Feb 2023 batch href: type: string description: URL endpoint for the AR summary. readOnly: true example: /objects/accounts-receivable/summary/1259 undepositedGLAccount: type: object description: Undeposited funds account associated with this payment. properties: href: type: string description: URL endpoint for the undeposited funds account. readOnly: true example: /objects/general-ledger/account/23 id: type: string description: Undeposited funds account number. example: '1501' nullable: true key: type: string description: System-assigned key for the undeposited funds account. example: '356' nullable: true customer: type: object description: Customer associated with the AR payment. properties: key: type: string description: System-assigned key for the customer. example: '45' entity: type: string description: Customer entity example: C100 readOnly: true id: type: string description: Identifier for the customer. maxLength: 21 example: Cust-00064 name: type: string description: Name of the customer. example: NF Power and Light readOnly: true totalDueAmount: type: string format: decimal-precision-2 description: Total due for the customer. readOnly: true example: '100.0' href: type: string description: URL endpoint for the customer. readOnly: true example: /objects/accounts-receivable/customer/45 attachment: type: object description: Supporting document for the payment. properties: key: type: string description: System-assigned key for the attachment. example: '123' id: type: string description: Identifier for the attachment. example: '123' href: type: string description: URL endpoint for the attachment. readOnly: true example: /objects/company-config/attachment/123 paidDate: type: string format: date example: '2023-01-23' description: Date when the invoice was fully paid. overPaymentDimensions: type: object description: >- Overpayments can be applied to future invoices and can be tagged to specific dimensions for future use. properties: customerId: type: string description: Customer who made the payment. example: C-00013 locationId: type: string description: ID of the location to assign any overpayment amount to. example: CA departmentId: type: string description: ID of the department to assign any overpayment amount to. example: '04' classId: type: string description: ID of the class to assign any overpayment amount to. example: Class1 projectId: type: string description: ID of the project to assign any overpayment amount to. example: '11' overPaymentAmount: type: string format: decimal-precision-2 description: >- Amount of the overpayment. When a payment is received that exceeds what the customer owes on all invoices and the amount of the payment is entered, Sage Intacct tracks the excess as an overpayment. example: '100.20' contacts: type: object description: Contact information for the AR payment. properties: payTo: type: object description: Pay-to contact for the AR payment. title: payTo properties: key: type: string description: System-assigned key for the pay-to contact. example: '8' id: type: string description: Identifier for the pay-to contact. example: Klay Vanderbilt paymentDetails: type: array description: Details for the AR payment. items: $ref: '#/components/schemas/accounts-receivable-payment-detail' lines: type: array description: Line items of the AR payment. items: $ref: '#/components/schemas/accounts-receivable-payment-line' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true accounts-receivable-payment-summary: type: object description: >- Collections of payments received from customers, such as invoice payments, grouped together for processing. properties: key: type: string description: System-assigned key for the AR payment summary. readOnly: true example: '5' id: type: string description: AR payment summary ID. readOnly: true example: '5' href: type: string description: Endpoint for the AR payment summary. readOnly: true example: /objects/accounts-receivable/payment-summary/5 name: type: string description: >- Name for the AR payment summary. The system uses this name to identify the summary throughout the Accounts Receivable application. example: 'Reversed Receipts(Bank-BOA): 2023/04/12 Batch' summaryCreationType: type: string description: >- If set to manual, then the summary was created by a user and if set to system, then the summary was created by Intacct based on the summary frequency. example: system enum: - system - manual default: manual readOnly: true glPostingDate: type: string format: date description: The date summary items post to the general ledger. example: '2023-04-12' recordType: type: string description: This determines the type of transactions of AR payment summary. example: rp enum: - pi - pp - pa - pb - pd - ri - rp - ra - rd - ro - rc - ei - ep - ea - cm totalAmount: type: string description: >- Total amount of transactions in the summary. Transactions amount include quick payments. format: decimal-precision-2 example: '200' readOnly: true state: type: string description: >- State of the summary, which can be `open` or `closed`. An open summary can have items added to it. example: open enum: - open - closed parent: type: object description: Parent of the AR payment summary. properties: key: type: string description: System-assigned key for the parent. example: '13' id: type: string description: Identifier for the parent. example: '13' href: type: string description: URL for the parent. readOnly: true example: /objects/accounts-receivable/summary/13 preventGLPosting: type: boolean description: >- Set to `true` to prevent posting summary items to the general ledger. default: false example: false bankAccount: type: object description: Bank account ID. properties: key: type: string description: System-assigned key for the bank account. example: '1' id: type: string description: Identifier for the bank account. example: '1' href: type: string description: URL for the bankaccount. readOnly: true example: /objects/cash-management/bank-account/1 isQuickPaymentSummary: type: boolean description: >- This field is set to true only for manual and quick payment summaries. Default is false. example: false default: false status: $ref: '#/components/schemas/status' accounts-receivable-summaryRequiredProperties: type: object required: - name - glPostingDate - recordType - status accounts-receivable-summary: type: object description: >- Summaries are collections of the same type of transactions, grouped together for processing. properties: key: type: string description: System-assigned key for the AR summary. readOnly: true example: '14' id: type: string description: >- Identifier for the AR summary. This value is the same as key for this object and can be ignored. Use key for all references to this object. readOnly: true example: '14' href: type: string description: URL the AR summary. readOnly: true example: /objects/accounts-receivable/summary/14 name: type: string description: >- Name for the AR summary. The system uses this name to identify the summary throughout the Accounts Receivable application. example: batch5 summaryCreationType: type: string description: >- If set to manual, then the summary was created by a user and if set to system, then the summary was created by Intacct based on the summary frequency. example: manual enum: - system - manual default: manual readOnly: true glPostingDate: type: string format: date description: The date summary items post to the general ledger. example: '2023-05-10' recordType: type: string description: >- Options Invoice, Adjustment, QuickDeposit, Payments. This determines the type of transaction that the summary contains. example: ra enum: - pi - pp - pa - pb - pd - ri - rp - ra - rd - ro - rc - ei - ep - ea - cm totalAmount: type: string description: >- Total amount of transactions in the summary. Transactions amount include invoices/adjustments and quick payment summaries. format: decimal-precision-2 example: '100' readOnly: true state: type: string description: >- State of the summary, which can be `open` or `closed`. An open summary can have items added to it. example: open enum: - open - closed parent: type: object description: Parent of the AR summary. properties: key: type: string description: System-assigned key for the parent. example: '11' id: type: string description: Identifier for the parent. example: '11' href: type: string description: URL for the parent. readOnly: true example: /objects/accounts-receivable/summary/11 preventGLPosting: type: boolean description: >- Set to `true` to prevent posting summary items to the general ledger. example: false default: false bankAccount: type: object description: Detail of the bank accounts. properties: key: type: string description: System-assigned key for the GL account. example: '13' id: type: string description: ID for the bank account. example: '13' href: type: string description: URL for the bank account. readOnly: true example: /objects/cash-management/bank-account/1 isQuickPaymentSummary: type: boolean description: >- This field is set to true only for manual and quick payment summaries. It is set to false for transactions of type invoice/adjustment. example: false default: false status: $ref: '#/components/schemas/status' accounts-receivable-territoryRequiredProperties: type: object required: - id - name accounts-receivable-territory: type: object description: >- Territories are optionally included in customer records and are used with Accounts Receivable reports. properties: key: type: string description: System-assigned key for the territory. readOnly: true example: '1' id: type: string description: >- Unique identifier for the territory. After an ID is created, it cannot be modified. example: T1 href: type: string readOnly: true description: Endpoint of the territory. example: /objects/accounts-receivable/territory/1 name: type: string description: Name of the territory. example: Southwest US status: $ref: '#/components/schemas/status' parent: type: object description: Parent territory if territories are organized in a hierarchy. properties: key: type: string description: System-assigned key for the parent territory. example: '2' id: type: string description: ID of the parent territory. example: 1-North href: type: string readOnly: true description: Endpoint of the parent territory. example: /objects/accounts-receivable/territory/21 manager: type: object description: >- Employee who manages the territory. Used for informational purposes only. properties: key: type: string description: System-assigned key for the employee. example: '81' id: type: string description: >- Unique identifier of the territory manager. When creating a territory, this must be the `id` of an existing employee. example: dwilson href: type: string description: Endpoint of the territory manager. example: /objects/company-config/employee/81 readOnly: true audit: $ref: '#/components/schemas/audit' accounts-receivable-territory-groupRequiredProperties: type: object required: - id - name - members accounts-receivable-territory-group-member: type: object description: Territory group members properties: key: type: string description: System-assigned key for the territory-group-member. readOnly: true example: '23' id: type: string description: System-assigned key for the territory-group-member. example: '23' href: type: string description: Endpoint for the territory-group-member. readOnly: true example: /objects/accounts-receivable/territory-group-member/23 territory: type: object description: Territory details. properties: key: type: string description: Territory object record no example: '1' id: type: string description: Territory ID example: T1 name: type: string description: Territory name readOnly: true example: India Territory href: type: string description: Endpoint for the territory. readOnly: true example: /objects/accounts-receivable/territory/23 sortOrder: type: string description: Territory group members sort order example: '1' territoryGroup: type: object description: Territory Group readOnly: true properties: key: type: string readOnly: true example: '10' id: type: string description: Parent group record number example: TG-1 href: type: string description: Endpoint for the territory-group. example: /objects/accounts-receivable/territory-group/23 audit: $ref: '#/components/schemas/audit' accounts-receivable-territory-group: type: object description: Territory groups properties: key: type: string description: System-assigned key for the territory-group. readOnly: true example: '23' id: type: string description: Territoty Group ID. example: T1 href: type: string description: Endpoint for the territory-group. readOnly: true example: /objects/accounts-receivable/territory-group/23 name: type: string description: Territory group name example: Group A description: type: string description: Description of the territory group maxLength: 500 example: Group 1 members: type: array description: Territory group members. minItems: 1 items: $ref: '#/components/schemas/accounts-receivable-territory-group-member' audit: $ref: '#/components/schemas/audit' accounts-receivable-customer-item-cross-referenceRequiredProperties: type: object required: - id accounts-receivable-customer-item-cross-reference: type: object description: list of customer item cross references properties: key: type: string description: Customer Item Cross Reference Key readOnly: true id: type: string description: Customer Item Cross Reference id readOnly: true href: type: string description: URL of the customer-item-cross-reference. readOnly: true customer: type: object description: Customer. properties: key: type: string description: Customer key id: type: string description: Customer ID name: type: string href: type: string description: URL of the customer. readOnly: true item: type: object properties: key: type: string description: Item key id: type: string description: Item ID example: null name: type: string example: null href: type: string description: URL of the item. readOnly: true referenceType: type: string description: Reference type example: customer enum: - customer default: customer itemAliasId: type: string description: Cross-reference item ID example: null itemAliasDescription: type: string description: Cross-reference item description example: null unit: type: string description: Unit example: null referenceTypeContext: type: string description: Reference type Context example: null enum: - internal - external audit: $ref: '#/components/schemas/audit' customerAccountGroupRequiredProperties: type: object required: - id accounts-receivable-customer-account-group: type: object properties: key: type: string description: Customer account group key readOnly: true example: '5' id: type: string description: Customer account group name example: Top Level customer groupType: type: string description: Customer account group type enum: - customer example: customer default: customer status: $ref: '#/components/schemas/status' href: type: string readOnly: true example: /objects/accounts-receivable/customer-account-group/5 accounts-receivable-recurring-invoiceRequiredProperties: type: object required: - invoiceNumber properties: customer: type: object required: - key term: type: object required: - key currency: type: object required: - txnCurrency schedule: type: object required: - startDate lines: type: array items: required: - txnAmount properties: glAccount: type: object required: - key accounts-receivable-recurring-invoice-line: type: object description: >- Line items in a recurring invoice represent transactions captured in that recurring invoice. properties: key: type: string description: System-assigned key for the line item. readOnly: true example: '23' id: type: string description: >- ID for the line item. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '23' href: type: string description: URL for the line item. readOnly: true example: /objects/accounts-receivable/recurring-invoice-line/23 description: type: string description: >- Memo provides information about the line item that may be of use in the future. nullable: true example: Service charges amount: type: string description: Base amount format: decimal-precision-2 example: '100' lineNumber: type: number description: Line number of the line item. readOnly: true example: 1 txnAmount: type: string description: Transaction amount format: decimal-precision-2 example: '100' isBillable: type: boolean description: Indicates whether the line item is billable. example: true default: false currency: type: object description: Currency information for the line item. properties: baseCurrency: type: string description: Base currency readOnly: true example: USD txnCurrency: type: string description: Transaction currency readOnly: true example: USD exchangeRateDate: type: string format: date example: '2021-01-23' description: Exchange rate date nullable: true readOnly: true exchangeRate: type: number description: Exchange rate readOnly: true example: 1.0789 exchangeRateTypeId: type: string description: Exchange rate type nullable: true readOnly: true example: INR-Rate isTax: type: boolean description: Indicates whether the line item is taxable. example: true default: false isSubTotal: type: boolean description: Indicates whether the line item is a subtotal. default: false example: true allocation: type: object description: Type of transaction allocation for the line item. properties: key: type: string description: System-assigned key for the allocation. example: '1' id: type: string description: System-assigned ID for the allocation. example: Alloc1-WBS-US href: type: string description: URL for the allocation. readOnly: true example: /objects/general-ledger/txn-allocation-template/1 accountLabel: type: object description: Account the line item is assigned to. properties: key: type: string description: Account label key example: '14' id: type: string description: Account label example: Accounting Fees href: type: string description: URL for the account label. readOnly: true example: /objects/accounts-receivable/account-label/14 taxDetail: type: object description: >- For companies subscribed to the Taxes application, the tax category for the line item. properties: key: type: string description: Tax detail key example: '1' id: type: string description: Tax detail ID example: '1' taxRate: type: string description: >- The percent tax rate defined for the tax detail used to calculate the amount of tax. readOnly: true example: '1.45' href: type: string description: URL for the tax detail. readOnly: true example: /objects/tax/order-entry-tax-detail/384 startDate: type: string format: date description: Revenue recognition start date. nullable: true example: '2021-01-23' endDate: type: string format: date description: Revenue recognition end date. nullable: true example: '2021-01-23' deferredRevenueGLAccount: type: object description: GL account for deferred revenue for the line item. properties: key: type: string description: Deferred revenue GL account key. example: '384' id: type: string description: Deferred revenue GL account number. example: '384' name: type: string description: Deferred revenue GL account name. readOnly: true example: AR ACCOUNT href: type: string description: URL for the deferred revenue GL account. readOnly: true example: /objects/general-ledger/account/384 glAccount: type: object description: GL account the line item is assigned to. properties: key: type: string description: System-assigned key for the GL account. example: '384' id: type: string description: ID for the GL account. example: '1234.36' name: type: string description: Name or title of the GL account. readOnly: true example: AR ACCOUNT href: type: string description: URL for the GL account. readOnly: true example: /objects/general-ledger/account/384 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Where multiple locations exist, the location to which the system should assign the expense. properties: key: type: string description: System-assigned key for the location. example: '1' id: type: string description: ID for the location. example: '1' name: type: string description: Name of the location. readOnly: true example: India href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/1 department: type: object description: Department the line item is assigned to. properties: key: type: string description: Department key example: '1' id: type: string description: Department ID example: '1' name: type: string description: Department name readOnly: true example: Accounting href: type: string description: URL for the department. readOnly: true example: /objects/company-config/department/1 offsetGLAccount: type: object description: GL account for discounts and penalties. properties: key: type: string description: System-assigned key for the offset GL account. example: '384' id: type: string description: ID for the offset GL account. example: '1234.36' name: type: string description: Name or title of the offset GL account. readOnly: true example: AR ACCOUNT href: type: string description: URL for the offset GL account. readOnly: true example: /objects/general-ledger/account/384 recurringInvoice: type: object description: Header level details for the AR recurring invoice line entries. properties: id: type: string description: ID for the AR recurring invoice. readOnly: true example: '23' key: type: string description: System-assigned key for the AR recurring invoice. example: '23' href: type: string description: URL for the AR recurring invoice. readOnly: true example: /objects/accounts-receivable/recurring-invoice/23 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' accounts-receivable-recurring-invoice: type: object description: >- Recurring invoices are invoices that repeat at periods and durations defined in a recurrence schedule. properties: key: type: string description: System-assigned key for the recurring invoice. readOnly: true example: '23' id: type: string description: >- ID for the recurring invoice. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '23' href: type: string description: URL for the recurring invoice. readOnly: true example: /objects/accounts-receivable/recurring-invoice/23 invoiceNumber: type: string description: >- Each occurrence of the invoice gets an incremented number based on the sequence type defined in Document Numbering on the company setup. example: ARINV totalEntered: type: string format: decimal-precision-2 description: Total amount entered. readOnly: true example: '100.00' description: type: string description: Description of the recurring invoice. nullable: true example: Memo referenceNumber: type: string description: >- This is a number such as a purchase order or account number that may be useful in searches or reports on this invoice. example: Doc 1 schedule: type: object properties: startDate: type: string description: The first date on which the invoice will be generated. format: date example: '2021-01-01' endDate: type: string description: >- If the scheduleEnd field is set to End Date, this establishes the final date on which the invoice will be generated. format: date nullable: true example: '2021-01-01' repeatCount: type: string description: >- If the scheduleEnd field is set to Number of occurrences, this establishes the number of times the invoice will be generated. nullable: true example: '1' repeatInterval: type: string description: >- Repeat interval of the scheduler in the recurring invoice. For example, if the frequency is set to days and the repeat interval is 2, an invoice is created every 2 days after the start date. nullable: true example: '1' default: '1' repeatBy: type: string description: Schedule repeat. enum: - none - day - week - month - year - endOfMonth default: day example: day scheduleEnd: type: string description: Termination point for the recurring invoice schedule. enum: - never - numberOfOccurrences - endDate example: never nextExecutionDate: type: string description: The next date on which the invoice will be generated. format: date example: '2021-01-01' readOnly: true lastExecutionDate: type: string description: The last date on which the invoice was generated. format: date readOnly: true example: '2021-01-01' term: type: object description: >- Payment terms, which are used to calculate due date, discounts, and penalties associated with this invoice. properties: key: type: string description: System-assigned key for the payment term. example: '1' id: type: string description: Name or other unique identifier for the payment term. example: N15 href: type: string description: URL for the payment term. readOnly: true example: /objects/accounts-receivable/term/16 contract: type: object properties: id: type: string description: Unique identifier for the contract. nullable: true example: CON-2 description: type: string description: Description of the contract. nullable: true example: Contract 2 currency: type: object properties: baseCurrency: type: string description: For multi-currency companies, the company's base currency. example: USD txnCurrency: type: string description: For multi-currency companies, the currency for the invoice. example: USD exchangeRate: type: number description: Exchange rate nullable: true example: 1.0789 exchangeRateTypeId: type: string description: Exchange rate type nullable: true example: INR-Rate customerMessage: type: string description: Message to include on the customer's invoice. nullable: true example: Customer message txnTotalEntered: type: string description: Transaction currency amount. format: decimal-precision-2 example: '100' contacts: type: object description: Contacts for the invoice. properties: billTo: type: object description: The bill-to contact is used as the address for the invoice. title: billTo properties: key: type: string description: System-assigned key for the contact. example: '1' id: type: string description: Name of the contact. example: 1099 Int href: type: string description: URL for the contact. readOnly: true example: /objects/company-config/contact/1 shipTo: type: object description: Ship-to contact for the invoice. title: shipTo properties: key: type: string description: System-assigned key for the contact. example: '1' id: type: string description: Name of the contact. example: 1099 Int href: type: string description: URL of the contact. readOnly: true example: /objects/company-config/contact/1 customer: type: object description: Person to receive the invoice. properties: key: type: string description: System-assigned key for the customer. example: '10' id: type: string description: ID for the customer. example: '2' name: type: string description: Name of the customer. readOnly: true example: Logic Solutions href: type: string description: URL for the customer. readOnly: true example: /objects/accounts-receivable/customer/2 payment: type: object description: List of payments on recurring AR invoices. properties: paymentMethod: type: string description: Payment method. example: creditCard enum: - none - printedCheck - creditCard - eft - cash - onlineChargeCard - onlineAchDebit paymentAmount: type: string description: Recurring invoice payment amount. format: decimal-precision-2 nullable: true example: '100.00' creditCardType: type: string description: Card type. nullable: true example: visa enum: - null - visa - mc - discover - amex - diners - other accountType: type: string description: Type of account to which the payment will be deposited. nullable: true enum: - null - bank - undepositedFundsAccount example: bank default: null payInFull: type: boolean description: Pay in full. default: true example: true bankAccountID: type: string description: Bank account record number. nullable: true example: SBME undepositFundsAccountId: type: string description: Undeposit account number nullable: true example: '1070' customerCreditCard: type: object properties: key: type: string description: Customer credit card key. nullable: true example: '10' id: type: string description: Customer credit card id. nullable: true example: Card101 attachment: type: object description: An attachment for invoice. properties: key: type: string description: System-assigned key for the attachment. example: '1' id: type: string description: Unique ID of the attachment. example: Attachment 1 href: type: string description: Endpoint for the attachment. readOnly: true example: /objects/company-config/attachment/1 lines: type: array description: Line items of the invoice. items: $ref: '#/components/schemas/accounts-receivable-recurring-invoice-line' audit: $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' accounts-receivable-posted-over-payment-line: type: object description: AR posted over payment line properties: key: type: string description: System-assigned key for the ar-posted-over-payment-line. readOnly: true example: '23' id: type: string description: AR posted overpayment line ID. readOnly: true example: '23' href: type: string description: URL for the ar-posted-over-payment-line. readOnly: true example: /objects/accounts-receivable/posted-over-payment-line/23 baseCurrency: type: object description: Grouping all the base currency fields. properties: currency: type: string description: Base currency of the company. readOnly: true example: USD amount: type: string description: >- For multi-currency companies, the base amount of the item in the company's base currency. readOnly: true example: '10' totalPaid: type: string description: Total amount paid for the line item. readOnly: true example: '10' totalSelected: type: string description: Total selected for the line item. readOnly: true example: '0' txnCurrency: type: object description: Grouping all the transaction currency fields. properties: currency: type: string description: Transaction currency. readOnly: true example: USD amount: type: string description: >- For payment involving multi-currency, the amount of the item in the currency for the invoice. readOnly: true example: '10' totalPaid: type: string description: Transaction total paid for the line item. readOnly: true example: '10' totalSelected: type: string description: Total transaction selected for the line item. readOnly: true example: '0' description: type: string description: Memo or brief description of the AR posted over payment line item. example: Description for line. exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: string description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: '1.0789' typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' lineNumber: type: number description: Line number of the AR payment line item. readOnly: true example: 1 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of locations to reflect how your company is organized. title: location properties: key: type: string example: '1' id: type: string description: Location ID example: US name: type: string description: Location name example: United States href: type: string readOnly: true example: /objects/company-config/location/4 department: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string example: '98545678' id: type: string description: Department ID example: ENG name: type: string description: Department name example: Engineering href: type: string readOnly: true example: /objects/company-config/department/9 glAccount: type: object properties: key: type: string description: Account key example: '98545678' id: type: string description: Account number example: '100' name: type: string description: GL account title example: Sales href: type: string description: GL account URL readOnly: true bankLocation: type: string description: Base location key. readOnly: true example: '2' arPostedOverPayment: type: object properties: key: type: string description: System-assigned key for the ar-posted-over-payment-line. readOnly: true example: '23' id: type: string description: >- System-assigned id for the ar-posted-over-payment-line. Same as key. readOnly: true example: '23' href: type: string description: URL for the ar-posted-over-payment. readOnly: true example: /objects/accounts-receivable/posted-over-payment/23 readOnly: true audit: $ref: '#/components/schemas/audit' accounts-receivable-posted-over-payment: type: object description: AR posted over payment properties: key: type: string description: System-assigned key for the ar-posted-over-payment. readOnly: true example: '23' id: type: string description: AR posted overpayment ID. readOnly: true example: '23' href: type: string description: URL for the ar-posted-over-payment. readOnly: true example: /objects/accounts-receivable/posted-over-payment/23 recordType: type: string description: Record type. example: ro state: type: string description: State of the AR posted over payment. enum: - null - partiallyApproved - submitted - voided - confirmed - approved - draft - declined - delivered - printVoided - deleted - quickDelivery example: approved paymentMethod: type: string description: Payment method. example: printedCheck enum: - printedCheck - creditCard - eft - cash - ach - manualCheck - checkDelivery default: printedCheck documentNumber: type: string description: Document number, such as a check number. example: '123' description: type: string description: Memo or notes about the AR posted over payment. maxLength: 1000 example: Memo for the line documentId: type: string description: Document ID. example: null paymentDate: type: string format: date description: Payment date. example: '2021-01-23' baseCurrency: type: object description: Grouping all the base currency fields. properties: currency: type: string description: The company's base currency. example: USD totalAmount: type: string description: Total amount. readOnly: true example: '10' totalSelected: type: string description: Total selected. readOnly: true example: '0' totalAmountPaid: type: string description: Total amount paid. readOnly: true example: '10' totalAmountDue: type: string description: Total amount due. readOnly: true example: '0' txnCurrency: type: object description: Grouping all the transaction currency fields. properties: currency: type: string description: The currency in which the payment was made. example: USD totalAmount: type: string description: Total transaction amount format: decimal-precision-2 maxLength: 14 example: '100.0' totalSelected: type: string description: Total transaction amount selected. readOnly: true example: '0' totalPaid: type: string description: Total transaction amount paid. readOnly: true example: '10' totalDue: type: string description: Transaction amount due format: decimal-precision-2 maxLength: 14 example: '100.0' readOnly: true financialAccount: type: string description: Financial account from which the payment will be paid. example: '22334455' receiptDate: type: string format: date description: Receipt date. example: '2021-01-23' cleared: type: string description: Indicates whether the payment has been cleared or matched. example: matched enum: - 'true' - 'false' - matched default: 'false' clearDate: type: string description: Reconciliation date. example: '2021-01-23' arSummary: type: object properties: href: type: string description: URL for the ar-summary. readOnly: true example: /objects/accounts-receivable/summary/23 key: type: string description: System-assigned key for the AR summary. example: '23' id: type: string description: Identifier for the AR summary. Same as key. example: '23' name: type: string description: Name for the AR summary. example: CR01152001 postingDate: type: string description: Posting date. example: '2021-01-23' customer: type: object description: Customer associated with the AR posted over payment. properties: key: type: string description: System-assigned key for the customer. example: '23' entity: type: string description: Customer entity example: C100 readOnly: true id: type: string description: Identifier for the customer. maxLength: 21 example: Cust-1 name: type: string description: Name of the customer. example: Ganesh readOnly: true totalDueAmount: type: string description: Total due for the customer. readOnly: true example: '100.00' href: type: string description: URL for the customer. example: /objects/accounts-receivable/customer/23 readOnly: true exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: string description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: '1.0789' typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' paymentDetails: type: array description: Details for the AR posted over payment. items: $ref: '#/components/schemas/accounts-receivable-payment-detail' lines: type: array description: Line items of the AR posted over payment. items: $ref: '#/components/schemas/accounts-receivable-posted-over-payment-line' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true accounts-receivable-revenue-recognition-templateRequiredProperties: type: object required: - id accounts-receivable-revenue-recognition-template: type: object description: >- Revenue recognition templates define how to amortize deferred revenue. Each template is associated with an Accounts Receivable label or Order Entry Item GL group. properties: key: type: string description: System-assigned key for the revenue recognition template. readOnly: true example: '1' id: type: string description: Unique identifier for the revenue recognition template. example: '1001' href: type: string description: URL for the revenue recognition template. example: /objects/accounts-receivable/revenue-recognition-template/1 readOnly: true description: type: string description: Description of the revenue recognition template. example: null useStandard: type: boolean description: Indicates whether to use standard calendar amortization. example: null default: false schedulePeriod: type: string description: >- The intervals at which Sage Intacct should schedule the journal entries to post. example: daily enum: - daily - monthly - quarterly - semiAnnually - annually postingDay: type: string description: The day of the month the revenue should post. example: endOfPeriod enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - endOfPeriod - daily recognitionTerm: type: string description: Recognition term. example: fixedPeriod enum: - fixedPeriod - contractTerm - project default: fixedPeriod resumeOption: type: string description: System resume option. example: catchUp enum: - catchUp - walkforward default: walkforward totalPeriods: type: string description: >- Number of periods. If `fixedPeriod` is set for `recognitionTerm` Sage Intacct uses this value to generate the schedule. example: null recognitionMethod: type: string description: Recognition method. example: straightLine enum: - straightLine - straightLine,prorateExactDays - straightLine,percentAllocation - straightLine,percentAllocation,endOfPeriod - exactDaysPerPeriod,prorateDays - exactDaysPerPeriod,prorateDays,endOfPeriod - percentCompleted - milestone - custom recognitionStartDate: type: string description: Recognition start date. example: transactionDate enum: - transactionDate - userSpecified default: transactionDate postingMethod: type: string description: Posting method. example: manual enum: - automatic - manual default: manual latestVersion: type: string description: Latest version key. example: null milestoneSource: type: string description: Percent or milestone source. example: manual enum: - manual - project default: manual calculation: type: object properties: source: type: string description: >- For a Percent completed template, select whether to calculate at the project or task level. example: project enum: - null - project - task nullable: true default: null basedOn: type: string description: Method to use to calculate the completion percentage. example: estimatedHours enum: - null - estimatedHours - plannedHours - budgetedHours - budgetedCostFromGL - budgetedCostFromSummary - observed%Completed nullable: true default: null status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' accounts-receivable-revenue-recognition-template-line: type: object description: This object represents line entries in a revenue recognition template. properties: key: type: string description: System-assigned key for the revenue recognition template line entry. readOnly: true example: '23' id: type: string description: >- Revenue recognition template line entry ID. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '23' href: type: string description: URL for the revenue recognition template line entry. readOnly: true example: /objects/accounts-receivable/revenue-recognition-template-line/23 template: type: object description: >- Header level details for the revenue recognition template's line entries. properties: key: type: string description: System-assigned key for the revenue recognition template. example: null id: type: string description: Unique identifier for the revenue recognition template. example: null href: type: string description: URL for the revenue recognition template. readOnly: true periodOffset: type: string description: >- Determines how many periods in the future to create the potential revenue recognition journal entries in the schedule. example: null percentAmount: type: number description: >- Indicates the percentage of the revenue recognition that should be applied to the corresponding account for the corresponding offset period. example: null glAccount: type: object description: GL account associated with the template line entry. properties: href: type: string description: URL for the GL account. readOnly: true example: /objects/general-ledger/account/23 key: type: string description: System-assigned key for the GL account. example: null id: type: string description: GL account number. example: null name: type: string description: GL account title. example: null accounts-receivable-revenue-recognition-template-milestone: type: object description: >- Milestone information for revenue recognition templates that have a recognition method of percent complete, milestone, or custom. properties: key: type: string description: System-assigned key for the revenue recognition template milestone. readOnly: true example: '23' id: type: string description: >- Revenue recognition template milestone ID. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '23' href: type: string description: URL for the revenue recognition template milestone. readOnly: true example: >- /objects/accounts-receivable/revenue-recognition-template-milestone/23 template: type: object description: >- Header level details for the revenue recognition template's milestone entries. properties: key: type: string description: System-assigned key for the revenue recognition template. example: null id: type: string description: Unique identifier for the revenue recognition template. example: null href: type: string description: URL for the revenue recognition template. readOnly: true periodOffset: type: integer description: >- Determines how many periods in the future to create the potential revenue recognition journal entries in the schedule. example: null percentAmount: type: number description: >- Indicates the percentage of the revenue recognition that should be applied to the corresponding account for the corresponding offset period. example: null description: type: string description: Description of the milestone. example: null responses: 400error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error-response' securitySchemes: OAuth2: description: Sage Intacct OAuth 2.0 authorization code flow type: oauth2 flows: authorizationCode: authorizationUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/authorize tokenUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/token refreshUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/token scopes: {}