openapi: 3.0.3 info: title: Cash Management description: > Cash Management is used to manage your cash accounts, including banks, savings institutions, and charge cards—all in one centralized location. version: '1' servers: - url: https://api.intacct.com/ia/api/v1 tags: - name: Bank accounts description: >- This object provides information about a bank account, which can be a checking, savings, or a credit card account. x-displayName: Bank accounts - name: Bank transaction rule filters description: "Filters define which transactions a bank transaction rule considers when attempting to find a match. You can filter by Intacct transactions or bank transactions. For `match` rules, filters are optional. For `create` rules, a filter must be based on bank transaction posting dates. `Create` rules can only filter by bank transactions. \n" x-displayName: Bank transaction rule filters - name: Bank transaction rule groups description: "Grouping (optional) organizes transactions within a bank transaction rule. A rule first applies any defined filters. After filtering, the rule attempts to create a group. A rule can group either bank transactions or Intacct transactions. For `match` rules, only Intacct transactions can be grouped. \n" x-displayName: Bank transaction rule groups - name: Bank transaction rule maps description: A bank transaction rule map links a bank transaction rule to a rule set. x-displayName: Bank transaction rule maps - name: Bank transaction rule matches description: > Bank transaction rule matches, used within bank transaction rules, determine how incoming bank transactions are automatically matched to existing Intacct transactions. Incoming transactions may originate from a bank feed or an import file. x-displayName: Bank transaction rule matches - name: Bank transaction rule sets description: >- A rule set acts as a container for matching and creating rules. The rules determine how to match incoming bank transactions or create new transactions for reconciliation in Sage Intacct. x-displayName: Bank transaction rule sets - name: Bank transaction rules description: > Bank transaction rules determine whether incoming bank transactions are matched to existing Sage Intacct transactions or used to create new transactions. A `match` rule matches incoming bank transactions to existing Sage Intacct transactions. A `create` rule uses incoming bank transactions to create new Sage Intacct transactions. x-displayName: Bank transaction rules - name: Checking accounts description: > A checking account object models a real-world checking account at a bank and supports checking account reconciliation. x-displayName: Checking accounts - name: Credit card accounts description: > Sage Intacct defines credit card accounts as including both credit cards and debit cards. In Accounts Payable, there's a difference between the two. * A credit card is a cash account that's related to a credit card vendor. The credit card account in Sage Intacct represents the actual credit card in the real world. Record charges made on this card in the Cash Management application. * A debit card is associated with a checking account and is another way to debit that account. When a debit card charge is recorded, the bank account is debited and the transaction is final. Although treated differently in Accounts Payable, credit and debit cards are treated the same way in Accounts Receivable. A customer payment made with either type of credit card debits that customer account and deposits the payment into your account. x-displayName: Credit card accounts - name: Credit card transaction line templates description: > Credit card transaction line templates provide a predefined structure to standardize credit card transaction line items. x-displayName: Credit card transaction line templates - name: Credit card transaction lines description: >- Line items in a credit card transaction represent individual charges, adjustments or credits applied to credit and debit cards. Each line item contains detailed information such as amounts, currency, exchange rate, and tax information. x-displayName: Credit card transaction lines - name: Credit card transaction tax entries description: >- Tax entry details for VAT enabled credit card transactions, each line item will have applicable tax entry information. Providing multiple entries is allowed if the tax solution supports it (AU, GB, FR). For ZA, only one tax entry is allowed. x-displayName: Credit card transaction tax entries - name: Credit card transaction templates description: > Credit card transaction templates provide a predefined structure to standardize credit card transactions. By applying a transaction template to each credit card transaction, you ensure the transaction is recorded consistently, with fields such as payee and tax implications automatically populated. x-displayName: Credit card transaction templates - name: Credit card transactions description: > Credit card transaction records contain comprehensive details about each credit card transaction, for example payment amounts, exchange rate information and applicable taxes. Each record can contain multiple line items, each with individual amounts, currency information, payment amounts and tax details. x-displayName: Credit card transactions - name: Deposit details description: Line items in a deposit represent payments received from customers. x-displayName: Deposit details - name: Deposit lines description: Line items in a deposit represent payments received from customers. x-displayName: Deposit lines - name: Deposits description: > Transaction record for a deposit. A deposit captures the transfer of funds from a company's undeposited funds account to a bank account when collected and held payments are moved to a bank. To record a deposit, the payment must already be received against an undeposited funds account. For more information, see [About deposits](https://www.intacct.com/ia/docs/en_US/help_action/Accounts_Receivable/Deposits/about-deposits.htm). x-displayName: Deposits - name: Financial institutions description: > A financial institution serves as an umbrella object for bank accounts that use the same sign-in process to connect to bank feeds. x-displayName: Financial institutions - name: Funds transfer transaction lines description: >- Funds transfer transaction line items representing the general ledger postings generated by the funds transfer transaction. x-displayName: Funds transfer transaction lines - name: Funds transfer transactions description: >- Transaction that records the movement of funds from one cash account to another. Cash accounts include checking accounts and savings accounts. x-displayName: Funds transfer transactions - name: Journal entry line templates description: Template for journal entry lines. x-displayName: Journal entry line templates - name: Journal entry templates description: >- If using a creation rule for reconciliation, the rule needs to have a transaction template. Transaction templates define how to create new transactions in Sage Intacct based on bank data from an import file or bank feed. x-displayName: Journal entry templates - name: Other receipts lines description: >- Line items in an other receipts object represent transactions that are not associated with a customer or invoice. x-displayName: Other receipts lines - name: Other receipt tax entries description: >- For VAT enabled transactions, other receipt line items will have tax entries. Providing multiple entries is allowed if the tax solution supports it (AU, GB, FR). For ZA, only one tax entry is allowed. x-displayName: Other receipt tax entries - name: Other receipts description: >- Other receipts are receipts that are not associated with a customer or invoice. Other receipts can include cash, a card charge, a cash transfer, or a check payment. x-displayName: Other receipts - name: Payment provider bank accounts description: > Models the bank accounts associated with a payment provider for electronic payments. After the subscription status for a payment provider is Subscribed, you can add bank accounts for that payment provider. Subscribed status is set after your company's application has been received by the payment provider and all required paperwork has been signed. Payment provider services, like Vendor Payments powered by CSI, are only for US vendors accepting USD. See [Compare payment methods](https://www.intacct.com/ia/docs/en_US/help_action/Cash_Management/Payment_Methods/select-a-payment-method.htm) for more information. x-displayName: Payment provider bank accounts - name: Payment providers description: > Provides information about subscribed payment providers. For example, if an account includes a subscription to Vendor Payments powered by CSI, you can use these operations to retrieve information for that payment provider. Payment provider services, like Vendor Payments powered by CSI, are only for US vendors accepting USD. See [Compare payment methods](https://www.intacct.com/ia/docs/en_US/help_action/Cash_Management/Payment_Methods/select-a-payment-method.htm) for more information. x-displayName: Payment providers - name: Provider payment methods description: "Provides relevant information for a subscribed payment provider's supported payment methods. \nAfter confirming a payment provider's information, you can associate a vendor and a bank account with that payment provider. See [Payment provider bank accounts](/openapi/cm/payment-provider-bank-account/tag/Payment-provider-bank-accounts/#tag/Payment-provider-bank-accounts) and [Vendor payment providers](/openapi/ap/vendor-payment-provider/tag/Vendor-payment-providers/#tag/Vendor-payment-providers) to learn more.\nPayment provider services, like Vendor Payments powered by CSI, are only for US vendors accepting USD. See [Compare payment methods](https://www.intacct.com/ia/docs/en_US/help_action/Cash_Management/Payment_Methods/select-a-payment-method.htm) for more information. \n" x-displayName: Provider payment methods - name: Savings accounts description: >- Provides the relevant information for a savings account, including account ID, number, and so on. x-displayName: Savings accounts paths: /objects/cash-management/bank-account/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the bank account. example: '99' get: summary: Get a bank account description: Returns detailed information for a specified bank account. tags: - Bank accounts operationId: get-cash-management-bank-account-key responses: '200': description: OK content: application/json: schema: type: object title: Detail of the bank account properties: ia::result: $ref: '#/components/schemas/cash-management-bank-account' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get a bank account: value: ia::result: key: '29' referenceKey: '90' id: CITI name: CitiBank12 currency: USD accountType: checking connectionStatus: inProgress supportMultiAccountLinking: true financialInstitution: id: '8' key: '8' href: /objects/cash-management/financial-institution/8 href: /objects/cash-management/bank-account/29 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-filter: get: summary: List bank transaction rule filters description: >- Returns a collection of bank transaction rule filters with a key, ID, and link for each filter. 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: - Bank transaction rule filters operationId: list-cash-management-bank-txn-rule-filter responses: '200': description: OK content: application/json: schema: type: object title: List of bank transaction rule filters properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bank transaction rule filters: value: ia::result: - key: '25' id: '25' href: /objects/cash-management/bank-txn-rule-filter/25 - key: '57' id: '57' href: /objects/cash-management/bank-txn-rule-filter/57 - key: '85' id: '85' href: /objects/cash-management/bank-txn-rule-filter/85 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-filter/{key}: parameters: - name: key description: System-assigned unique key for the bank transaction rule filter. in: path required: true schema: type: string example: '8' example: '99' get: summary: Get a bank transaction rule filter description: >- Returns detailed information for a specified bank transaction rule filter. tags: - Bank transaction rule filters operationId: get-cash-management-bank-txn-rule-filter-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bank transaction rule filter properties: ia::result: $ref: '#/components/schemas/cash-management-bank-txn-rule-filter' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bank transaction rule filter: value: ia::result: key: '23' id: '23' bankTransactionRule: id: '17' key: '17' href: /objects/cash-management/bank-txn-rule/17 dataSource: bankTransaction intacctTxnAttribute: null bankTxnAttribute: transactionType operator: equals value: debit order: 2 href: /objects/cash-management/bank-txn-rule-filter/110 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-group: get: summary: List bank transaction rule groups description: >- Returns a collection of bank transaction rule groups with a key, ID, and link for each group. tags: - Bank transaction rule groups operationId: list-cash-management-bank-txn-rule-group responses: '200': description: OK content: application/json: schema: type: object title: List of bank transaction rule groups properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bank transaction rule groups: value: ia::result: - key: '9' id: '9' href: /objects/cash-management/bank-txn-rule-group/9 - key: '21' id: '21' href: /objects/cash-management/bank-txn-rule-group/21 - key: '35' id: '35' href: /objects/cash-management/bank-txn-rule-group/35 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-group/{key}: parameters: - name: key description: System-assigned key for the bank transaction rule group. in: path required: true schema: type: string example: '9' example: '99' get: summary: Get a bank transaction rule group description: >- Returns detailed information for a specified bank transaction rule group. tags: - Bank transaction rule groups operationId: get-cash-management-bank-txn-rule-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bank transaction rule group properties: ia::result: $ref: '#/components/schemas/cash-management-bank-txn-rule-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bank transaction rule group attribute: value: ia::result: key: '27' id: '27' bankTransactionRule: id: '21' key: '21' href: /objects/cash-management/bank-txn-rule/21 dataSource: intacctTransaction intacctTxnAttribute: documentNumber bankTxnAttribute: null order: 1 href: /objects/cash-management/bank-txn-rule-group/27 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-map: get: summary: List bank transaction rule maps description: >- Returns a collection with a key, ID, and link for each bank transaction rule map. tags: - Bank transaction rule maps operationId: list-cash-management-bank-txn-rule-map responses: '200': description: OK content: application/json: schema: type: object title: List bank transaction rule maps properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bank transaction rule maps: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/bank-txn-rule-map/1 - key: '26' id: '26' href: /objects/cash-management/bank-txn-rule-map/26 - key: '182' id: '182' href: /objects/cash-management/bank-txn-rule-map/182 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-map/{key}: parameters: - name: key description: System-assigned unique key for the bank transaction rule map. in: path required: true schema: type: string example: '6' example: '99' get: summary: Get a bank transaction rule map description: Returns detailed information for a specified bank transaction rule map. tags: - Bank transaction rule maps operationId: get-cash-management-bank-txn-rule-map-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bank-txn-rule-map properties: ia::result: $ref: '#/components/schemas/cash-management-bank-txn-rule-map' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bank transaction rule map: value: ia::result: id: '2' key: '2' bankTxnRule: id: '28' key: '28' ruleId: Match_Amt_Plus_Date_Range name: Match amount plus 2 day range ruleType: create href: /objects/cash-management/bank-txn-rule/28 bankTxnRuleSet: id: '2' key: '2' href: /objects/cash-management/bank-txn-rule-set/2 ruleOrder: 2 audit: createdDateTime: '2025-03-27T00:00:00Z' modifiedDateTime: '2025-03-27T00:00:00Z' createdByUser: key: '159' href: /objects/company-config/user/159 createdBy: '159' modifiedByUser: key: '159' href: /objects/company-config/user/159 modifiedBy: '159' href: /objects/cash-management/bank-txn-rule-map/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a bank transaction rule map description: Deletes a bank transaction rule map. tags: - Bank transaction rule maps operationId: delete-cash-management-bank-txn-rule-map-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-match: get: summary: List bank transaction rule matches description: >- Returns a collection of bank transaction rule match entries with a key, ID, and link for each match entry. tags: - Bank transaction rule matches operationId: list-cash-management-bank-txn-rule-match responses: '200': description: OK content: application/json: schema: type: object title: List bank transaction rule match entries properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bank transaction rule matches: value: ia::result: - key: '97' id: '97' href: /objects/cash-management/bank-txn-rule-match/97 - key: '100' id: '100' href: /objects/cash-management/bank-txn-rule-match/100 - key: '104' id: '104' href: /objects/cash-management/bank-txn-rule-match/104 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-match/{key}: parameters: - name: key description: System-assigned unique key for the bank transaction rule match entry. in: path required: true schema: type: string example: '11' example: '99' get: summary: Get a bank transaction rule match entry description: >- Returns detailed information for a specified bank transaction rule match entry. tags: - Bank transaction rule matches operationId: get-cash-management-bank-txn-rule-match-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bank transaction rule match entry properties: ia::result: $ref: '#/components/schemas/cash-management-bank-txn-rule-match' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bank transaction rule match entry: value: ia::result: key: '28' id: '28' bankTransactionRule: id: '21' key: '21' href: /objects/cash-management/bank-txn-rule/21 intacctTxnAttribute: amount bankTxnAttribute: amount operator: equals value: '100' order: 2 href: /objects/cash-management/bank-txn-rule-match/28 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-set: get: summary: List bank transaction rule sets description: >- Returns a collection with a key, ID, and link for each rules. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Bank transaction rule sets responses: '200': description: OK content: application/json: schema: type: object title: List of Rule set objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bank transaction rule sets: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/bank-txn-rule-set/1 - key: '2' id: '2' href: /objects/cash-management/bank-txn-rule-set/2 - key: '3' id: '3' href: /objects/cash-management/bank-txn-rule-set/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' operationId: list-cash-management-bank-txn-rule-set security: - OAuth2: [] post: summary: Create a bank transaction rule set description: Creates a new bank transaction rule set. tags: - Bank transaction rule sets operationId: create-cash-management-bank-txn-rule-set requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-bank-txn-rule-set' - $ref: '#/components/schemas/cash-management-bank-txn-rule-setRequiredProperties' examples: Create a bank transaction rule set: value: ruleSetId: Txn-Rule-Set-004 name: MBB Rule Set description: Primary rule set for MBB accountType: creditcard location: key: '1' status: active responses: '201': description: Created rule set content: application/json: schema: type: object title: New bank-txn-rule-set properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a bank transaction rule set: value: ia::result: key: '5' id: '5' href: /objects/cash-management/bank-txn-rule-set/5 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule-set/{key}: parameters: - schema: type: string example: '11' name: key in: path required: true description: System-assigned key for the bank transaction rule set. example: '99' get: summary: Get a bank transaction rule set description: Returns detailed information for a specified bank transaction rule set. tags: - Bank transaction rule sets operationId: get-cash-management-bank-txn-rule-set-key responses: '200': description: OK content: application/json: schema: type: object title: Detail of the rule set properties: ia::result: $ref: '#/components/schemas/cash-management-bank-txn-rule-set' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get a bank transaction rule set: value: ia::result: id: '2' key: '2' ruleSetId: BankRuleSetChase name: Rule set for chase bank description: Primary rule set for CB accountType: bank numberOfAccounts: 7 numberOfRules: 1 status: active location: key: '5' audit: createdDateTime: '2022-01-26T00:15:14Z' modifiedDateTime: '2023-03-24T21:41:10Z' createdBy: '68' modifiedBy: '68' entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 rules: - id: '26' key: '26' bankTxnRule: id: '11' key: '11' ruleId: gl-create-rule-2 name: gl-create-rule-2 ruleType: create href: /objects/cash-management/bank-txn-rule/11 bankTxnRuleSet: id: '2' key: '2' href: /objects/cash-management/bank-txn-rule-set/2 ruleOrder: 1 audit: createdDateTime: '2023-03-24T00:00:00Z' modifiedDateTime: '2023-03-24T00:00:00Z' createdBy: '68' modifiedBy: '68' href: /objects/cash-management/bank-txn-rule-map/26 href: /objects/cash-management/bank-txn-rule-set/2 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a bank transaction rule set description: > Updates an existing bank transaction rule set by setting field values. Any fields not provided remain unchanged. Updating a rule set affects matches for incoming transactions going forward for every associated account that uses the rule set. Updating a rule set does not affect transactions that have already been matched. tags: - Bank transaction rule sets operationId: update-cash-management-bank-txn-rule-set-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-bank-txn-rule-set' - type: object properties: id: readOnly: true examples: Update a single value: value: status: inactive description: '' responses: '200': description: OK content: application/json: schema: type: object title: Updated bank-txn-rule-set properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a bank transaction rule set: value: ia::result: key: '4' id: '4' href: /objects/cash-management/bank-txn-rule-set/4 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a bank transaction rule set description: Deletes a bank transaction rule set. tags: - Bank transaction rule sets operationId: delete-cash-management-bank-txn-rule-set-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule: get: summary: List bank transaction rules description: >- Returns a collection of bank transaction rules with a key, ID, and link for each rule. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Bank transaction rules operationId: list-cash-management-bank-txn-rule responses: '200': description: OK content: application/json: schema: type: object title: List of bank-txn-rule objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List bank transaction rules: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/bank-txn-rule/1 - key: '3' id: '3' href: /objects/cash-management/bank-txn-rule/3 - key: '4' id: '4' href: /objects/cash-management/bank-txn-rule/4 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a bank transaction rule description: Creates a new bank transaction rule. tags: - Bank transaction rules operationId: create-cash-management-bank-txn-rule requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-bank-txn-rule' - $ref: '#/components/schemas/cash-management-bank-txn-ruleRequiredProperties' examples: Create a bank transaction rule to add Journal Entry: value: ruleId: GL-JE-157 description: Rule to create journal entry. name: Create Journal Entry rule ruleType: create createRuleObject: objectType: journalEntry journalEntryTemplate: id: '3' filterAttributes: - dataSource: bankTransaction bankTxnAttribute: postingDate operator: greaterThan value: 01/03/2025 order: 1 - dataSource: bankTransaction bankTxnAttribute: transactionType operator: equals value: debit order: 2 Create a match bank transaction rule: value: ruleId: BOA-DOC-AMT-MATCH-003 description: Match rule for BOA accounts by document number. name: BOA match by amount and doc no. ruleType: match matchRuleAttributes: - intacctTxnAttribute: amount bankTxnAttribute: amount operator: equals order: 2 - intacctTxnAttribute: documentNumber bankTxnAttribute: documentNumber operator: equals order: 1 filterAttributes: - dataSource: intacctTransaction intacctTxnAttribute: documentNumber operator: equals value: DOC-1002 order: 1 Create a bank transaction rule to add CC txn: value: ruleId: CC-TXN-234 name: Create CC txn from bank txn description: >- Rule to create credit card transaction from bank transaction. ruleType: create location: id: '1' createRuleObject: objectType: cctransaction creditCardTxnTemplate: id: '3' filterAttributes: - dataSource: bankTransaction bankTxnAttribute: postingDate operator: greaterThan value: 07/03/2025 order: 1 responses: '201': description: Created content: application/json: schema: type: object title: New bank-txn-rule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Create a bank transaction rule: value: ia::result: key: '15' id: '15' href: /objects/cash-management/bank-txn-rule/15 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/bank-txn-rule/{key}: parameters: - name: key description: System-assigned key for the bank transaction rule. in: path required: true schema: type: string example: '11' example: '99' get: summary: Get a bank transaction rule description: Returns detailed information for a specified bank transaction rule. tags: - Bank transaction rules operationId: get-cash-management-bank-txn-rule-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the bank transaction rule properties: ia::result: $ref: '#/components/schemas/cash-management-bank-txn-rule' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bank transaction create rule: value: ia::result: id: '79' key: '79' ruleId: BOA-CC-TXN-2119 name: BOA Create CC txn from bank txn description: BOA rule to create CC txn from bank txn. ruleType: create createRuleObject: objectType: journalEntry journalEntryTemplate: id: '3' key: '3' href: /objects/cash-management/journal-entry-template/3 creditCardTxnTemplate: id: null key: null status: active location: key: null rulesetCount: 0 audit: createdDateTime: '2025-03-27T16:13:03Z' modifiedDateTime: '2025-03-27T16:13:03Z' createdByUser: key: '159' href: /objects/company-config/user/159 createdBy: '159' modifiedByUser: key: '159' href: /objects/company-config/user/159 modifiedBy: '159' entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 filterAttributes: - id: '81' key: '81' bankTransactionRule: id: '79' key: '79' href: /objects/cash-management/bank-txn-rule/79 dataSource: bankTransaction intacctTxnAttribute: null bankTxnAttribute: postingDate operator: greaterThan value: 07/03/2025 order: 1 href: /objects/cash-management/bank-txn-rule-filter/81 - id: '82' key: '82' bankTransactionRule: id: '79' key: '79' href: /objects/cash-management/bank-txn-rule/79 dataSource: bankTransaction intacctTxnAttribute: null bankTxnAttribute: transactionType operator: equals value: debit order: 1 href: /objects/cash-management/bank-txn-rule-filter/82 groupAttributes: [] matchRuleAttributes: [] href: /objects/cash-management/bank-txn-rule/79 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Get a match bank transaction rule: value: ia::result: id: '28' key: '28' ruleId: Match_Amt_Plus_Date_Range name: Match amount plus date range description: Match amount and 2 days range ruleType: match createRuleObject: objectType: journalEntry journalEntryTemplate: id: '3' key: '3' href: /objects/cash-management/journal-entry-template/3 creditCardTxnTemplate: id: null key: null status: active location: key: null rulesetCount: 0 audit: createdDateTime: '2025-03-27T16:24:18Z' modifiedDateTime: '2025-03-27T16:24:18Z' createdByUser: key: '159' href: /objects/company-config/user/159 createdBy: '159' modifiedByUser: key: '159' href: /objects/company-config/user/159 modifiedBy: '159' filterAttributes: - id: '36' key: '36' bankTransactionRule: id: '28' key: '28' href: /objects/cash-management/bank-txn-rule/28 dataSource: bankTransaction intacctTxnAttribute: null bankTxnAttribute: postingDate operator: greaterThan value: 01/03/2025 order: 1 href: /objects/cash-management/bank-txn-rule-filter/36 - id: '37' key: '37' bankTransactionRule: id: '28' key: '28' href: /objects/cash-management/bank-txn-rule/28 dataSource: bankTransaction intacctTxnAttribute: null bankTxnAttribute: transactionType operator: equals value: debit order: 2 href: /objects/cash-management/bank-txn-rule-filter/37 groupAttributes: [] matchRuleAttributes: - id: '33' key: '33' bankTransactionRule: id: '28' key: '28' href: /objects/cash-management/bank-txn-rule/28 intacctTxnAttribute: amount bankTxnAttribute: amount operator: equals value: '100' order: 1 href: /objects/cash-management/bank-txn-rule-match/33 - id: '34' key: '34' bankTransactionRule: id: '28' key: '28' href: /objects/cash-management/bank-txn-rule/28 intacctTxnAttribute: postingDate bankTxnAttribute: postingDate operator: within value: '2' order: 2 href: /objects/cash-management/bank-txn-rule-match/34 href: /objects/cash-management/bank-txn-rule/28 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a bank transaction rule description: >- Updates an existing bank transaction rule by setting field values. Any fields not provided remain unchanged. tags: - Bank transaction rules operationId: update-cash-management-bank-txn-rule-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-bank-txn-rule' - type: object properties: id: readOnly: true examples: Update a bank transaction rule: value: matchRuleAttributes: - key: '33' order: 2 - key: '34' intacctTxnAttribute: postingDate bankTxnAttribute: postingDate operator: within value: '4' order: 1 responses: '200': description: OK content: application/json: schema: type: object title: Updated bank-txn-rule properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Update a bank transaction rule: value: ia::result: key: '28' id: '28' href: /objects/cash-management/bank-txn-rule/28 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a bank transaction rule description: Deletes a bank transaction rule. tags: - Bank transaction rules operationId: delete-cash-management-bank-txn-rule-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/checking-account/{key}: parameters: - name: key description: System-assigned key for the checking account. in: path required: true schema: type: string example: '99' get: summary: Get a checking account description: Returns detailed information for a specified checking account. tags: - Checking accounts operationId: get-cash-management-checking-account-key responses: '200': description: OK content: application/json: schema: type: object title: Checking account details properties: ia::result: $ref: '#/components/schemas/cash-management-checking-account' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get a checking account: value: ia::result: id: BOA-000987g bankAccountDetails: accountNumber: '890000088' bankName: Bank of America routingNumber: '123456789' branchId: 00-1355 phoneNumber: '9007780000' bankAddress: addressLine1: '40714' addressLine2: Grimmer Blvd addressLine3: null city: Fremont country: United States postCode: '98765' state: CA currency: GBP accountHolderName: ACME Software accounting: glAccount: id: 9090.09.90--RestNextGenGL key: '584' name: RestNextGenGL href: /objects/general-ledger/account/584 apJournal: id: AR ADJ--AR Adjustment Journal key: '17' href: /objects/general-ledger/journal/17 arJournal: id: CHASE D--CHASE BANK DISB key: '12' href: /objects/general-ledger/journal/12 bankingTimeZone: GMT+05:30 Bombay, Calcutta, Madras, New Delhi serviceChargeGLAccount: key: null id: null serviceChargeAccountLabel: key: '15' id: Car Payment href: /objects/accounts-payable/account-label/15 interestGLAccount: key: null id: null interestAccountLabel: key: null id: null disableInterEntityTransfer: false checkPrinting: addressSettings: addressToPrint: company printAddress: true printLogo: true address: addressLine1: 75688 Post st addressLine2: '456' addressLine3: null city: San Jose country: United States countryCode: US postCode: '94536' state: CA phone: '6609336532' name: Zine Inc. micrSettings: regionalSettings: positionOfOnUsSymbol: position31 printCode45: true printOnUsSymbol: true printUSFundsUnderCheckAmount: false accountNumberAlignment: right accountNumberPositioning: 1 minCheckNumberLength: '6' printSettings: additionalText: Pay to check holder paperFormat: top printLineItems: true printLocation: id printingFormat: standard nextCheckNumber: '1012' numberOfChecksInPreview: one printOn: blankCheckStock signatures: firstSignature: sigimg1_g.gif limitForFirstSignatureAmount: null limitForSecondSignatureAmount: null secondSignature: sigimg2_g.gif thresholdForSecondSignatureAmount: '99.00' disablePrinting: false reconciliation: matchSequence: key: '48' id: 48--bankseq-1 href: /objects/company-config/document-sequence/48 useMatchSequenceForAutoMatch: true useMatchSequenceForManualMatch: true lastReconciledBalance: null lastReconciledDate: null cutOffDate: null inProgressBalance: null inProgressDate: null department: key: '9' id: 11--Accounting href: /objects/company-config/department/9 location: key: '1' id: 1--United States of America href: /objects/company-config/location/1 status: active audit: createdDateTime: '2024-03-07T19:39:43Z' modifiedDateTime: '2024-03-07T19:39:43Z' createdBy: '1' modifiedBy: '1' entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 key: '291' ach: bankId: null companyName: null companyIdentification: null originatingFinancialInstitution: null companyEntryDescription: null companyDiscretionaryData: null recordTypeCode: '5' serviceClassCode: '220' originatorStatusCode: '1' batchId: null traceNumberSequence: null paymentNumberSequence: null useTraceNumber: useAsPayment enableACH: null useRecommendedSetup: null bankingCloudConnection: status: notConnected bankName: null name: null lastBankTxnDateTime: null lastRefreshedDateTime: null refreshStatus: null supportMultiAccountLinking: null bankFile: enableBankFile: null bankFileFormat: null bankCode: null apcaNumber: null sunNumber: null bsbNumber: null sortCode: null seedValue: null userReference: null clientCode: null serviceType: null originatorId: null businessIdCode: null processingDataCenterCode: null debtorBankNumber: null returnAccountNumber: null branchTransitNumber: null messageIdPrefix: null financialInstitution: key: null id: null ruleSet: id: 53--MatchDateAmountGrpbyDateRuleSet key: '53' name: MatchDateAmountGrpbyDateRuleSet href: /objects/cash-management/bank-txn-rule-set/53 paymentProviderBankAccounts: [] href: /objects/cash-management/checking-account/291 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Get a checking account enabled for bank files for United States (US): value: ia::result: id: USBankfileAccount001 bankAccountDetails: accountNumber: '890000088' bankName: Bank of America routingNumber: '123456789' branchId: 6578 phoneNumber: '9007780000' bankAddress: addressLine1: '40714' addressLine2: Grimmer Blvd addressLine3: null city: Fremont country: United States postCode: '98765' state: CA currency: GBP accountHolderName: ACME Software accounting: glAccount: id: 9090.09.90--RestNextGenGL key: '584' href: /objects/general-ledger/account/584 apJournal: id: AR ADJ--AR Adjustment Journal key: '17' href: /objects/general-ledger/journal/17 arJournal: id: CHASE D--CHASE BANK DISB key: '12' href: /objects/general-ledger/journal/12 bankingTimeZone: GMT+05:30 Bombay, Calcutta, Madras, New Delhi serviceChargeGLAccount: key: null id: null serviceChargeAccountLabel: key: '15' id: Car Payment href: /objects/accounts-payable/account-label/15 interestGLAccount: key: null id: null interestAccountLabel: key: null id: null disableInterEntityTransfer: false checkPrinting: addressSettings: addressToPrint: company printAddress: true printLogo: true address: addressLine1: 75688 Post st addressLine2: '456' addressLine3: null city: San Jose country: United States countryCode: US postCode: '94536' state: CA phone: '6609336532' name: Zine Inc. micrSettings: regionalSettings: positionOfOnUsSymbol: position31 printCode45: true printOnUsSymbol: true printUSFundsUnderCheckAmount: false accountNumberAlignment: right accountNumberPositioning: 1 minCheckNumberLength: '6' printSettings: additionalText: Pay to check holder paperFormat: top printLineItems: true printLocation: id printingFormat: standard nextCheckNumber: '1012' numberOfChecksInPreview: one printOn: blankCheckStock signatures: firstSignature: sigimg1_g.gif limitForFirstSignatureAmount: null limitForSecondSignatureAmount: null secondSignature: sigimg2_g.gif thresholdForSecondSignatureAmount: '99.00' disablePrinting: false reconciliation: matchSequence: key: '48' id: 48--bankseq-1 href: /objects/company-config/document-sequence/48 useMatchSequenceForAutoMatch: true useMatchSequenceForManualMatch: true lastReconciledBalance: null lastReconciledDate: null cutOffDate: null inProgressBalance: null inProgressDate: null department: key: '9' id: 11--Accounting href: /objects/company-config/department/9 location: key: '1' id: 1--United States of America href: /objects/company-config/location/1 status: active audit: createdDateTime: '2024-03-07T19:39:43Z' modifiedDateTime: '2024-03-07T19:39:43Z' createdBy: '1' modifiedBy: '1' entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 key: '291' ach: bankId: null companyName: null companyIdentification: null originatingFinancialInstitution: null companyEntryDescription: null companyDiscretionaryData: null recordTypeCode: '5' serviceClassCode: '220' originatorStatusCode: '1' batchId: null traceNumberSequence: null paymentNumberSequence: null useTraceNumber: useAsPayment enableACH: null useRecommendedSetup: null bankingCloudConnection: status: notConnected bankName: null name: null lastBankTxnDateTime: null lastRefreshedDateTime: null refreshStatus: null supportMultiAccountLinking: null bankFile: enableBankFile: true bankFileFormat: NACHA - Unbalanced bankCode: null apcaNumber: null sunNumber: null bsbNumber: null sortCode: null seedValue: null userReference: null clientCode: null serviceType: null originatorId: null businessIdCode: null processingDataCenterCode: null debtorBankNumber: null returnAccountNumber: null branchTransitNumber: null messageIdPrefix: null immediateDestinationId: '984569845' immediateOriginId: '878767675' immediateDestinationName: BOA immediateOriginName: Investment corp companyName: Ventura paymentNumberSequence: '0000006' fileIdSequence: E companyEntryDescription: Investment postalAddress: addressLine1: 75688 Post st addressLine2: Suite 100 postalCode: '94536' county: North Yorkshire country: GB financialInstitution: key: null id: null ruleSet: id: null key: null paymentProviderBankAccounts: [] href: /objects/cash-management/checking-account/143 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a checking account description: Creates a new checking account. tags: - Checking accounts operationId: post-objects-checking-account requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-checking-account' - $ref: '#/components/schemas/cash-management-checking-accountRequiredProperties' examples: Create checking account: value: id: BOA bankAccountDetails: accountNumber: '890000088' bankName: Bank of America routingNumber: '123456789' branchId: 00-1355 phoneNumber: '9007780000' bankAddress: addressLine1: '40714' addressLine2: Grimmer Blvd addressLine3: West Cameron city: Fremont country: United States postCode: '98765' state: CA currency: USD accountHolderName: ACME Software accounting: glAccount: id: 9090.09.90--RestNextGenGL apJournal: id: AR ADJ--AR Adjustment Journal arJournal: id: RCPT--Receipts Journal bankingTimeZone: GMT+02:00 Central Europe Summer Time serviceChargeAccountLabel: key: '15' interestAccountLabel: id: Sales disableInterEntityTransfer: false checkPrinting: addressSettings: addressToPrint: company printAddress: true printLogo: true address: addressLine1: 75688 Post st addressLine2: '456' addressLine3: West Cameron city: San Jose country: United States countryCode: US postCode: '94536' state: CA phone: '6609336532' name: Zine Inc. micrSettings: regionalSettings: positionOfOnUsSymbol: position31 printCode45: true printOnUsSymbol: true printUSFundsUnderCheckAmount: false accountNumberAlignment: right accountNumberPositioning: 1 minCheckNumberLength: '6' printSettings: additionalText: Pay to check holder paperFormat: top printLineItems: true printLocation: id printingFormat: standard nextCheckNumber: '1012' numberOfChecksInPreview: One printOn: blankCheckStock signatures: firstSignature: sigimg1_g.gif limitForFirstSignatureAmount: '20' limitForSecondSignatureAmount: '30' secondSignature: sigimg2_g.gif thresholdForSecondSignatureAmount: '99.00' disablePrinting: false reconciliation: matchSequence: key: '48' useMatchSequenceForAutoMatch: true useMatchSequenceForManualMatch: true ach: bankId: ACH-1 companyName: origin companyIdentification: originid originatingFinancialInstitution: '8909' companyEntryDescription: entry desc companyDiscretionaryData: disc serviceClassCode: '220' batchId: BOA_ACH_BatchNo traceNumberSequence: BOA_ACH_TraceNo paymentNumberSequence: CONTINVOICE useTraceNumber: T enableACH: true useRecommendedSetup: true ruleSet: key: '53' id: MatchDateAmountGrpbyDateRuleSet restrictions: restrictionType: restricted locations: - 1--United States of America - 200--My New Entity location: key: '1' id: 1--United States of America responses: '201': description: Created checking account content: application/json: schema: type: object title: New checking-account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New checking account: value: id: BOA-000987g bankAccountDetails: accountNumber: '890000088' bankName: Bank of America routingNumber: '123456789' branchId: 00-1355 phoneNumber: '9007780000' bankAddress: addressLine1: '40714' addressLine2: Grimmer Blvd addressLine3: null city: Fremont country: United States postCode: '98765' state: CA currency: GBP accountHolderName: ACME Software accounting: glAccount: id: 9090.09.90--RestNextGenGL apJournal: id: AR ADJ--AR Adjustment Journal arJournal: id: CHASE D--CHASE BANK DISB bankingTimeZone: GMT+05:30 Bombay, Calcutta, Madras, New Delhi serviceChargeAccountLabel: key: '15' interestAccountLabel: id: Sales disableInterEntityTransfer: false checkPrinting: addressSettings: addressToPrint: company printAddress: true printLogo: true address: addressLine1: 75688 Post st addressLine2: '456' addressLine3: null city: San Jose country: United States countryCode: US postCode: '94536' state: CA phone: '6609336532' name: Zine Inc. micrSettings: regionalSettings: positionOfOnUsSymbol: position31 printCode45: true printOnUsSymbol: true printUSFundsUnderCheckAmount: false accountNumberAlignment: right accountNumberPositioning: 1 minCheckNumberLength: '6' printSettings: additionalText: Pay to check holder paperFormat: top printLineItems: true printLocation: id printingFormat: standard nextCheckNumber: '1012' // "printPreview": One printOn: blankCheckStock signatures: firstSignature: sigimg1_g.gif limitForFirstSignatureAmount: null limitForSecondSignatureAmount: null secondSignature: sigimg2_g.gif thresholdForSecondSignatureAmount: '99.00' disablePrinting: false reconciliation: matchSequence: key: '48' useMatchSequenceForAutoMatch: true useMatchSequenceForManualMatch: true department: id: 11--Accounting location: id: 1--United States of America security: - OAuth2: [] patch: summary: Update a checking account description: >- Updates an existing checking account by setting field values. Any fields not provided remain unchanged. tags: - Checking accounts operationId: patch-objects-checking-account requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-checking-account' - type: object properties: id: readOnly: true examples: Modifying a few fields: value: bankAccountDetails: bankName: Bank of America New ruleSet: key: '53' id: MatchDateAmountGrpbyDateRuleSet restrictions: restrictionType: unrestricted locations: [] reconciliation: matchSequence: key: '48' useMatchSequenceForAutoMatch: true useMatchSequenceForManualMatch: true responses: '201': description: Updated checking account content: application/json: schema: type: object title: New checking-account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' security: - OAuth2: [] delete: summary: Delete a checking account description: Deletes a checking account. tags: - Checking accounts operationId: delete-objects-checking-account responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/checking-account: get: summary: List checking accounts description: > Returns up to 100 object references from the collection with a key, ID, and link for each checking account. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Checking accounts operationId: list-cash-management-checking-account responses: '200': description: OK content: application/json: schema: type: object title: List of Checking accounts properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List checking accounts: value: ia::result: - key: '84' id: AUDCHK href: /objects/cash-management/checking-account/84 - key: '85' id: BDF href: /objects/cash-management/checking-account/85 - key: '60' id: BOA href: /objects/cash-management/checking-account/60 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-account: get: summary: List credit card accounts description: >- Returns a collection with a key, ID, and link for each credit card account. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Credit card accounts operationId: list-cash-management-credit-card-account responses: '200': description: OK content: application/json: schema: type: object title: List of credit card account objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List credit card accounts: value: ia::result: - key: '1' id: MC001 href: /objects/cash-management/credit-card-account/1 - key: '2' id: MC002 href: /objects/cash-management/credit-card-account/2 - key: '3' id: AMEX_CARD_1 href: /objects/cash-management/credit-card-account/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a credit card account description: Creates a new credit card account. tags: - Credit card accounts operationId: post-objects-credit-card-account requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-credit-card-account' - $ref: '#/components/schemas/cash-management-credit-card-accountRequiredProperties' examples: Create a credit card account: value: id: V002 accountDetails: description: Card for employee expense cardType: visa expirationMonth: '01' expirationYear: '2028' billingAddress: addressLine1: '1295' addressLine2: null addressLine3: Adobe Ave city: San Jose country: United States countryCode: US postCode: '978754' state: CA accountType: credit currency: USD status: active accounting: offsetGLAccount: id: 4564.44.44 key: '561' otherFeesGLAccount: id: '0077' key: '432' defaultAccrualBasisGLJournal: id: DISB key: '14' disableInterEntityTransfer: false vendor: id: First Security - Gold key: '263' department: id: CHS--Channel Sales key: '34' location: id: San Francisco reconciliation: matchSequence: id: 48--bankseq-1 useMatchSequenceForAutoMatch: true useMatchSequenceForManualMatch: true ruleSet: key: '35' id: 35--creditcard responses: '201': description: Created content: application/json: schema: type: object title: New credit card account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new credit card account object: value: ia::result: key: '34' id: V002 href: /objects/cash-management/credit-card-account/34 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 security: - OAuth2: [] /objects/cash-management/credit-card-account/{key}: parameters: - schema: type: string example: '81' name: key in: path required: true description: System-assigned key for the credit card account. example: '99' get: summary: Get a credit card account description: Returns detailed information for a specified credit card account. tags: - Credit card accounts operationId: get-cash-management-credit-card-account-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the credit card account properties: ia::result: $ref: '#/components/schemas/cash-management-credit-card-account' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get a credit card account: value: ia::result: key: '106' id: V002 accountDetails: description: card for employee expense cardType: visa expirationMonth: '01' expirationYear: '2028' billingAddress: addressLine1: '1295' addressLine2: null addressLine3: Adobe Ave city: San Jose country: United States countryCode: US postCode: '978754' state: CA accountType: credit debitCardCheckingAccount: id: null key: null currency: USD status: active accounting: offsetGLAccount: id: '8907.89' key: '589' href: /objects/general-ledger/account/589 otherFeesGLAccount: id: '6700.01' key: '323' href: /objects/general-ledger/account/323 defaultAccrualBasisGLJournal: id: DISB key: '14' href: /objects/general-ledger/journal/14 defaultCashBasisGLJournal: id: null key: null bankingTimeZone: GMT+01:00 Berlin, Stockholm, Rome, Bern, Brussels disableInterEntityTransfer: false otherFeesAPAccountLabel: id: Bank Service Charge key: '11' href: /objects/accounts-payable/account-label/11 financeChargeGLAccount: id: '6700.02' key: '324' href: /objects/general-ledger/account/324 financeChargeAPAccountLabel: id: Bank Interest Earned key: '10' href: /objects/accounts-payable/account-label/10 useInEmployeeExpense: true employeeExpenseGLAccount: key: '287' id: '6800.03' href: /objects/general-ledger/account/287 employeeExpenseAccountLabel: id: Gas and Electric key: '23' href: /objects/accounts-payable/account-label/23 vendor: id: First Security - Gold key: '35' href: /objects/accounts-payable/vendor/35 department: id: COMP--Compliance key: '16' href: /objects/company-config/department/16 location: id: San Francisco key: '24' href: /objects/company-config/location/24 reconciliation: lastReconciledDate: null lastReconciledBalance: null inProgressDate: null inProgressBalance: null matchSequence: key: '48' id: 48--bankseq-1 href: /objects/company-config/document-sequence/48 useMatchSequenceForAutoMatch: true useMatchSequenceForManualMatch: true cutOffDate: null entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 audit: modifiedDateTime: '2024-03-12T23:46:56Z' createdDateTime: '2024-03-04T20:33:04Z' modifiedBy: '1' createdBy: '1' bankingCloudConnection: status: null bankName: null name: null lastBankTxnDateTime: null lastRefreshedDateTime: null refreshStatus: null supportMultiAccountLinking: null financialInstitution: key: null id: null ruleSet: id: 35--creditcard key: '35' href: /objects/cash-management/bank-txn-rule-set/35 href: /objects/cash-management/credit-card-account/106 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a credit card account description: >- Updates an existing credit card account by setting field values. Any fields not provided remain unchanged. tags: - Credit card accounts operationId: patch-objects-credit-card-account requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-credit-card-account' - type: object properties: id: readOnly: true examples: Update a credit card account: value: accountDetails: description: Card for employee expenses expirationMonth: '01' expirationYear: '2030' responses: '200': description: OK content: application/json: schema: type: object title: Updated credit card account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated credit card account: value: ia::result: key: '32' id: V002 href: /objects/cash-management/credit-card-account/32 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 security: - OAuth2: [] delete: summary: Delete a credit card account description: >- Deletes a credit card account. You cannot delete a credit card account that has subledger transactions associated with it. tags: - Credit card accounts operationId: delete-cash-management-credit-card-account-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn-line-template: get: summary: List credit card transaction line templates description: >- Returns a collection of credit card transaction line templates with a key, ID, and link for each 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: - Credit card transaction line templates operationId: list-cash-management-credit-card-txn-line-template responses: '200': description: OK content: application/json: schema: type: object title: List of credit card transaction line templates properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List credit card transaction line templates: value: ia::result: - key: '3' id: '3' href: '/objects/cash-management/credit-card-txn-line-template/3' - key: '6' id: '6' href: '/objects/cash-management/credit-card-txn-line-template/6' - key: '2' id: '2' href: '/objects/cash-management/credit-card-txn-line-template/2' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn-line-template/{key}: parameters: - name: key description: >- System-assigned unique key for the credit card transaction line template. in: path required: true schema: type: string example: '5' example: '99' get: summary: Get a credit card transaction line template description: >- Returns detailed information for a specified credit card transaction line template. tags: - Credit card transaction line templates operationId: get-cash-management-credit-card-txn-line-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the credit card transaction line template properties: ia::result: $ref: '#/components/schemas/cash-management-credit-card-txn-line-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a credit card transaction line template: value: ia::result: key: '98' id: '98' creditCardTxnTemplate: key: '117' href: /objects/cash-management/credit-card-txn-template/117 memo: Credit card transaction template 98 glAccount: key: '339' id: '7505.06' name: CC Other Charges & Fees href: /objects/general-ledger/account/339 dimensions: location: id: '7' name: Canada project: key: '11' id: CON name: Contract - QuickMedia M C Services href: /objects/projects/project/11 customer: key: '5' id: MR1 name: QuickMedia M C Services href: /objects/accounts-receivable/customer/5 vendor: key: '50' id: '204' name: Bridge Water Garden Supply href: /objects/accounts-payable/vendor/50 employee: key: '29' id: '234' name: Judith Reeves href: /objects/company-config/employee/29 item: key: '1' id: '1' name: PC Computer href: /objects/inventory-control/item/1 class: key: '9' id: REAL_EST_009 name: Real Estate href: /objects/company-config/class/9 lineNumber: 1 accountLabel: id: CC Other Fees exchangeRate: date: null typeId: null rate: null isBillable: null audit: createdDateTime: '2025-03-27T15:40:34Z' modifiedDateTime: '2025-03-27T15:40:34Z' createdByUser: key: '159' href: /objects/company-config/user/159 createdBy: '159' modifiedByUser: key: '159' href: /objects/company-config/user/159 modifiedBy: '159' href: '/objects/cash-management/credit-card-txn-line-template/98' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn-line: get: summary: List credit card transaction line items description: >- Returns a collection of credit card transaction line items with a key, ID, and link for each item. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Credit card transaction lines operationId: list-cash-management-credit-card-txn-line responses: '200': description: OK content: application/json: schema: type: object title: List of credit-card-txn-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List credit card transaction lines: value: ia::result: - key: '13' id: '13' href: /objects/cash-management/credit-card-txn-line/13 - key: '5' id: '5' href: /objects/cash-management/credit-card-txn-line/5 - key: '15' id: '15' href: /objects/cash-management/credit-card-txn-line/15 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn-line/{key}: parameters: - name: key description: System-assigned unique key for the credit card transaction line item. in: path required: true schema: type: string example: '99' get: summary: Get a credit card transaction line item description: >- Returns detailed information for a specified credit card transaction line item. tags: - Credit card transaction lines operationId: get-cash-management-credit-card-txn-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the credit card transaction line item properties: ia::result: $ref: '#/components/schemas/cash-management-credit-card-txn-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a credit card transaction line: value: ia::result: id: '5299' key: '5299' creditCardTxn: id: '1482' key: '1482' href: /objects/cash-management/credit-card-txn/1482 glAccount: key: '259' id: '6254.04' name: Travel href: /objects/general-ledger/account/259 accountLabel: key: '15' id: Travel Expenses amount: '741.00' txnAmount: '1000.00' dimensions: department: key: '28' id: PS name: Professional Services href: /objects/company-config/department/28 location: key: '7' id: '7' name: Canada href: /objects/company-config/location/7 project: key: '35' id: QSF - BTI name: Quick Start Financial's - Berkeley Technology Inc href: /objects/projects/project/35 customer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 vendor: key: '56' id: '210' name: Office Supply and Copier Co. href: /objects/accounts-payable/vendor/56 employee: key: '27' id: '12' name: John Smith href: /objects/company-config/employee/27 item: key: '117' id: DELL name: DELL Laptops href: /objects/inventory-control/item/117 class: key: '3' id: WSD name: Whole Sales Distribution href: /objects/company-config/class/3 baseLocation: name: Canada key: '7' href: /objects/company-config/location/7 description: Travel expenses - John Smith currency: exchangeRate: date: '2025-04-11' rate: 0.741 txnCurrency: CAD baseCurrency: USD lineNumber: 1 totalPaid: '0.00' txnTotalPaid: '0.00' audit: createdDateTime: '2025-04-11T12:56:46Z' modifiedDateTime: '2025-04-11T12:56:46Z' createdByUser: key: '159' href: /objects/company-config/user/159 createdBy: '159' modifiedByUser: key: '159' href: /objects/company-config/user/159 modifiedBy: '159' taxDetail: key: null taxRate: null id: null isBillable: false isBilled: false taxEntries: [] href: /objects/cash-management/credit-card-txn-line/5299 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn-tax-entry: get: summary: List credit card transaction tax entries description: >- Returns a collection of credit card transaction tax entries with a key, ID, and link for each tax entry. tags: - Credit card transaction tax entries operationId: list-cash-management-credit-card-txn-tax-entry responses: '200': description: OK content: application/json: schema: type: object title: List of credit card transaction tax entries properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of credit card transaction tax entry: value: ia::result: - key: '792' id: '792' href: /objects/cash-management/credit-card-txn-tax-entry/792 - key: '797' id: '797' href: /objects/cash-management/credit-card-txn-tax-entry/797 - key: '831' id: '831' href: /objects/cash-management/credit-card-txn-tax-entry/831 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn-tax-entry/{key}: parameters: - name: key description: System-assigned unique key for the credit card transaction tax entry. in: path required: true schema: type: string example: '99' get: summary: Get a credit card transaction tax entry description: >- Returns detailed information for a particular credit card transaction tax entry. tags: - Credit card transaction tax entries operationId: get-cash-management-credit-card-txn-tax-entry-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the credit card transaction tax entry properties: ia::result: $ref: '#/components/schemas/cash-management-credit-card-txn-tax-entry' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the credit card transaction tax entry: value: ia::result: key: '300' id: '300' baseTaxAmount: '100' txnTaxAmount: '100' description: Standard Rate for UK Import Services taxRate: 5.5 purchasingTaxDetail: id: UK Export Reduced Rate key: '24' href: /objects/tax/purchasing-tax-detail/24 creditCardTxnLine: id: '148' key: '148' href: /objects/cash-management/credit-card-txn-line/148 href: '/objects/cash-management/tax/credit-card-txn-tax-entry/300' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn-template: get: summary: List credit card transaction templates description: >- Returns a collection of credit card transaction templates with a key, ID, and link for each 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: - Credit card transaction templates operationId: list-cash-management-credit-card-txn-template responses: '200': description: OK content: application/json: schema: type: object title: List of credit card transaction templates properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List credit card transaction templates: value: ia::result: - key: '2' id: CC-TXN-002 Travel href: /objects/cash-management/credit-card-txn-template/2 - key: '3' id: CC-TXN-003 Accommodation href: /objects/cash-management/credit-card-txn-template/3 - key: '4' id: CC-TXN-004 Meals href: /objects/cash-management/credit-card-txn-template/4 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a credit card transaction template description: Creates a new credit card transaction template. tags: - Credit card transaction templates operationId: create-cash-management-credit-card-txn-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-credit-card-txn-template' - $ref: '#/components/schemas/cash-management-credit-card-txn-templateRequiredProperties' examples: Create a credit card transaction template: value: id: CC-TXN-005 Software NA name: Software NA - CC TXNs description: >- Template for North American software credit card transactions. lines: - lineNumber: 1 isBillable: true glAccount: key: '326' dimensions: location: id: North America Create a credit card transaction template with tax: value: id: CC-TXN-010 Inbound AUS-GST name: Inbound Australia GST - CC TXNs description: Template for Australian GST credit card transactions. taxImplication: inbound taxSolution: id: Australia - GST taxSchedule: id: '77' lines: - lineNumber: 1 isBillable: false glAccount: key: '327' dimensions: location: id: '33' responses: '201': description: Created content: application/json: schema: type: object title: New credit card transaction template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New credit card transaction template: value: ia::result: key: '78' id: CC-TXN-078 href: /objects/cash-management/credit-card-txn-template/78 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Create a credit card transaction template with tax: value: ia::result: key: '79' id: CC-TXN-079 Inbound TAX AUS href: /objects/cash-management/credit-card-txn-template/79 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn-template/{key}: parameters: - name: key description: System-assigned unique key for the credit card transaction template. in: path required: true schema: type: string example: '3' get: summary: Get a credit card transaction template description: >- Returns detailed information for a specified credit card transaction template. tags: - Credit card transaction templates operationId: get-cash-management-credit-card-txn-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the credit card transaction template properties: ia::result: $ref: '#/components/schemas/cash-management-credit-card-txn-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a credit card transaction template: value: ia::result: key: '3' id: CC-TXN-VAT-003 name: VAT Payment - CC TXNs description: Template for VAT payments using a credit card. payee: Revenue Service numberOfRulesUsingTemplate: 0 status: active audit: createdDateTime: '2025-04-11T12:56:46Z' modifiedDateTime: '2025-04-11T12:56:46Z' createdByUser: key: '159' href: /objects/company-config/user/159 createdBy: '159' modifiedByUser: key: '159' href: /objects/company-config/user/159 taxImplication: inbound taxSolution: key: '1' id: Australia - GST href: /objects/tax/tax-solution/1 taxSchedule: name: G11 Other Acquisition key: '10' id: '10' href: /objects/tax/purchasing-tax-schedule/10 isInclusiveTax: true lines: - key: '3' id: '3' creditCardTxnTemplate: key: '3' href: '/objects/cash-management/credit-card-txn-template/3' memo: VAT payment for Q1 2025 glAccount: key: '249' id: '6003' name: Input VAT href: /objects/general-ledger/account/249 dimensions: location: id: null name: null project: key: null id: null name: null customer: key: null id: null name: null vendor: key: null id: null name: null employee: key: null id: null name: null item: key: null id: null name: null class: key: null id: null name: null lineNumber: 0 accountLabel: id: null exchangeRate: date: null typeId: null rate: null isBillable: null audit: createdDateTime: '2025-04-11T12:56:46Z' modifiedDateTime: '2025-04-11T12:56:46Z' createdByUser: key: '159' href: /objects/company-config/user/159 createdBy: '159' modifiedByUser: key: '159' href: /objects/company-config/user/159 href: '/objects/cash-management/credit-card-txn-line-template/3' href: /objects/cash-management/credit-card-txn-template/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a credit card transaction template description: >- Updates an existing credit card transaction template by setting field values. Any fields not provided remain unchanged. tags: - Credit card transaction templates operationId: update-cash-management-credit-card-txn-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-credit-card-txn-template' - type: object properties: id: readOnly: true examples: Update a credit card transaction template: value: key: '189' lines: - key: '160' lineNumber: 1 isBillable: false responses: '200': description: OK content: application/json: schema: type: object title: Updated credit card transaction template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated credit card transaction template: value: ia::result: key: '189' id: CC-TXN-189 href: /objects/cash-management/credit-card-txn-template/189 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a credit card transaction template description: Deletes a credit card transaction template. tags: - Credit card transaction templates operationId: delete-cash-management-credit-card-txn-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn: get: summary: List credit card transactions description: >- Returns a collection of credit card transactions with a key, ID, and link for each transaction. 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: - Credit card transactions operationId: list-cash-management-credit-card-txn responses: '200': description: OK content: application/json: schema: type: object title: List of credit card transactions properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List credit card transactions: value: ia::result: - key: '2' id: '2' href: /objects/cash-management/credit-card-txn/2 - key: '4' id: '4' href: /objects/cash-management/credit-card-txn/4 - key: '5' id: '5' href: /objects/cash-management/credit-card-txn/5 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a credit card transaction description: Creates a new credit card transaction. tags: - Credit card transactions operationId: create-cash-management-credit-card-txn requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-credit-card-txn' - $ref: '#/components/schemas/cash-management-credit-card-txnRequiredProperties' examples: Create a credit card transaction: value: txnDate: '2025-04-11' creditCardAccount: id: A0000001 referenceNumber: CCTxn-001 payee: Vendor-AAA description: Travel expenses isInclusiveTax: true currency: baseCurrency: USD txnCurrency: CAD exchangeRate: date: '2023-12-04' typeId: Intacct Daily Rate rate: 0.7306 taxSolution: key: '5' id: Canadian Sales Tax - SYS attachment: id: '111' key: '2' lines: - glAccount: key: '326' totalTxnAmount: '500.00' dimensions: department: id: PS location: id: '7' project: id: QSF - BTI customer: id: BTI vendor: id: '210' employee: id: '12' item: id: DELL class: id: WSD description: Travel expenses - BTI taxEntries: - purchasingTaxDetail: key: '65' isBillable: false isBilled: false responses: '201': description: Created content: application/json: schema: type: object title: New credit card transaction properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new credit card transaction: value: ia::result: id: '12' key: '12' href: /objects/cash-management/credit-card-txn/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/credit-card-txn/{key}: parameters: - name: key description: System-assigned unique key for the credit card transaction. in: path required: true schema: type: string example: '99' get: summary: Get a credit card transaction description: Returns detailed information for a specified credit card transaction. tags: - Credit card transactions operationId: get-cash-management-credit-card-txn-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the credit card transaction properties: ia::result: $ref: '#/components/schemas/cash-management-credit-card-txn' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a credit card transaction: value: ia::result: id: '27' key: '27' creditCardAccount: id: A0000001 key: '1' href: /objects/cash-management/credit-card-account/1 txnDate: '2025-04-11' audit: createdDateTime: '2025-04-11T12:56:46Z' modifiedDateTime: '2025-04-11T12:56:46Z' createdByUser: key: '159' href: /objects/company-config/user/159 createdBy: '159' modifiedByUser: key: '159' href: /objects/company-config/user/159 entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 referenceNumber: CCTxn-001 payee: Vendor-AAA description: Travel expenses in december currency: baseCurrency: USD txnCurrency: CAD exchangeRate: date: '2025-04-11' typeId: Intacct Daily Rate rate: 0.7306 totalEntered: '365.30' txnTotalEntered: '500.00' totalPaid: '0.00' txnTotalPaid: '0.00' totalSelected: '0.00' txnTotalSelected: '0.00' totalDue: '365.30' txnTotalDue: '500.00' whenPaid: null reversedBy: id: null key: null reversalDate: null reversalOf: id: null key: null txnDate: null state: posted reconciliationState: uncleared isInclusiveTax: true taxSolution: key: '5' id: Canadian Sales Tax - SYS href: /objects/tax/tax-solution/5 transactionSource: null attachment: id: '111' key: '20' href: /objects/company-config/attachment/20 lines: - id: '92' key: '92' creditCardTxn: id: '27' key: '27' href: /objects/cash-management/credit-card-txn/27 glAccount: key: '326' id: '6700.04' name: CC Other Charges & Fees href: /objects/general-ledger/account/326 accountLabel: key: null id: null amount: '320.44' txnAmount: '438.60' dimensions: department: key: '28' id: PS name: Professional Services href: /objects/company-config/department/28 location: key: '7' id: '7' name: Canada href: /objects/company-config/location/7 project: key: '35' id: QSF - BTI name: Quick Start Financial - Berkeley Technology Inc href: /objects/projects/project/35 customer: key: '14' id: BTI name: Berkeley Technology Inc href: /objects/accounts-receivable/customer/14 vendor: key: '56' id: '210' name: Office Supply and Copier Co. href: /objects/accounts-payable/vendor/56 employee: key: '27' id: '12' name: John Smith href: /objects/company-config/employee/27 item: key: '117' id: DELL name: DELL Laptops href: /objects/inventory-control/item/117 class: key: '3' id: WSD name: Whole Sales Distribution href: /objects/company-config/class/3 baseLocation: name: Calgary key: '30' href: /objects/company-config/location/30 description: Travel expenses - Smith currency: exchangeRate: date: '2025-04-11' rate: 0.7306 txnCurrency: CAD baseCurrency: USD lineNumber: 1 totalPaid: '0.00' txnTotalPaid: '0.00' audit: createdDateTime: '2025-04-11T12:56:46Z' modifiedDateTime: '2025-04-11T12:56:46Z' createdByUser: key: '159' href: /objects/company-config/user/159 createdBy: '159' modifiedByUser: key: '159' href: /objects/company-config/user/159 isBillable: false isBilled: false totalTxnAmount: '500.00' taxEntries: - txnTaxAmount: '30.70' baseTaxAmount: '22.43' purchasingTaxDetail: id: BC PST Standard Rate Services Purchase - CA key: '67' href: /objects/tax/purchasing-tax-detail/67 id: '94' key: '94' taxRate: 7 creditCardTxnLine: id: '92' key: '92' href: '/objects/cash-management/credit-card-txn-line/92' href: '/objects/cash-management/credit-card-txn-tax-entry/94' - txnTaxAmount: '30.70' baseTaxAmount: '22.43' purchasingTaxDetail: id: BC PST Standard Rate Goods Purchase - CA key: '65' href: /objects/tax/purchasing-tax-detail/65 id: '96' key: '96' taxRate: 7 creditCardTxnLine: id: '92' key: '92' href: '/objects/cash-management/credit-card-txn-line/92' href: '/objects/cash-management/credit-card-txn-tax-entry/96' href: /objects/cash-management/credit-card-txn-line/92 href: /objects/cash-management/credit-card-txn/27 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a credit card transaction description: > Updates an existing credit card transaction by setting field values. Any fields not provided remain unchanged. Credit card transactions can be updated if they are: * Not yet included in a charge payoff * Not included in an employee expense report * Not yet reconciled For more information, see [Edit a credit card transaction](https://www.intacct.com/ia/docs/en_US/help_action/Cash_Management/Payment_Methods/Credit_card/Transactions/edit-cc-txn.htm) in the Sage Intacct Help Center. tags: - Credit card transactions operationId: update-cash-management-credit-card-txn-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-credit-card-txn' examples: Update a credit card transaction: value: description: Travel expenses in December attachment: id: travel-receipt isInclusiveTax: true lines: - key: '92' creditCardTxn: key: '27' description: Travel expenses - John Smith totalTxnAmount: '500.00' taxEntries: - purchasingTaxDetail: key: '67' - purchasingTaxDetail: key: '65' responses: '200': description: OK content: application/json: schema: type: object title: Updated credit-card-txn properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated credit card transaction: value: ia::result: id: '12' key: '12' href: /objects/cash-management/credit-card-txn/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a credit card transaction description: > Deletes a credit card transaction. You can delete a credit card transaction if it is: * Associated with a credit card, not a debit card * Not included in a charge payoff or an expense report * Not paid or partially paid * Not reconciled or matched for reconciliation For more information, see [Delete or reverse a credit card transaction](https://www.intacct.com/ia/docs/en_US/help_action/Cash_Management/Payment_Methods/Credit_card/Transactions/Delete_or_reverse/ab-TOC-delete-reverse-cc-txn.htm?tocpath=Applications%7CCash%20Management%7CPayment%20methods%7CCredit%20cards%7CCredit%20card%20transactions%7CDelete%20or%20reverse%20a%20credit%20card%20transaction%7C_____0) in the Sage Intacct Help Center. tags: - Credit card transactions operationId: delete-cash-management-credit-card-txn-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposit-detail: get: summary: List deposit details description: >- Returns a collection with a key, ID, and link for each deposit detail. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Deposit details operationId: list-cash-management-deposit-detail responses: '200': description: OK content: application/json: schema: type: object title: List of deposit-detail objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List deposit details: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/deposit-detail/1 - key: '3' id: '3' href: /objects/cash-management/deposit-detail/3 - key: '5' id: '5' href: /objects/cash-management/deposit-detail/5 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposit-detail/{key}: parameters: - name: key description: System-assigned unique key for the deposit detail. in: path required: true schema: type: string example: '99' get: summary: Get a deposit detail description: Returns detailed information for a specified deposit detail. tags: - Deposit details operationId: get-cash-management-deposit-detail-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the deposit-detail properties: ia::result: $ref: '#/components/schemas/cash-management-deposit-detail' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a deposit detail: value: ia::result: id: '587' key: '587' deposit: id: '291' key: '291' depositType: cd href: /objects/cash-management/deposit/291 glAccount: id: '33' key: '33' accountNumber: '1070' name: Undeposited Funds href: /objects/general-ledger/account/33 arAccountLabel: label: null id: null key: null amount: '1002.00' txnAmount: '1002.00' department: key: null id: null name: null location: key: '1' name: United States of America href: /objects/company-config/location/1 baseLocation: name: United States of America key: '1' description: Depisted from undeposited fund from GPay invoice exchangeRate: date: '2022-01-23' typeId: '-1' rate: 1 currency: USD baseCurrency: USD status: active state: deposited audit: createdDateTime: '2021-04-16T00:57:25Z' modifiedDateTime: '2021-04-16T00:57:43Z' createdBy: '1' modifiedBy: '1' href: /objects/cash-management/deposit-detail/587 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposit-line: get: summary: List deposit lines description: >- Returns a collection with a key, ID, and link for each deposit line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Deposit lines operationId: list-cash-management-deposit-line responses: '200': description: OK content: application/json: schema: type: object title: List of deposit line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List deposit lines: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/deposit-line/1 - key: '3' id: '3' href: /objects/cash-management/deposit-line/3 - key: '5' id: '5' href: /objects/cash-management/deposit-line/5 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposit-line/{key}: parameters: - name: key description: System-assigned unique key for the deposit line. in: path required: true schema: type: string example: '99' get: summary: Get a deposit line description: Returns detailed information for a specified deposit line. tags: - Deposit lines operationId: get-cash-management-deposit-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the deposit-line properties: ia::result: $ref: '#/components/schemas/cash-management-deposit-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a deposit line: value: ia::result: id: '1253' key: '1253' deposit: id: '628' key: '628' depositType: cd href: /objects/cash-management/deposit/628 glAccount: id: '33' key: '33' accountNumber: '1070' name: Undeposited Funds href: /objects/general-ledger/account/33 arAccountLabel: label: null id: null key: null amount: '12.50' txnAmount: '12.50' dimensions: department: key: '' id: '' name: '' location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 baseLocation: name: United States of America key: '1' description: Deposit from other receipt for Convivia grapes inc currency: exchangeRate: date: '2023-04-25' typeId: '-1' rate: '1.0' baseCurrency: USD txnCurrency: USD status: active audit: createdDateTime: '2023-11-15T20:55:20Z' modifiedDateTime: '2023-11-15T20:55:25Z' createdBy: '1' modifiedBy: '1' href: /objects/cash-management/deposit-line/1253 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposit: get: summary: List deposits description: >- Returns a collection with a key, ID, and link for each deposit. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Deposits operationId: list-cash-management-deposit responses: '200': description: OK content: application/json: schema: type: object title: List of deposit objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List deposits: value: ia::result: - key: '1718' id: '1718' href: /objects/cash-management/deposit/1718 - key: '1717' id: '1717' href: /objects/cash-management/deposit/1717 - key: '3228' id: '3228' href: /objects/cash-management/deposit/3228 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a deposit description: Creates a new deposit. tags: - Deposits operationId: create-cash-management-deposit requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-deposit' - $ref: '#/components/schemas/cash-management-depositRequiredProperties' examples: Create a deposit: value: txnDate: '2024-01-22' description: Monday Deposit 0314-001 depositId: Deposit slip 01/22/2023 bankAccount: id: BOA attachment: id: '18' details: - id: '123' responses: '201': description: Created content: application/json: schema: type: object title: New deposit properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New deposit object: value: ia::result: key: '500' id: '500' href: /objects/cash-management/deposit/500 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/deposit/{key}: parameters: - name: key description: System-assigned unique key for the deposit. in: path required: true schema: type: string example: '99' get: summary: Get a deposit description: Returns detailed information for a specified deposit. tags: - Deposits operationId: get-cash-management-deposit-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the deposit properties: ia::result: $ref: '#/components/schemas/cash-management-deposit' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a deposit: value: ia::result: id: '628' key: '628' bankAccount: id: BOA name: Bank of America txnDate: '2023-11-15' depositId: Deposit Slip 2023-11-15 description: Deposit for pay-go online services baseCurrency: USD txnCurrency: USD totalEntered: '120.50' txnTotalEntered: '120.50' voidPaymentKey: null reversalDate: null reversedVoidPaymentKey: null reversedDate: null state: null reconciliationState: uncleared audit: createdDateTime: '2023-11-15T20:55:20Z' modifiedDateTime: '2023-11-15T20:55:25Z' createdBy: '1' modifiedBy: '1' attachment: key: '18' id: Attach-01 href: /objects/company-config/attachment/18 lines: - id: '1253' key: '1253' deposit: id: '628' key: '628' depositType: cd href: /objects/cash-management/deposit/628 glAccount: id: '33' key: '33' accountNumber: '1070' name: Undeposited Funds href: /objects/general-ledger/account/33 arAccountLabel: label: null id: null key: null amount: '120.50' txnAmount: '120.50' dimensions: department: key: null id: null name: null location: key: '1' name: United States of America href: /objects/company-config/location/1 baseLocation: key: '1' name: United States of America href: /objects/company-config/location/1 description: null currency: exchangeRate: date: '2022-01-23' typeId: '-1' rate: 1 txnCurrency: USD baseCurrency: USD status: active audit: createdDateTime: '2023-11-15T20:55:20Z' modifiedDateTime: '2023-11-15T20:55:25Z' createdBy: '1' modifiedBy: '1' href: /objects/cash-management/deposit-line/1253 details: - id: '624' key: '624' undepositedFund: key: '624' id: '624' href: /objects/cash-management/undeposited-fund/624 depositedFund: key: '624' id: '624' href: /objects/cash-management/deposited-fund/624 summary: 'Cash Management Transactions: 2023/12/20 Batch' customerID: null customerName: null payee: Toulouse - 03 totalEntered: '120.50' txnTotalEntered: '120.50' currency: USD paymentMethod: cash documentNumber: null deposit: id: '628' key: '628' href: /objects/cash-management/deposit/628 href: /objects/cash-management/deposit-detail/624 href: /objects/cash-management/deposit/628 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/financial-institution: get: summary: List financial institutions description: > Returns up to 100 object references from the collection with a key, ID, and link for each financial institution. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Financial institutions operationId: list-cash-management-financial-institution responses: '200': description: OK content: application/json: schema: type: object title: List of Financial Institutions objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List financial institutions: value: ia::result: - key: '1' id: FinInst1 href: /objects/cash-management/financial-institution/1 - key: '2' id: FinInst2 href: /objects/cash-management/financial-institution/2 ia::meta: totalCount: 2 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a financial institution description: Creates a new financial institution. tags: - Financial institutions operationId: create-cash-management-financial-institution requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-financial-institution' - $ref: '#/components/schemas/cash-management-financial-institutionRequiredProperties' examples: Create a financial institution: summary: Create a financial institution value: id: FinInst-BOA name: FinOn4ss5e addOnServices: - name: MAL serviceContract: key: '129' accountType: checking checkingAccounts: - key: '72' externalBankAccount: id: a421d6c8-ed48-454d-a60e-7b697c67b956 name: Plaid Saving requestedStartDate: '2021-01-23' - key: '69' externalBankAccount: id: 412f0837-c236-4917-9796-84ec52cd3edb name: Plaid CD requestedStartDate: '2021-01-23' savingsAccounts: - key: '33' externalBankAccount: id: d6c05270-66f0-4d1b-8c1e-d35b4914e991 name: Plaid IRA requestedStartDate: '2021-01-23' - key: '30' externalBankAccount: id: 11dd5715-2585-43e5-8a6c-501923ca72ec name: Plaid 401k requestedStartDate: '2021-01-23' creditCards: - key: '60' externalBankAccount: id: be157d12-d181-4409-958f-1d8fb95b504f name: Plaid Credit Card requestedStartDate: '2021-01-23' - key: '7' externalBankAccount: id: 41650f07-0f3f-432d-9d57-e56a6286bdf0 name: Plaid Money Market requestedStartDate: '2021-01-23' responses: '201': description: Created content: application/json: schema: type: object title: New financial-institution properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new financial institution: value: ia::result: key: '103' href: /objects/cash-management/financial-institution/103 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/financial-institution/{key}: parameters: - name: key description: System-assigned key for the financial institution. in: path required: true schema: type: string example: '99' get: summary: Get a financial institution description: Returns detailed information for a specified financial institution. tags: - Financial institutions operationId: get-cash-management-financial-institution-key responses: '200': description: OK content: application/json: schema: type: object title: Detail of the financial institutions properties: ia::result: $ref: '#/components/schemas/cash-management-financial-institution' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get a financial institution: value: ia::result: key: '1' id: FinInst1 name: FinOn4ddss5e totalAccounts: 7 checkingAccounts: - key: '129' href: /objects/cash-management/checking-account/129 - key: '72' href: /objects/cash-management/checking-account/72 - key: '69' href: /objects/cash-management/checking-account/69 savingsAccounts: - key: '33' href: /objects/cash-management/savings-account/33 - key: '30' href: /objects/cash-management/savings-account/30 creditCards: - key: '7' href: /objects/cash-management/credit-card-account/7 - key: '60' href: /objects/cash-management/credit-card-account/60 addOnServices: - name: MAL serviceContract: primaryAccountKey: '129' primaryAccountType: checking href: /objects/cash-management/financial-institution/96 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a financial institution description: >- Updates an existing financial institution by setting field values. Any fields not provided remain unchanged. tags: - Financial institutions operationId: update-cash-management-financial-institution-key requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-financial-institution' - $ref: '#/components/schemas/cash-management-financial-institutionRequiredProperties' examples: Update a financial institution: value: id: FinInst-BOA checkingAccounts: - key: '99' externalBankAccount: id: a532e7d9-ed59-565d-a71e-8b718c7c167 name: Corp Saving requestedStartDate: '2021-01-23' responses: '200': description: OK content: application/json: schema: type: object title: Updated financial-institution properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated financial institution: value: ia::result: key: '96' href: /objects/cash-management/financial-institution/96 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a financial institution description: Deletes a financial institution. tags: - Financial institutions operationId: delete-cash-management-financial-institution-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/funds-transfer-line: get: summary: List funds transfer transaction lines description: > Returns a collection of funds transfer transaction line items with a key, ID, and link for each 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: - Funds transfer transaction lines operationId: list-cash-management-funds-transfer-line responses: '200': description: OK content: application/json: schema: type: object title: List of funds-transfer-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List funds transfer transaction lines: value: ia::result: - key: '13' id: '13' href: /objects/cash-management/funds-transfer-line/13 - key: '5' id: '5' href: /objects/cash-management/funds-transfer-line/5 - key: '15' id: '15' href: /objects/cash-management/funds-transfer-line/15 - key: '7' id: '7' href: /objects/cash-management/funds-transfer-line/7 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/funds-transfer-line/{key}: parameters: - name: key description: System-assigned key for the funds transfer transaction line. in: path required: true schema: type: string example: '99' get: summary: Get a funds transfer transaction line description: >- Returns detailed information for a specified funds transfer transaction line. tags: - Funds transfer transaction lines operationId: get-cash-management-funds-transfer-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the cash-management-funds-transfer-line properties: ia::result: $ref: '#/components/schemas/cash-management-funds-transfer-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the funds transfer transaction line: value: ia::result: id: '87' key: '87' fundsTransfer: id: '40' key: '40' href: /objects/cash-management/funds-transfer/40 glAccount: key: '14' id: '1005' name: Bank of Montreal href: /objects/general-ledger/account/14 baseAmount: '2560.60' txnAmount: '3457.00' dimensions: department: key: '6' id: '6' name: Marketing href: /objects/company-config/department/6 location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 project: key: '9' id: '9' name: Implementation - Logic Solutions href: /objects/projects/project/9 customer: key: '2' id: '2' name: Logic Solutions href: /objects/accounts-receivable/customer/2 vendor: key: '62' id: A201 name: D Link Technologies href: /objects/accounts-payable/vendor/62 employee: key: null id: null name: null item: key: '55' id: F002 name: Accessories-Dell href: /objects/inventory-control/item/55 class: key: null id: null name: null currency: exchangeRateDate: '2025-02-14' exchangeRateTypeId: '-1' exchangeRate: 0.7407 txnCurrency: CAD baseCurrency: USD audit: createdDateTime: '2025-02-15T03:03:31Z' modifiedDateTime: '2025-02-15T03:03:32Z' createdByUser: key: '159' href: /objects/company-config/user/159 createdBy: '159' modifiedByUser: key: '159' href: /objects/company-config/user/159 modifiedBy: '159' href: /objects/cash-management/funds-transfer-line/87 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/funds-transfer: get: summary: List Funds transfer transactions description: >- Returns a collection of funds transfer transactions with a key, ID, and link for each transaction. 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: - Funds transfer transactions operationId: list-cash-management-funds-transfer responses: '200': description: OK content: application/json: schema: type: object title: List of funds-transfer objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List Funds transfer transactions: value: ia::result: - key: '30' id: '30' href: /objects/cash-management/funds-transfer/30 - key: '31' id: '31' href: /objects/cash-management/funds-transfer/31 - key: '32' id: '32' href: /objects/cash-management/funds-transfer/32 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a funds transfer transaction description: Creates a new funds transfer transaction. tags: - Funds transfer transactions operationId: create-cash-management-funds-transfer requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-funds-transfer' - $ref: '#/components/schemas/funds-transferRequiredProperties' examples: Creates a funds transfer transaction: value: sendDate: '2025-02-14' transferFromAccount: bankAccount: id: CHSE transferAmount: '1000.50' transferToAccount: bankAccount: id: BOA receivedAmount: '1000.50' description: Transfer to BOA from Chase referenceNumber: Transfer 001 responses: '201': description: Created content: application/json: schema: type: object title: New funds-transfer properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New funds transfer transaction created: value: ia::result: id: '39' key: '39' href: /objects/cash-management/funds-transfer/39 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/funds-transfer/{key}: parameters: - name: key description: System-assigned unique key for the funds transfer transaction. in: path required: true schema: type: string example: '99' get: summary: Get a funds transfer transaction description: Returns detailed information for a specified funds transfer transaction. tags: - Funds transfer transactions operationId: get-cash-management-funds-transfer-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the funds-transfer properties: ia::result: $ref: '#/components/schemas/cash-management-funds-transfer' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a funds transfer transaction: value: ia::result: id: '40' key: '40' sendDate: '2025-02-14' transferFromAccount: bankAccount: id: CHSE name: Chase key: '2' href: /objects/cash-management/bank-account/2 glAccountNumber: '1003' currency: USD accountType: checking transferAmount: '3457.00' transferToAccount: bankAccount: id: BOM name: Bank of Montreal key: '57' href: /objects/cash-management/bank-account/57 glAccountNumber: '1005' currency: CAD accountType: checking receivedAmount: '3457.00' referenceNumber: Transfer 002 description: Transfer to BOM baseCurrencyConversion: transferFromCurrency: companyBaseCurrency: USD exchangeRateDate: '2025-02-14' exchangeRateTypeId: Intacct Daily Rate exchangeRate: 1 baseCurrencyAmount: '3457.00' transferToCurrency: companyBaseCurrency: USD exchangeRateDate: '2025-02-14' exchangeRateTypeId: Intacct Daily Rate exchangeRate: 0.7407 baseCurrencyAmount: '2560.60' reversedBy: id: null key: null reversalDate: null reversalOf: id: null key: null txnDate: null state: posted reconciliationState: uncleared audit: createdDateTime: '2025-02-15T03:03:31Z' modifiedDateTime: '2025-02-15T03:03:32Z' createdByUser: key: '159' href: /objects/company-config/user/159 createdBy: '159' modifiedByUser: key: '159' href: /objects/company-config/user/159 modifiedBy: '159' attachment: id: null key: null entity: key: null id: null name: null lines: - id: '87' key: '87' fundsTransfer: id: '40' key: '40' href: /objects/cash-management/funds-transfer/40 glAccount: key: '14' id: '1005' name: Bank of Montreal href: /objects/general-ledger/account/14 baseAmount: '2560.60' txnAmount: '3457.00' dimensions: department: key: '6' id: '6' name: Marketing href: /objects/company-config/department/6 location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 project: key: '9' id: '9' name: Implementation - Logic Solutions href: /objects/projects/project/9 customer: key: '2' id: '2' name: Logic Solutions href: /objects/accounts-receivable/customer/2 vendor: key: '62' id: A201 name: D Link Technologies href: /objects/accounts-payable/vendor/62 employee: key: null id: null name: null item: key: '55' id: F002 name: Accessories-Dell href: /objects/inventory-control/item/55 class: key: null id: null name: null currency: exchangeRateDate: '2025-02-14' exchangeRateTypeId: '-1' exchangeRate: 0.7407 txnCurrency: CAD baseCurrency: USD audit: createdDateTime: '2025-02-15T03:03:31Z' modifiedDateTime: '2025-02-15T03:03:32Z' createdByUser: key: '159' href: /objects/company-config/user/159 createdBy: '159' modifiedByUser: key: '159' href: /objects/company-config/user/159 modifiedBy: '159' href: /objects/cash-management/funds-transfer-line/87 href: /objects/cash-management/funds-transfer/40 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/journal-entry-line-template: get: summary: List journal entry line templates. description: >- Returns a collection with a key, ID, and link for each journal entry line template. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Journal entry line templates operationId: list-cash-management-journal-entry-line-template responses: '200': description: OK content: application/json: schema: type: object title: List of journal-entry-line-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List line templates: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/journal-entry-line-template/1 - key: '2' id: '2' href: /objects/cash-management/journal-entry-line-template/2 - key: '7' id: '7' href: /objects/cash-management/journal-entry-line-template/7 ia::meta: totalCount: 6 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/journal-entry-line-template/{key}: parameters: - name: key description: System-assigned key for the journal entry line template. in: path required: true schema: type: string example: '5' example: '99' get: summary: Get a journal entry line template description: >- Returns detailed information for a specified journal entry line template. tags: - Journal entry line templates operationId: get-cash-management-journal-entry-line-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the journal-entry-line-template properties: ia::result: $ref: '#/components/schemas/cash-management-journal-entry-line-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a line template: value: ia::result: key: '8' id: '8' journalEntryTemplate: id: '9' key: '9' href: /objects/cash-management/journal-entry-template/9 dimensions: location: key: '7' id: '7' name: Canada href: /objects/company-config/location/7 department: id: '8' project: key: null id: null name: null customer: key: null id: null name: null vendor: key: null id: null name: null employee: key: null id: null name: null item: key: null id: null name: null class: key: null id: null name: null glAccount: key: '207' id: '5001' name: Construction href: /objects/general-ledger/account/207 documentId: doc 1 txnType: null memo: null allocation: key: '2' id: alloc-create-gl-from-UI numberOfUnits: null exchangeRate: date: null typeId: null rate: null isBillable: false href: /objects/cash-management/journal-entry-line-template/8 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/journal-entry-template: get: summary: List journal entry templates description: >- Returns a collection with a key, ID, and link for each journal entry template. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Journal entry templates operationId: list-cash-management-journal-entry-template responses: '200': description: OK content: application/json: schema: type: object title: List of journal-entry-template objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List journal entry transaction templates: value: ia::result: - key: '1' id: vat-je-tmpl-ui1 href: /objects/cash-management/journal-entry-template/1 - key: '3' id: test-add-je-tmpl-ui-tax href: /objects/cash-management/journal-entry-template/3 - key: '4' id: '1' href: /objects/cash-management/journal-entry-template/4 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a journal entry template description: Creates a new journal entry template. tags: - Journal entry templates operationId: create-cash-management-journal-entry-template requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-journal-entry-template' - $ref: '#/components/schemas/cash-management-journal-entry-templateRequiredProperties' examples: Create a journal entry transaction template: value: id: GL-CreateRule-5 name: GL-CreateRule-5 description: GL-CreateRule-5 postingState: draft status: active glJournal: id: APJ lines: - dimensions: location: id: '1' glAccount: key: '316' documentId: null memo: GL-CreateRule-5 responses: '201': description: Created content: application/json: schema: type: object title: New journal-entry-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New journal entry transaction template: value: ia::result: key: '78' id: GL-CreateRule-5 href: /objects/cash-management/journal-entry-template/78 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/journal-entry-template/{key}: parameters: - name: key description: System-assigned key for the journal entry template. in: path required: true schema: type: string example: '3' example: '99' get: summary: Get a journal entry template description: Returns detailed information for a specified journal entry template. tags: - Journal entry templates operationId: get-cash-management-journal-entry-template-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the journal-entry-template properties: ia::result: $ref: '#/components/schemas/cash-management-journal-entry-template' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a journal entry transaction template: value: ia::result: key: '3' name: test-add-je-tmpl-ui-tax description: null glJournal: id: CCJ key: '9' href: /objects/general-ledger/journal/9 postingState: draft status: active id: test-add-je-tmpl-ui-tax audit: createdDateTime: '2022-11-29T21:27:09Z' modifiedDateTime: '2022-11-29T21:27:09Z' createdBy: '1' modifiedBy: '1' taxImplication: inbound taxSolution: key: '2' id: United Kingdom - VAT href: /objects/tax/tax-solution/2 salesTaxSchedule: name: null key: null id: null purchasingTaxSchedule: name: EC Purchase Goods Exempt Rate key: '76' id: '76' href: /objects/tax/purchasing-tax-schedule/76 vendor: key: '48' id: '202' name: Pac Bell href: /objects/accounts-payable/vendor/48 customer: key: null id: null name: null lines: - key: '3' id: '3' journalEntryTemplate: id: '3' key: '3' href: /objects/cash-management/journal-entry-template/3 dimensions: location: key: null id: null name: null department: id: null project: key: null id: null name: null customer: key: null id: null name: null vendor: key: null id: null name: null employee: key: null id: null name: null item: key: null id: null name: null class: key: null id: null name: null warehouse: key: null id: null name: null glAccount: key: '334' id: '7500' name: Penalties href: /objects/general-ledger/account/334 documentId: null txnType: null memo: null allocation: key: null id: null numberOfUnits: null exchangeRate: date: null typeId: null rate: null isBillable: false href: '/objects/cash-management/journal-entry-line-template/3' href: /objects/cash-management/journal-entry-template/3 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a journal entry template description: >- Updates an existing journal entry template by setting field values. Any fields not provided remain unchanged. tags: - Journal entry templates operationId: update-cash-management-journal-entry-template-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-journal-entry-template' - type: object properties: id: readOnly: true examples: Update a journal entry transaction template: value: postingState: posted responses: '200': description: OK content: application/json: schema: type: object title: Updated journal-entry-template properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated journal entry transaction template: value: ia::result: key: '6' id: '3' href: /objects/cash-management/journal-entry-template/6 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a journal entry template description: Deletes a journal entry template. tags: - Journal entry templates operationId: delete-cash-management-journal-entry-template-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/other-receipt-line: get: summary: List other receipts lines description: >- Returns a collection with a key, ID, and link for each other receipts line item. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Other receipts lines operationId: list-cash-management-other-receipt-line responses: '200': description: OK content: application/json: schema: type: object title: List of other-receipt-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List other receipts lines: value: ia::result: - key: '1' id: '1' href: /objects/cash-management/other-receipt-line/1 - key: '3' id: '3' href: /objects/cash-management/other-receipt-line/3 - key: '5' id: '5' href: /objects/cash-management/other-receipt-line/5 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/other-receipt-line/{key}: parameters: - name: key description: System-assigned key for the other receipts line item. in: path required: true schema: type: string example: '99' get: summary: Get an other receipts line description: Returns detailed information for a specified other receipts line item. tags: - Other receipts lines operationId: get-cash-management-other-receipt-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the other-receipt-line properties: ia::result: $ref: '#/components/schemas/cash-management-other-receipt-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an other receipts line: value: ia::result: key: '821' id: '821' otherReceipts: key: '415' id: '415' recordType: cr href: /objects/cash-management/other-receipt/415 glAccount: key: '194' id: '4000' title: Accounts Payable href: /objects/general-ledger/account/194 arAccountLabel: key: '35' id: '35' label: Sales href: /objects/accounts-receivable/account-label/35 amount: '101.11' txnAmount: '101.11' dimensions: department: key: null id: null number: null name: null href: null location: number: '1' id: '1' name: United States of America key: '1' href: /objects/company-config/location/1 description: Refund for overpayment exchangeRate: date: '2021-01-15' typeId: null rate: 1 lineNumber: 1 currency: USD baseCurrency: USD status: active audit: createdDateTime: '2022-10-25T22:38:22Z' modifiedDateTime: '2022-10-25T22:38:22Z' createdBy: '1' modifiedBy: '1' isTax: false orderEntryTaxDetail: key: null taxRate: null id: null href: /objects/cash-management/other-receipt-line/821 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/other-receipt-tax-entry: get: summary: List other receipts tax entries description: >- Returns a collection of other receipts tax entries. 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: - Other receipt tax entries operationId: list-cash-management-other-receipt-tax-entry responses: '200': description: OK content: application/json: schema: type: object title: List of other-receipt-tax-entry objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List other receipt tax entries: value: ia::result: - key: '8' id: '8' href: /objects/cash-management/other-receipt-tax-entry/8 - key: '9' id: '9' href: /objects/cash-management/other-receipt-tax-entry/9 - key: '10' id: '10' href: /objects/cash-management/other-receipt-tax-entry/10 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/other-receipt-tax-entry/{key}: parameters: - name: key description: System-assigned key for the other-receipt tax entry. in: path required: true schema: type: string example: '99' get: summary: Get other receipt tax entries description: Returns detailed information for a specified other receipt tax entry. tags: - Other receipt tax entries operationId: get-cash-management-other-receipt-tax-entry-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the other-receipt-tax-entry properties: ia::result: $ref: '#/components/schemas/cash-management-other-receipt-tax-entry' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an other receipt tax entry: value: ia::result: key: '300' id: '300' baseTaxAmount: '100' txnTaxAmount: '100' description: Standard Rate for UK Import Services taxRate: 5.5 taxDetail: id: UK Export Reduced Rate key: '24' href: /objects/tax/order-entry-tax-detail/24 otherReceiptLine: id: '148' key: '148' href: /objects/cash-management/other-receipt-line/148 href: /objects/cash-management/tax/other-receipt-tax-entry/300 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/other-receipt: get: summary: List other receipt objects description: >- Returns up to 100 objects from the collection with a key, ID, and link for each other receipts object. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Other receipts operationId: list-cash-management-other-receipt responses: '200': description: OK content: application/json: schema: type: object title: List of other-receipt objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List other receipts: value: ia::result: - key: '182' id: '182' href: /objects/cash-management/other-receipt/182 - key: '193' id: '193' href: /objects/cash-management/other-receipt/193 - key: '501' id: '501' href: /objects/cash-management/other-receipt/501 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an other receipts object description: Creates a new other receipts object. tags: - Other receipts operationId: create-cash-management-other-receipt requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-other-receipt' - $ref: '#/components/schemas/cash-management-other-receiptRequiredProperties' examples: Create an other receipts object: value: payer: Benson Hugo txnDate: '2022-01-23' txnPaidDate: '2022-01-23' txnNumber: '22365' description: Refund for overpayment baseCurrency: USD currency: USD state: approved reconciliationState: uncleared isInclusiveTax: false bankAccount: id: BOA-REC-01 depositDate: '2022-01-23' exchangeRate: date: '2022-01-23' typeId: null rate: 1 paymentMethod: eft reversalDate: '2022-01-23' reversedDate: '2022-01-23' reversedVoidPaymentKey: '1400' voidPaymentKey: '1923' sourceModule: cashManagement lines: - status: active amount: '100.00' txnAmount: '100.00' description: description lineNumber: 1 baseCurrency: USD currency: USD isTax: false arAccountLabel: key: '35' glAccount: id: '5008' dimensions: location: id: CAG department: id: OPEE responses: '201': description: Created content: application/json: schema: type: object title: New other-receipt properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new other receipts object: value: ia::result: key: '500' id: '500' href: /objects/cash-management/other-receipt/500 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/other-receipt/{key}: parameters: - name: key description: System-assigned unique key for the other receipts object. in: path required: true schema: type: string example: '99' get: summary: Get an other receipts object description: Returns detailed information for a specified other receipts object. tags: - Other receipts operationId: get-cash-management-other-receipt-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the other-receipt properties: ia::result: $ref: '#/components/schemas/cash-management-other-receipt' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an other receipts object: value: ia::result: key: '557' id: '557' txnDate: '2022-01-23' recordType: cr payer: Smith Jones txnPaidDate: '2022-01-23' paymentMethod: creditCard txnNumber: '2251' description: Conference booth fee bankAccount: key: '45' id: BOA-REC-01 name: BOA-REC currency: USD href: /objects/cash-management/bank-account/45 depositDate: '2022-01-23' arSummary: key: '315' id: '315' date: '2022-01-01' href: /objects/accounts-receivable/summary/315 baseCurrency: USD currency: USD exchangeRate: date: null typeId: null rate: null totalEntered: '150.00' txnTotalEntered: '150.00' reconciliationDate: null state: approved reconciliationState: uncleared parentDeposit: key: null id: null audit: createdDateTime: '2023-09-07T21:44:43Z' modifiedDateTime: '2023-09-07T21:44:44Z' createdBy: '1' modifiedBy: '1' isInclusiveTax: false taxSolution: key: null id: null enableMultilineTax: null taxCalculationMethod: null voidPaymentKey: null reversalDate: null reversedVoidPaymentKey: null reversedDate: null sourceModule: cashManagement lines: - key: '1101' id: '1101' otherReceipts: key: '557' id: '557' recordType: cr href: /objects/cash-management/other-receipt/557 glAccount: key: '222' id: '5008' title: Payments - Contract href: /objects/general-ledger/account/222 arAccountLabel: key: '35' id: '35' label: Sales href: /objects/accounts-receivable/account-label/35 amount: '150.00' txnAmount: '150.00' dimensions: department: number: '21' id: OPEE name: Operations key: '21' href: /objects/company-config/department/21 location: id: CAG name: Calgary key: '30' href: /objects/company-config/location/30 description: Logo display exchangeRate: date: null typeId: null rate: 1 lineNumber: 1 currency: USD baseCurrency: USD status: active audit: createdDateTime: '2023-09-07T21:44:43Z' modifiedDateTime: '2023-09-07T21:44:44Z' createdBy: '1' modifiedBy: '1' isTax: false orderEntryTaxDetail: key: null taxRate: null id: null href: /objects/cash-management/other-receipt-line/1101 href: /objects/cash-management/other-receipt/557 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an other receipts object description: >- Updates an existing other receipts object by setting field values. Any fields not provided remain unchanged. Only transactions in an open sub-ledger period, which have not yet been deposited, can be updated. tags: - Other receipts operationId: update-cash-management-other-receipt-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-other-receipt' - type: object properties: id: readOnly: true examples: Update an other receipts object: value: description: 2023 Conference booth fee description: '' responses: '200': description: OK content: application/json: schema: type: object title: Updated other-receipt properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated other receipts object: value: ia::result: key: '500' id: '500' href: /objects/cash-management/other-receipt/500 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an other receipts object description: >- Deletes an other receipts object. Only those receipts that have not yet been deposited or reconciled that are in an open period can be deleted. tags: - Other receipts operationId: delete-cash-management-other-receipt-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/payment-provider-bank-account: get: summary: List payment provider bank accounts description: > Returns up to 100 object references from the collection with a key, ID, and link for each payment provider bank account. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Payment provider bank accounts operationId: list-cash-management-payment-provider-bank-account responses: '200': description: OK content: application/json: schema: type: object title: List payment provider bank accounts properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List payment provider bank accounts: value: ia::result: - key: '1' id: '1' href: '/objects/cash-management/payment-provider-bank-account/1' - key: '2' id: '2' href: '/objects/cash-management/payment-provider-bank-account/2' - key: '3' id: '3' href: '/objects/cash-management/payment-provider-bank-account/3' ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '404': $ref: '#/components/responses/404error' security: - OAuth2: [] parameters: [] post: summary: Create a payment provider bank account description: Creates a new payment provider bank account. tags: - Payment provider bank accounts operationId: create-cash-management-payment-provider-bank-account requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-payment-provider-bank-account' examples: Create a payment provider bank account: value: paymentProvider: id: CSI bankAccount: id: WF status: active checkStartNumber: '111000' remittanceEmail: jsmith@example.com responses: '201': description: Created content: application/json: schema: type: object title: New payment provider bank account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New Payment Provider bank account: value: ia::result: key: '22' id: '22' href: '/objects/cash-management/payment-provider-bank-account/22' ia::meta: totalCount: 1 '422': $ref: '#/components/responses/422error' security: - OAuth2: [] /objects/cash-management/payment-provider-bank-account/{key}: parameters: - name: key description: System-assigned key for the payment provider bank account. in: path required: true schema: type: string example: '99' get: summary: Get a payment provider bank account description: >- Returns detailed information for a specified payment provider bank account. tags: - Payment provider bank accounts operationId: get-cash-management-payment-provider-bank-account-key responses: '200': description: OK content: application/json: schema: type: object title: Details for the payment provider bank account properties: ia::result: $ref: '#/components/schemas/cash-management-payment-provider-bank-account' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a payment provider bank account: value: ia::result: key: '19' id: '19' paymentProvider: key: '1' id: CSI href: /objects/cash-management/payment-provider/1 bankAccount: key: '72' id: BOA currency: USD href: /objects/cash-management/checking-account/72 state: subscribed isRebateAccount: false providerReferenceNumber: 44397977-72-1643357336 authenticationURL: '' audit: createdDateTime: '2022-01-28T08:08:56Z' modifiedDateTime: '2022-01-28T08:23:08Z' createdBy: '1' modifiedBy: '1' status: active checkStartNumber: '123456' href: '/objects/cash-management/payment-provider-bank-account/19' ia::meta: totalCount: 1 '404': $ref: '#/components/responses/404error' security: - OAuth2: [] patch: summary: Update a payment provider bank account description: >- Updates an existing payment provider bank account by setting field values. Any fields not provided remain unchanged. tags: - Payment provider bank accounts operationId: update-cash-management-payment-provider-bank-account-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-payment-provider-bank-account' - type: object properties: id: readOnly: true examples: Update a payment provider bank account: value: isRebateAccount: false checkStartNumber: '111222' responses: '200': description: OK content: application/json: schema: type: object title: Updated payment-provider-bank-account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated payment provider bank account: value: ia::result: key: '19' id: '19' href: '/objects/cash-management/payment-provider-bank-account/19' ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/payment-provider: get: summary: List payment providers description: > Returns up to 100 object references from the collection with a key, ID, and link for each payment provider. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Payment providers operationId: list-cash-management-payment-provider responses: '200': description: OK content: application/json: schema: type: object title: List payment providers properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List payment providers: value: ia::result: - key: '3' id: CSI href: /objects/cash-management/payment-provider/3 ia::meta: totalCount: 1 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/payment-provider/{key}: parameters: - schema: type: string name: key in: path required: true example: '3' description: Payment provider key get: summary: Get a payment provider description: >- Returns detailed information for a specified payment provider, including name, ID, payment withdrawal type, and payment methods. tags: - Payment providers operationId: get-cash-management-payment-provider-key responses: '200': description: OK content: application/json: schema: type: object title: Payment provider details properties: ia::result: $ref: '#/components/schemas/cash-management-payment-provider' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a payment-provider: value: ia::result: key: '3' id: CSI name: CSI contactInfo: email: Jdoe@company.com firstName: John lastName: doe paymentWithdrawalType: perTransaction state: subscribed audit: createdDateTime: '2021-07-28T11:07:33Z' modifiedDateTime: '2021-09-06T05:17:26Z' createdBy: '1' modifiedBy: '1' paymentMethods: - key: '453' id: '453' paymentProvider: id: CSI name: CSI key: '3' href: /objects/cash-management/payment-provider/3 paymentType: VCARD audit: createdDateTime: '2021-07-30T03:29:20Z' modifiedDateTime: '2021-09-06T05:17:26Z' createdBy: '1' modifiedBy: '1' href: /objects/cash-management/provider-payment-method/453 href: /objects/cash-management/payment-provider/3 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/provider-payment-method: get: summary: List provider payment methods description: > Returns up to 100 object references from the collection with a key, ID, and link for each provider payment method. This operation is mostly for use in testing; use query to find objects that meet certain criteria and specify the properties that are returned. operationId: list-cash-management-provider-payment-method tags: - Provider payment methods responses: '200': description: OK content: application/json: schema: type: object title: List provider payment methods properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List provider payment methods: value: ia::result: - key: '453' id: '453' href: /objects/cash-management/provider-payment-method/453 - key: '454' id: '454' href: /objects/cash-management/provider-payment-method/454 - key: '455' id: '455' href: /objects/cash-management/provider-payment-method/455 - key: '456' id: '456' href: /objects/cash-management/provider-payment-method/456 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/provider-payment-method/{key}: parameters: - schema: type: string name: key in: path required: true example: '454' description: Payment method key get: summary: Get a provider payment method description: Returns detailed information for a specified provider payment method. tags: - Provider payment methods operationId: get-cash-management-provider-payment-method-key responses: '200': description: OK content: application/json: schema: type: object title: Provider payment method details properties: ia::result: $ref: '#/components/schemas/cash-management-provider-payment-method' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a provider payment method: value: ia::result: key: '454' id: '454' paymentProvider: id: CSI name: CSI key: '3' href: /objects/cash-management/payment-provider/3 paymentType: CHECK audit: createdDateTime: '2021-07-30T03:29:20Z' modifiedDateTime: '2021-09-06T05:17:26Z' createdBy: '1' modifiedBy: '1' status: active href: /objects/cash-management/provider-payment-method/454 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/cash-management/savings-account: get: summary: List savings accounts description: > Returns up to 100 object references from the collection with a key, ID, and link for each savings account. This operation is mostly for use in testing; use query to find objects that meet certain criteria and specify the properties that are returned. tags: - Savings accounts operationId: list-cash-management-savings-account responses: '200': description: OK content: application/json: schema: type: object title: List of savings account objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List savings accounts: value: ia::result: - key: '84' id: AUDCHK href: /objects/cash-management/savings-account/84 - key: '85' id: BDF href: /objects/cash-management/savings-account/85 - key: '60' id: BOA href: /objects/cash-management/savings-account/60 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a savings account description: Create a new savings account. tags: - Savings accounts operationId: post-objects-savings-account requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-savings-account' - $ref: '#/components/schemas/cash-management-savings-accountRequiredProperties' examples: Create a savings account: value: id: SAVINGS455_6780 bankAccountDetails: accountNumber: '' bankName: Savings Bank of America New routingNumber: '565676545' branchId: '123456791' phoneNumber: '6509876545' bankAddress: addressLine1: 73466 Linkln St addressLine2: null addressLine3: null city: Montaine View country: United States postCode: '67898' state: CA currency: USD accounting: glAccount: id: 2458.90.33--SAVINGS455 GL apJournal: key: '18' arJournal: id: ARJ--Accounts Receivable Journal bankingTimeZone: GMT+05:30 Bombay, Calcutta, Madras, New Delhi serviceChargeGLAccount: key: '417' interestGLAccount: key: '572' disableInterEntityTransfer: true reconciliation: matchingSequenceNumber: key: '48' useSequenceNumberForAutoMatch: false useMatchSequenceForManualMatch: true department: id: 11--Accounting location: id: 1--United States of America status: active ruleSet: key: '53' responses: '201': description: Created savings account content: application/json: schema: type: object title: New savings-account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: {} security: - OAuth2: [] /objects/cash-management/savings-account/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the savings account. example: '99' get: summary: Get a savings account description: Returns detailed information for a specified savings account. tags: - Savings accounts operationId: get-cash-management-savings-account-key responses: '200': description: OK content: application/json: schema: type: object title: Detail of the savings account properties: ia::result: $ref: '#/components/schemas/cash-management-savings-account' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get a savings account: value: ia::result: id: SAVINGS455_6780 bankAccountDetails: accountNumber: '789678988' bankName: Savings Bank of America New routingNumber: '565676545' branchId: '123456791' phoneNumber: '6509876545' bankAddress: addressLine1: 73466 Linkln St addressLine2: null addressLine3: null city: Montaine View country: United States postCode: '67898' state: CA currency: USD accounting: glAccount: id: 2458.90.33--SAVINGS455 GL key: '543' href: /objects/general-ledger/account/543 apJournal: id: AP ADJ--AP Adjustment Journal key: '18' href: /objects/general-ledger/journal/18 arJournal: id: ARJ--Accounts Receivable Journal key: '6' href: /objects/general-ledger/journal/6 bankingTimeZone: GMT+05:30 Bombay, Calcutta, Madras, New Delhi serviceChargeGLAccount: key: '417' id: 0009--My Ledger Account 39 href: /objects/general-ledger/account/417 serviceChargeAccountLabel: id: null key: null interestGLAccount: key: '572' id: 0032--My Ledger Account 32 href: /objects/general-ledger/account/572 interestAccountLabel: key: null id: null disableInterEntityTransfer: true reconciliation: matchingSequenceNumber: key: '48' id: 48--bankseq-1 href: /objects/company-config/document-sequence/48 useSequenceNumberForAutoMatch: false useMatchSequenceForManualMatch: true lastReconciledBalance: null lastReconciledDate: null cutOffDate: null inProgressBalance: null inProgressDate: null department: key: '9' id: 11--Accounting href: /objects/company-config/department/9 location: key: '1' id: 1--United States of America href: /objects/company-config/location/1 status: active entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 audit: createdDateTime: '2024-03-07T18:35:38Z' modifiedDateTime: '2024-03-07T18:40:25Z' createdBy: '1' modifiedBy: '1' key: '288' bankingCloudConnection: status: notConnected bankName: null name: null lastBankTxnDateTime: null lastRefreshedDateTime: null supportMultiAccountLinking: null financialInstitution: key: null id: null ruleSet: id: 53--MatchDateAmountGrpbyDateRuleSet key: '53' href: /objects/cash-management/bank-txn-rule-set/53 href: /objects/cash-management/savings-account/288 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a savings account description: >- Updates an existing savings account by setting field values. Any fields not provided remain unchanged. tags: - Savings accounts operationId: patch-objects-savings-account requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/cash-management-savings-account' - type: object properties: id: readOnly: true examples: Update a savings account: value: bankAccountDetails: bankName: Bank of America New ruleSet: key: '53' id: MatchDateAmountGrpbyDateRuleSet restrictions: restrictionType: unrestricted locations: [] reconciliation: matchingSequenceNumber: key: '48' useSequenceNumberForAutoMatch: true useMatchSequenceForManualMatch: true responses: '201': description: Updated savings-account content: application/json: schema: type: object title: Updated savings account properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' security: - OAuth2: [] delete: summary: Delete a savings account description: >- Deletes a savings account. You can only delete accounts that are not tied to any transactions or payments. tags: - Savings accounts operationId: delete-cash-management-savings-account-key responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error-response' security: - OAuth2: [] components: schemas: cash-management-bank-account: type: object description: This object provides information about a bank account. properties: key: type: string description: System-assigned key for the bank account. readOnly: true example: '1' id: type: string description: Unique identifier for the bank account. readOnly: true example: BOA-Checking referenceKey: type: string description: Reference key for the bank account. readOnly: true example: '90' name: type: string description: Name of the bank account. readOnly: true example: BOA checking account currency: type: string description: >- The currency for this account. The default is the base currency for the company or entity. If this account is with a foreign bank, the currency should match the country. example: USD accountType: type: string description: Type of bank account. readOnly: true enum: - checking - savings - creditCard example: checking connectionStatus: type: string description: Bank feed connection status of the account. enum: - null - notConnected - connectionRequested - inProgress - pending - pendingConfirmation - connected - authRequired - verifyingAuth - inactiveFeed - inactiveClient - cancelled - invalid - canceling - disconnecting readOnly: true example: connected nullable: true supportMultiAccountLinking: type: boolean description: Indicates whether the account supports multi-account linking. readOnly: true default: true example: true financialInstitution: description: Financial institution where the account is held. type: object properties: id: type: string readOnly: true example: '1' key: type: string readOnly: true example: '1' href: type: string readOnly: true example: /objects/cash-management/financial-institution/1 readOnly: true href: type: string description: URL for the bank account. readOnly: true example: /objects/cash-management/bank-account/1 metadata-pages: description: Metadata for collection response type: object properties: totalCount: type: integer description: Total count readOnly: true example: 3 start: type: integer description: Start element number readOnly: true example: 1 pageSize: type: integer description: Page size readOnly: true example: 100 next: type: integer description: Next element number readOnly: true nullable: true example: 101 previous: type: integer description: Previous element number readOnly: true nullable: true example: null metadata: description: Metadata for response type: object properties: totalCount: type: integer description: Total count readOnly: true example: 3 totalSuccess: type: integer description: Total success readOnly: true example: 2 totalError: type: integer description: Total errors readOnly: true example: 1 error-response: type: object description: Error response properties: ia::result: type: object properties: ia::error: type: object properties: code: type: string example: invalidRequest message: type: string example: Payload contains errors supportId: type: string example: sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ errorId: type: string example: REST-1064 additionalInfo: type: object properties: messageId: type: string example: IA.PAYLOAD_CONTAINS_ERRORS placeholders: type: object example: {} propertySet: type: object example: {} details: type: array items: type: object properties: code: type: string example: invalidRequest message: type: string example: /newDate is not a valid field errorId: type: string example: REST-1043 target: type: string example: /newDate additionalInfo: type: object properties: messageId: type: string example: IA.NOT_A_VALID_FIELD placeholders: type: object example: {} propertySet: type: object example: {} ia::meta: $ref: '#/components/schemas/metadata' example: ia::result: ia::error: code: invalidRequest message: A POST request requires a payload errorId: REST-1028 additionalInfo: messageId: IA.REQUEST_REQUIRES_A_PAYLOAD placeholders: OPERATION: POST propertySet: {} supportId: Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo ia::meta: totalCount: 1 totalSuccess: 0 totalError: 1 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 audit: type: object readOnly: true properties: createdDateTime: description: Date-time when this record was created. type: string format: date-time readOnly: true example: '2023-05-16T15:34:35Z' modifiedDateTime: description: Date-time when this record was modified. type: string format: date-time readOnly: true example: '2024-09-14T21:23:42Z' createdBy: description: Key for the user who created this object. type: string readOnly: true nullable: true deprecated: true example: '436' modifiedBy: description: Key for the user who last modified this object. type: string readOnly: true nullable: true deprecated: true example: '3086' createdByUser: type: object description: The user who created this object. readOnly: true properties: key: type: string description: User key. readOnly: true nullable: true example: '436' id: type: string description: User login ID. readOnly: true nullable: true example: JohnDoe href: type: string readOnly: true description: URL endpoint for the user. example: /objects/company-config/user/436 modifiedByUser: type: object description: The user who last modified this object. readOnly: true properties: key: type: string description: User key. readOnly: true nullable: true example: '3086' id: type: string description: User login ID. readOnly: true nullable: true example: JaneDoe href: type: string readOnly: true description: URL endpoint for the user. example: /objects/company-config/user/3086 cash-management-bank-txn-rule-filter: description: Bank transaction rule filter used in a bank transaction rule. type: object properties: key: type: string description: System-assigned unique key for the bank transaction rule filter. readOnly: true example: '3' id: type: string description: Unique identifier of the bank transaction rule filter. readOnly: true example: '3' href: type: string description: URL endpoint that links to the bank transaction rule filter. readOnly: true example: /objects/cash-management/bank-txn-rule-filter/3 dataSource: type: string description: >- Indicates if the filter should be applied to a bank transaction or an Intacct transaction. enum: - intacctTransaction - bankTransaction example: intacctTransaction intacctTxnAttribute: type: string description: >- Specifies which Intacct transaction field to include in the bank transaction rule filter. enum: - null - transactionType - documentNumber - documentDate - transactionAmount - baseAmount - transactionCurrency - baseCurrency - postingDate - description example: postingDate nullable: true default: null bankTxnAttribute: type: string description: >- Specifies which bank transaction field to include in the bank transaction rule filter. enum: - null - transactionType - documentNumber - documentType - amount - currency - feedType - postingDate - description example: transactionType nullable: true default: null operator: type: string description: >- Specifies the comparison operator used by the bank transaction rule filter. enum: - equals - contains - within - notContains - beginsWith - endsWith - greaterThan - lessThan example: equals value: type: string description: >- Specifies the value used with the comparison operator in the bank transaction rule filter. maxLength: 200 example: debit order: type: integer description: >- Indicates the position of this bank transaction rule filter in the processing sequence of the bank transaction rule. maxLength: 2 example: 2 audit: readOnly: true $ref: '#/components/schemas/audit' bankTransactionRule: description: >- References the bank transaction rule that uses the bank transaction rule filter. type: object readOnly: true properties: id: type: string description: Unique identifier of the bank transaction rule. readOnly: true example: '1' key: type: string description: System assigned unique key for the bank transaction rule. readOnly: true example: '1' href: type: string description: URL endpoint that links to the bank transaction rule. readOnly: true example: /objects/cash-management/bank-txn-rule/1 cash-management-bank-txn-rule-group: description: Bank transaction rule group used in a bank transaction rule. type: object properties: key: type: string description: System-assigned unique key for the bank transaction rule group. readOnly: true example: '1' id: type: string description: Unique identifier of the bank transaction rule group. readOnly: true example: '1' href: type: string description: URL endpoint that links to the bank transaction rule group. readOnly: true example: /objects/cash-management/bank-txn-rule-group/1 dataSource: type: string description: >- Indicates if the bank transaction rule group should be applied to a bank transaction or Intacct transaction. enum: - intacctTransaction - bankTransaction example: intacctTransaction intacctTxnAttribute: type: string description: >- Specifies which Intacct transaction field to group transactions by. This is required if `dataSource` is `intacctTransaction`. enum: - null - documentNumber - postingDate example: documentNumber nullable: true default: null bankTxnAttribute: type: string description: >- Specifies which bank transaction field to group transactions by. This is required if `dataSource` is `bankTransaction`. enum: - null - documentNumber - postingDate example: postingDate nullable: true default: null order: type: integer description: >- Indicates the position of this bank transaction rule group in the processing sequence of the bank transaction rule. maxLength: 2 example: 1 audit: readOnly: true $ref: '#/components/schemas/audit' bankTransactionRule: description: >- References the bank transaction rule that uses the bank transaction rule group. type: object readOnly: true properties: id: type: string description: Unique identifier of the bank transaction rule. readOnly: true example: '10' key: type: string description: System assigned unique key for the bank transaction rule. readOnly: true example: '10' href: type: string description: URL endpoint that links to the bank transaction rule. readOnly: true example: /objects/cash-management/bank-txn-rule/10 cash-management-bank-txn-rule-map: type: object description: A bank transaction rule map links a bank transaction rule to a rule set. properties: key: type: string description: System-assigned unique key for the bank transaction rule map. readOnly: true example: '1' id: type: string description: Unique identifier of the bank transaction rule map. readOnly: true example: '1' ruleOrder: type: integer description: Specifies the position of the rule within the rule set order. example: 1 bankTxnRule: description: Indicates the bank transaction rule to be mapped to the rule set. type: object properties: id: type: string description: Unique identifier of the bank transaction rule. example: '10' key: type: string description: System-assigned unique key for the bank transaction rule. example: '10' href: type: string description: URL endpoint that links to the bank transaction rule. readOnly: true example: /objects/cash-management/bank-txn-rule/10 ruleId: type: string description: User-assigned identifier of the bank transaction rule. example: MATCH_VENDOR_PAYMENTS_156 name: type: string description: Name of the bank transaction rule. example: Match Vendor Payment Transactions (156) ruleType: type: string description: > Indicates the type of bank transaction rule. Matching rules automatically match incoming transactions from a bank feed to transactions in Sage Intacct. Creation rules automatically create transactions from bank data to match for reconciliation in Sage Intacct. enum: - match - create default: match example: match bankTxnRuleSet: type: object readOnly: true description: Specifies the bank transaction rule set to which the rule is mapped. properties: id: type: string description: Unique identifier of the bank transaction rule set. readOnly: true example: '2' key: type: string description: System-assigned unique key for the bank transaction rule set. readOnly: true example: '2' href: type: string description: URL endpoint that links to the bank transaction rule set. readOnly: true example: /objects/cash-management/bank-txn-rule-set/2 audit: readOnly: true $ref: '#/components/schemas/audit' cash-management-bank-txn-rule-match: type: object description: Bank transaction rule match entry used in a bank transaction rule. properties: key: type: string description: >- System-assigned unique key for the bank transaction rule match entry. readOnly: true example: '1' id: type: string description: Unique identifier of the bank transaction rule match entry. readOnly: true example: '1' intacctTxnAttribute: type: string description: >- Specifies which Intacct transaction field to include in the bank transaction rule match entry. example: postingDate enum: - documentNumber - postingDate - description - amount bankTxnAttribute: type: string description: >- Specifies which bank transaction field to include in the bank transaction rule match entry. example: documentNumber enum: - documentNumber - postingDate - description - amount - documentNumberLeadingZerosRemoved operator: type: string description: >- Specifies the comparison operator used by the bank transaction rule match entry. example: equals enum: - equals - contains - within value: type: string description: >- Specifies the value used with the comparison operator in the bank transaction rule match entry. example: DOC1000 order: type: integer description: >- Indicates the position of this bank transaction match entry in the processing sequence of the bank transaction rule. example: 2 audit: $ref: '#/components/schemas/audit' bankTransactionRule: description: >- References the associated bank transaction rule that uses the bank transaction rule match entry. type: object readOnly: true properties: id: type: string description: Unique identifier of the bank transaction rule. readOnly: true example: '1' key: type: string description: System assigned unique key for the bank transaction rule. readOnly: true example: '1' href: type: string description: URL endpoint that links to the bank transaction rule. readOnly: true example: /objects/cash-management/bank-txn-rule/1 cash-management-bank-txn-rule-setRequiredProperties: type: object required: - ruleSetId - name 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 entity-ref: type: object description: >- The entity that the object is associated with. Objects created at the top level do not have an entity reference so the `key`, `id`, and `name` properties will be `null`. readOnly: true properties: key: type: string description: Entity key. readOnly: true nullable: true example: '46' id: type: string description: Entity ID. readOnly: true nullable: true example: CORP name: type: string description: Entity name. readOnly: true nullable: true example: Corp href: type: string description: URL endpoint for the entity. readOnly: true example: /objects/company-config/entity/46 cash-management-bank-txn-rule-set: type: object description: >- A rule set acts as a container for matching and creation rules. The rules determine how to match incoming bank transactions or create new transactions for reconciliation in Sage Intacct. properties: key: type: string description: System-assigned key for the bank transaction rule set. readOnly: true example: '32' id: type: string description: System-assigned identifier for the the bank transaction rule set. readOnly: true example: '32' href: type: string description: URL for the bank transaction rule set. readOnly: true example: /objects/cash-management/bank-txn-rule-set/32 ruleSetId: type: string description: ID for the bank transaction rule set. example: ruleSet-1 name: type: string description: Name of the bank transaction rule set. maxLength: 100 example: rule-set-for-credit-cards description: type: string description: Description of the bank transaction rule set. example: Rule set for all card accounts accountType: type: string description: Type of the associated account. example: creditcard enum: - bank - creditcard default: bank numberOfAccounts: type: integer description: Number of accounts linked to this bank transaction rule set. readOnly: true example: 10 default: 0 numberOfRules: type: integer description: Number of rules in the bank transaction rule set. readOnly: true example: 3 default: 0 location: type: object description: Location where the bank transaction rule set was created. properties: key: type: string description: System-assigned key for the location. example: '122' id: type: string description: ID for the location. example: 1-Lyon href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/122 status: $ref: '#/components/schemas/status' rules: type: array description: List of the rules in this rule set. items: $ref: '#/components/schemas/cash-management-bank-txn-rule-map' audit: readOnly: true $ref: '#/components/schemas/audit' entity: $ref: '#/components/schemas/entity-ref' cash-management-bank-txn-ruleRequiredProperties: type: object required: - ruleId - name - ruleType - filterAttributes cash-management-bank-txn-rule: type: object description: > Bank transaction rules determine whether incoming bank transactions are matched to existing Sage Intacct transactions or used to create new transactions. properties: key: type: string description: System-assigned unique key for the bank transaction rule. readOnly: true example: '1' id: type: string description: Unique identifier of the bank transaction rule. readOnly: true example: '1' href: type: string description: URL endpoint that links to the bank transaction rule. readOnly: true example: /objects/cash-management/bank-txn-rule/1 ruleId: type: string description: User-assigned identifier of the bank transaction rule. example: match-by-amount-1 name: type: string description: Name of the bank transaction rule. example: match-by-amount description: type: string description: Description of the bank transaction rule. example: Match bank transactions by amount ruleType: type: string description: "Type of bank transaction rule. A `match` rule matches incoming bank transactions to existing Sage Intacct transactions. A `create` rule uses the incoming bank transactions to create new Sage Intacct transactions and automatically match them. \n" example: match enum: - match - create default: match location: type: object description: Location where the bank transaction rule was created. properties: key: type: string description: System-assigned unique key for the location. example: '122' id: type: string description: Unique identifier of the location. example: 1-Lyon href: type: string description: URL endpoint that links to the location. readOnly: true example: /objects/location/122 rulesetCount: type: integer description: Number of rule sets that include the bank transaction rule. readOnly: true example: 10 default: 0 filterAttributes: type: array minItems: 1 description: Specifies a filter used in the bank transaction rule. items: $ref: '#/components/schemas/cash-management-bank-txn-rule-filter' groupAttributes: type: array description: Specifies a group used in the bank transaction rule. items: $ref: '#/components/schemas/cash-management-bank-txn-rule-group' status: $ref: '#/components/schemas/status' matchRuleAttributes: type: array description: >- Specifies the match entry used in a bank transaction `match` rule, required when the rule type is set to `match`. items: $ref: '#/components/schemas/cash-management-bank-txn-rule-match' createRuleObject: type: object description: >- Create rule object used to create new transactions, required when the rule type is set to `create`. properties: objectType: type: string description: >- Sage Intacct object type that the bank transaction `create` rule generates, for example a journal entry. example: journalEntry enum: - null - cctransaction - journalEntry nullable: true default: null journalEntryTemplate: title: Journal entry template. description: >- Reference to the journal entry template used when the `create` rule is applied. type: object properties: id: type: string description: Unique identifier of the journal entry template. example: '12' key: type: string description: System-assigned unique key for the journal entry template. example: '12' href: type: string description: URL endpoint that links to the journal entry template. readOnly: true example: /objects/cash-management/journal-entry-template/12 creditCardTxnTemplate: title: Credit card transaction template. description: >- Reference to the credit card transaction template used when the `create` rule is applied. type: object properties: id: type: string description: Unique identifier of the credit card transaction template. example: '5' key: type: string description: >- System-assigned unique key for the credit card transaction template. example: '5' href: type: string description: >- URL endpoint that links to the credit card transaction template. readOnly: true example: /objects/cash-management/credit-card-txn-template/5 audit: readOnly: true $ref: '#/components/schemas/audit' entity: $ref: '#/components/schemas/entity-ref' cash-management-checking-accountRequiredProperties: type: object required: - id - location properties: bankAccountDetails: type: object required: - bankName - currency accounting: type: object required: - glAccount timezone: type: string description: Time zone nullable: true enum: - null - GMT (Greenwich Mean Time) Dublin, Edinburgh, London - GMT+00:00 Western Europe Time - GMT+01:00 Western Europe Summer Time - GMT+01:00 British Summer Time - GMT+01:00 Irish Summer Time - GMT+01:00 Central Europe Time - GMT+01:00 Berlin, Stockholm, Rome, Bern, Brussels - GMT+01:00 Lisbon, Warsaw - GMT+01:00 Paris, Madrid - GMT+01:00 Prague - GMT+02:00 Central Europe Summer Time - GMT+02:00 Eastern Europe Time - GMT+02:00 Athens, Helsinki, Istanbul - GMT+02:00 Cairo - GMT+02:00 Harare, Pretoria - GMT+02:00 Israel - GMT+03:00 Eastern Europe Summer Time - GMT+03:00 Baghdad, Kuwait, Nairobi, Riyadh - GMT+03:00 Moscow, St. Petersburg, Volgograd - GMT+03:30 Tehran - GMT+04:00 Moscow Summer Time - GMT+04:00 Abu Dhabi, Muscat, Tbilisi, Kazan - GMT+04:30 Kabul - GMT+05:00 Islamabad, Karachi, Sverdlovsk, Tashkent - GMT+05:30 Bombay, Calcutta, Madras, New Delhi - GMT+06:00 Almaty, Dhaka - GMT+07:00 Bangkok, Jakarta, Hanoi - GMT+08:00 Beijing, Chongqing, Urumqi - GMT+08:00 Hong Kong SAR, Perth, Singapore, Taipei - GMT+08:00 (Australian) Western Standard Time - GMT+09:00 Tokyo, Osaka, Sapporo, Seoul, Yakutsk - GMT+09:30 (Australian) Central Standard Time - GMT+10:30 (Australian) Central Daylight Time - GMT+09:30 Adelaide - GMT+09:30 Darwin - GMT+10:00 Brisbane, Melbourne, Sydney - GMT+10:00 Guam, Port Moresby - GMT+10:00 Vladivostok - GMT+10:00 (Australian) Eastern Standard Time - GMT+11:00 (Australian) Eastern Daylight Time - GMT+12:00 Fiji Islands, Marshall Islands - GMT+12:00 Kamchatka - GMT+12:00 Magadan, Solomon Islands, New Caledonia - GMT+12:00 Wellington, Auckland - GMT+13:00 Nuku`alofa - GMT+13:00 Samoa - GMT-01:00 Azores, Cape Verde Island - GMT-03:00 Brasilia - GMT-03:00 Buenos Aires, Georgetown - GMT-03:30 Newfoundland Standard Time - GMT-02:30 Newfoundland Daylight Time - GMT-04:00 Atlantic Standard Time - GMT-03:00 Atlantic Daylight Time - GMT-04:00 Caracas, La Paz - GMT-05:00 Bogota, Lima - GMT-05:00 Eastern Standard Time - GMT-04:00 Eastern Daylight Saving Time - GMT-05:00 Indiana (East) - GMT-06:00 Central Standard Time - GMT-05:00 Central Daylight Saving Time - GMT-06:00 Mexico City, Tegucigalpa - GMT-06:00 Saskatchewan - GMT-07:00 Arizona - GMT-07:00 Mountain Standard Time - GMT-06:00 Mountain Daylight Saving Time - GMT-08:00 Pacific Standard Time - GMT-07:00 Pacific Daylight Saving Time - GMT-09:00 Alaska Standard Time - GMT-08:00 Alaska Standard Daylight Saving Time - GMT-10:00 Hawaii - GMT-11:00 Midway Island, Samoa - GMT-12:00 Eniwetok, Kwajalein banking-cloud-connection: type: object properties: name: type: string description: Name of the connected bank account readOnly: true example: Plaid Checking bankName: type: string description: Name of the connected bank readOnly: true example: Bank of America status: type: string description: Connected bank status enum: - null - notConnected - connectionRequested - inProgress - pending - pendingConfirmation - connected - authRequired - verifyingAuth - inactiveFeed - inactiveClient - canceled - invalid - canceling - disconnecting readOnly: true example: connected nullable: true lastBankTxnDateTime: type: string format: date-time description: Date of the last bank transaction received readOnly: true example: '2014-01-08T11:28:12Z' lastRefreshedDateTime: type: string format: date-time description: Date of the last attempt of fetching bank transactions readOnly: true example: '2014-01-08T11:28:12Z' refreshStatus: type: string description: Current status Of fetching bank transaction enum: - null - queued - refreshing - success - partialSuccess - failure example: queued readOnly: true nullable: true default: null supportMultiAccountLinking: type: boolean description: Does account support multi account linking readOnly: true example: true default: true cash-management-payment-provider-bank-account: type: object description: >- Links a bank account with the specified payment provider as part of electronic payments setup. properties: key: type: string description: System-assigned key for the provider bank account. readOnly: true example: '19' id: type: string description: Unique identifier for the provider bank account. readOnly: true example: '19' state: type: string description: Subscription status provided by the payment provider. readOnly: true example: requestInitiated enum: - requestInitiated - inProgress - requestReceived - requestFailed - awaitingAuthorization - subscribed - canceled - suspended providerReferenceNumber: type: string description: >- Reference number specific to the payment provider, which is a combination of cny#, bank account key, and timestamp. readOnly: true example: 44397977-49-1635423682 authenticationURL: type: string description: >- Authentication URL specific to the payment provider. This is sent by the payment provider after successful subscription. readOnly: true example: https://myauthurl.example.com/subscription/authenticate checkStartNumber: type: string description: Starting check number specific to the payment provider. example: '111999' isRebateAccount: type: boolean description: >- Indicates whether this is the account in which virtual card payment rebates are deposited. default: false example: true remittanceEmail: type: string description: Email address to receive the bank remittance. example: jsmith@example.com bankAccount: type: object properties: key: type: string description: System-assigned key for the bank account. example: '72' id: type: string description: Unique identifier for the bank account. example: BOA currency: type: string description: Type of currency for the bank account. example: USD readOnly: true href: type: string readOnly: true example: /objects/cash-management/checking-account/72 paymentProvider: type: object properties: key: type: string description: System-assigned key for the payment provider. example: '1' id: type: string description: Unique identifier for the payment provider. example: CSI href: type: string readOnly: true example: /objects/cash-management/payment-provider/1 href: type: string readOnly: true example: /objects/cash-management/payment-provider-bank-account/19 audit: $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' cash-management-checking-account: type: object properties: key: type: string description: System-assigned key for the checking account. readOnly: true example: '2' id: type: string description: >- Name or other unique identifier for the checking account. The ID cannot be modified. example: BOA bankAccountDetails: type: object description: Bank account details properties: accountNumber: type: string description: Bank account number for this checking account. example: '4356789402' bankName: type: string description: Name of the bank for this checking account. example: Bank of America accountHolderName: type: string description: >- The official name that the bank has on file for this checking account. maxLength: 100 example: ABC Software routingNumber: type: string description: Routing number for this checking account. example: '121000358' branchId: type: string description: Bank branch ID for this checking account. example: '89099' phoneNumber: type: string description: Phone number of the bank branch. example: '5559878978' currency: type: string description: >- The currency for this account. The default is the base currency for the company or entity. If this account is with a foreign bank, the currency should match the country. example: USD bankAddress: type: object properties: city: type: string description: City where the bank is located. example: Newark state: type: string description: State where the bank is located. example: CA postCode: type: string description: Zip or postal code for the bank. example: '94560' country: type: string description: Country where the bank is located. example: United States addressLine1: type: string description: Line 1 of the street address for the bank. example: 36900 Neward Blvd addressLine2: type: string description: Line 2 of the street address for the bank. example: Suite 101 addressLine3: type: string description: >- Line 3 of the street address for the bank which provides additional geographical information. example: Western industrial area accounting: type: object description: Accounting Information properties: glAccount: type: object description: >- General Ledger account that this checking account is associated with. properties: key: type: string example: '256' id: type: string example: 9899--My Ledger Account-33 name: type: string description: >- Name or title of the account, which appears on report headings. example: Expense Account href: type: string readOnly: true example: /objects/general-ledger/account/256 apJournal: type: object description: Default payables GL journal properties: key: type: string description: System-assigned key for the gl-journal. example: '3' id: type: string description: The id of the journal example: AP ADJ--AP Adjustment Journal href: type: string description: URL for this journal. example: /objects/general-ledger/journal/3 readOnly: true arJournal: type: object description: Default receivables GL journal properties: key: type: string description: System-assigned key for the gl-journal. example: '3' id: type: string description: The id of the journal example: AR ADJ--AR Adjustment Journal href: type: string description: URL for this journal. example: /objects/general-ledger/journal/3 readOnly: true disableInterEntityTransfer: type: boolean description: >- Exclude this account from inter-entity transfers (IET) even if IET is globally enabled for the entire multi-entity shared structure of companies. default: false example: false serviceChargeGLAccount: type: object description: >- General ledger account for service charges. Used for reconciliation. properties: key: type: string example: '432' id: type: string example: 0077--My Ledger Account 54 href: type: string readOnly: true example: /objects/general-ledger/account/432 serviceChargeAccountLabel: type: object description: General ledger account label for service charges. properties: key: type: string example: '15' id: type: string example: Car Payment href: type: string readOnly: true example: /objects/accounts-payable/account-label/15 interestGLAccount: type: object description: >- General ledger account for earned interest. Used for reconciliation. properties: key: type: string example: '419' id: type: string example: 0099--My Ledger Account 40 href: type: string readOnly: true example: /objects/general-ledger/account/419 interestAccountLabel: type: object description: General ledger account label for earned interest. properties: key: type: string example: '35' id: type: string example: Sales href: type: string readOnly: true example: /objects/accounts-receivable/account-label/35 bankingTimeZone: type: string description: Time zone allOf: - $ref: '#/components/schemas/timezone' default: null example: GMT+02:00 Eastern Europe Time reconciliation: type: object description: Reconciliation information properties: lastReconciledBalance: type: string description: Last reconciled balance. format: decimal-precision-2 readOnly: true example: '8970.98' lastReconciledDate: type: string format: date description: Date of the last reconciliation. readOnly: true example: '2019-03-22' cutOffDate: type: string format: date description: The date after which initial reconciliation can begin. readOnly: true example: '2018-01-01' inProgressBalance: type: string description: In-progress reconciliation balance. format: decimal-precision-2 readOnly: true example: '-221021.61' inProgressDate: type: string format: date description: In-progress reconciliation date. readOnly: true example: '2023-01-05' matchSequence: type: object description: Reconciliation match sequence properties: key: type: string description: System-assigned key for the document sequence number. example: '2' nullable: true id: type: string description: Document sequence ID example: 2--Bank sequence Id nullable: true href: type: string description: URL for the sequence number. readOnly: true example: /objects/company-config/document-sequence/2 nullable: true useMatchSequenceForAutoMatch: type: boolean default: true description: Use sequence number for automatically matched transactions. example: false useMatchSequenceForManualMatch: type: boolean default: true description: Use sequence number for manually matched transactions. example: false checkPrinting: type: object properties: disablePrinting: type: boolean default: false description: Disable check printing for this account. example: false addressSettings: type: object description: Address settings for check printing. properties: printAddress: type: boolean default: false description: >- Set to true to print an address on checks. Set to false if using pre-printed check stock that already includes the address, or if you don't want to include an address. example: false addressToPrint: type: string description: > Specifies the address to print on checks. **Valid values:** - Set to `company` to use the address set for the company. - Set to `custom` to use the address defined in the `name` and `address` fields. enum: - null - company - custom nullable: true default: null example: company name: type: string description: >- Company name to print on checks if `addressToPrint` is set to `custom`. maxLength: 100 example: Zine Inc. address: type: object description: >- Address to print on checks if `addressToPrint` is set to `custom`. properties: addressLine1: type: string description: Line 1 of the address. example: 75688 Post st addressLine2: type: string description: Line 2 of the address. example: East Gwalopak addressLine3: type: string description: Line 3 of the address. example: '456' city: type: string description: City example: San Ramon state: type: string description: State example: CA postCode: type: string description: Zip or postal code. example: '94536' country: type: string description: Country example: United States countryCode: type: string description: >- ISO country code. When ISO country codes are enabled for a company, both country and countryCode must be provided. example: US phone: type: string description: Phone number maxLength: 30 example: '6609336532' printLogo: type: boolean default: false description: >- Set to `true` to print company logo on checks. A logo image file must be uploaded through the Sage Intacct user interface. example: false signatures: type: object description: Uploaded signature images to print on checks. properties: firstSignature: type: string description: First signature file name. example: sigimg1_j.jpg limitForFirstSignatureAmount: type: string format: decimal-precision-2 description: >- Print first signature only for checks that are for less than this amount. A blank line for manual signature is printed for checks greater than this amount or if `limitForFirstSignatureAmount` is null. example: '50.00' useSecondSignature: type: boolean default: false description: >- Include second signature on qualifying checks. Set to `false` to always show just one signature. example: true secondSignature: type: string description: Second signature file name. example: sigimg2_j.jpg limitForSecondSignatureAmount: type: string format: decimal-precision-2 description: >- Prints second signature only for checks that are for less than this amount. A blank line for manual signature is printed for checks greater than this amount. example: '60.00' thresholdForSecondSignatureAmount: type: string format: decimal-precision-2 description: >- Print second signature only for checks that are for more than this amount. example: '60.00' printSettings: type: object properties: printOn: type: string description: > Check stock to print on for this account. **Valid values:** - Set to `prePrintedCheckStock` to use check paper that is pre-printed with company information. - Set to `blankCheckStock` to use blank check paper. enum: - prePrintedCheckStock - blankCheckStock example: blankCheckStock default: blankCheckStock nextCheckNumber: type: string description: > Enter a starting check number. For example, 1001. The check number increments by 1 for each succeeding check. maxLength: 10 pattern: ^[0-9]{1,10}$ example: '1012' nullable: true printingFormat: type: string description: > Printing format. **Valid values** - `standard` - For pre-printed checks that already show the bank account number, routing number, and check numbers. This printing format is not available for CAD checking accounts. - `business` - Prints amounts in a font that makes alterations difficult. - `highSecurity` - Same as `Standard`, plus features that reduce fraud related to check washing, forgery, and copying. This printing format is not available for CAD checking accounts. - `cadCheck` - Prints checks with dates formatted for Canadian companies. Can be used with CAD and USD checking accounts. - `jpmorganChaseBusiness` - Prints checks for JPMorgan Chase Business. - `jpmorganChaseStandard` - Prints checks for JPMorgan Chase Standard. enum: - standard - business - highSecurity - cadCheck - jpmorganChaseBusiness - jpmorganChaseStandard example: standard default: standard paperFormat: type: string description: > Sets the location for check printing on three-part forms: top, middle, or bottom panel. Pre-printed check stock is only compatible with the top and middle printing position. Canadian check stock is only compatible with the top printing position. enum: - top - middle - bottom example: top default: top printLineItems: type: boolean description: > Set to true to include additional fields in the non-remittance panel of checks. These fields include columns for the account, department, and location of each line item. A check can include up to 18 line items per page in either summary or detail mode. default: false example: true printLocation: type: string description: > The location information to include on checks. **Valid values** - `id` - Print only the location ID in the location column. - `name` - Print only the location name in the location column. - `both` - (default) Print both the location ID and the location name. enum: - id - name - both example: id default: id additionalText: type: string description: Additional text to print under the signatures. example: Pay to check holder nullable: true numberOfChecksInPreview: type: string description: Number of checks per page. enum: - null - one - three example: one nullable: true default: null micrSettings: type: object description: >- Magnetic Ink Character Recognition (MICR) settings. Use these settings if your bank requires special alignment of the account number on your check. properties: accountNumberAlignment: type: string description: Bank account number alignment in the MICR. enum: - left - right example: right default: right accountNumberPositioning: type: integer description: >- Number of spaces to append before or after the bank account portion of the MICR. example: 1 nullable: true minCheckNumberLength: type: string description: >- Set this value to pad short check numbers with zeros. The minimum number of digits is 6. example: '6' nullable: true regionalSettings: type: object description: >- Regional settings for Magnetic Ink Character Recognition (MICR). properties: printCode45: type: boolean default: false description: >- Set to true to print transaction code 45 on the MICR line. example: true printUSFundsUnderCheckAmount: type: boolean default: false description: >- Set to true to print US funds under the check amount box for CPA member banks. example: true printOnUsSymbol: type: boolean default: false description: >- Set to true to print the ON-US symbol in front of the account number. example: true positionOfOnUsSymbol: type: string description: >- Position of the ON-US symbol. To position the symbol before the checking account number, set to `position31` or `position32`. enum: - position31 - position32 example: position31 default: position31 department: type: object description: Department to use for GL posting (optional). properties: key: type: string example: '9' id: type: string example: 11--Accounting href: type: string readOnly: true example: /objects/company-config/department/9 location: type: object description: Location to use for GL posting (optional). properties: key: type: string example: '1' id: type: string example: 1--United States of America href: type: string readOnly: true example: /objects/company-config/location/1 status: $ref: '#/components/schemas/status' ach: type: object description: Automated clearing house details. properties: enableACH: type: boolean description: >- Set to true to enable your account to make standard ACH or American Express ACH Payment Services payments. default: false example: true bankId: type: string description: The ID of the bank record associated with this bank account. example: BOA_ACH companyName: type: string description: The company name specified in the ACH bank record. maxLength: 16 example: Ventura companyIdentification: type: string description: The 10-digit company ID as specified in the ACH bank record. maxLength: 10 pattern: ^[\w\s_\-\.]{0,20}$ example: Ventura originatingFinancialInstitution: type: string description: >- The first 8 digits of your bank's routing number, as specified in the ACH bank record. maxLength: 8 pattern: ^[0-9]{1,8}$ example: '89096789' companyEntryDescription: type: string description: Optional text that can be included with ACH payments. maxLength: 10 example: Investmant companyDiscretionaryData: type: string description: >- Up to 20 characters of additional information. Typically this will consist of codes that describe any special handling of entries. These codes will be unique to each bank. maxLength: 20 example: '89078900' useRecommendedSetup: type: boolean description: >- Set to true to enable Intacct to generate the most common type of ACH payment file (service class code 220) and automatically set up numbering sequences for standard ACH payments. default: false example: true recordTypeCode: type: string description: Record type code maxLength: 1 default: '5' readOnly: true example: '5' serviceClassCode: type: string description: >- Service class code. Most banks expect to receive files that use code `220` which contain only payments (credits). If your bank requires code `200`, to allow both credits and debits, `useRecommendedSetup` must be false. enum: - null - '220' - '200' nullable: true default: null example: '220' originatorStatusCode: type: string description: Originator status code default: '1' readOnly: true maxLength: 1 pattern: ^[0-9]{1}$ example: '6' batchId: type: string description: >- Required if `useRecommendedSetup` is false. Unique numbering sequence used to automatically number payment batches. Numbers must be 7 digits with no prefixes or suffixes. example: BOA_ACH_BatchNo traceNumberSequence: type: string description: >- Required if `useRecommendedSetup` is false. Created by concatenating the bank's routing number with a unique numbering sequence. Numbers must be 7 digits with no prefixes or suffixes. example: BOA_ACH_TraceNo paymentNumberSequence: type: string description: >- Required if `useRecommendedSetup` is false. You can create a unique payment number sequence to post confirmed AP payments. Or, you can use the same number sequence you set for the trace number. example: CONTINVOICE useTraceNumber: type: string description: Use trace number. enum: - null - useAsPayment - useNumberingSequence nullable: true default: useAsPayment example: useAsPayment bankFile: type: object description: >- Bank file set up for companies subscribed to Sage Cloud Services and enabled for bank file payments. A bank file is a standard file used by banks to make multiple payments. properties: enableBankFile: type: boolean description: Set to true to enable bank file payments to vendors. default: false example: true bankFileFormat: type: string description: >- Bank file format of the bank associated with this checking account. Valid values depend on the country. See [About bank files](https://www.intacct.com/ia/docs/en_US/help_action/Cash_Management/Banking_and_Payment_Cloud/Bank_files/bank-file-payment.htm) for more information. example: ABA - Westpac bankCode: type: string description: Bank code for the bank associated with this checking account. example: Westpac Banking Corporation apcaNumber: type: string description: >- The unique six-digit number used by Australian banks that identifies the company or individual making direct payments. example: '865551' bsbNumber: type: string description: >- The six-digit number used to identify the particular branch of an Australian bank, three digits, followed by a hyphen, and three more digits. example: 042-457 sunNumber: type: string description: >- Optional service user number for UK banks, which is a unique ID for organizations that collect payment with bank files. The service user number, together with the bank file, creates a record of the transaction. example: '6789' sortCode: type: string description: >- Sort code for UK banks. This is a 6-digit number that identifies the bank and branch where the checking account is held. This field is only displayed for those banks that require it. maxLength: 10 nullable: true example: 23-44-16 seedValue: type: string description: >- Seed value for South African banks. The 32-character NedBank seed value for the account from which payments are made. maxLength: 40 nullable: true example: ABFGHETOUFEH1234IOIADRTO78DD899 userReference: type: string description: User reference maxLength: 10 nullable: true example: USER123 clientCode: type: string description: Client user code maxLength: 10 nullable: true example: ProLite serviceType: type: string description: Type of service maxLength: 10 nullable: true example: PAYMENT originatorId: type: string description: Originator Identification Number maxLength: 20 example: IE26SCT803015 businessIdCode: type: string description: Business Identifier Code maxLength: 20 example: BOFIIE2DXXX processingDataCenterCode: type: string maxLength: 5 description: >- 5 digit originating direct clearer's allocated data centre ID number. example: '01674' debtorBankNumber: type: string maxLength: 3 description: >- This is the settlement institutional bank (processing bank) number. example: '674' branchTransitNumber: type: string maxLength: 5 description: >- This is the settlement institutional bank (processing bank) branch transit number. example: '43876' returnAccountNumber: type: string maxLength: 12 description: Return account number. example: IE26SCT80301 messageIdPrefix: type: string maxLength: 23 description: > This is the creditor’s unique identifier of the submitted file, the messageIdPrefix naming convention is customer defined prefix text (length 23 chars) and then, followed by 12 numbers made up with the date and time to make it unique (auto generated). Prefix message identifier is specific to Bank of Ireland SEPA bank file format. example: SEPA240212 immediateDestinationId: type: string maxLength: 9 description: >- The bank routing number for the institution receiving the payment file. example: '984569845' immediateOriginId: type: string maxLength: 9 description: >- The bank routing number for the institution sending the payment file. example: '878767675' immediateOriginName: type: string maxLength: 50 description: The name of the company sending the payment file. example: Investment corp immediateDestinationName: type: string maxLength: 50 description: The name of the company receiving the payment file. example: BOA companyEntryDescription: type: string description: >- A description of the general nature of the transactions to help with identification purposes, for example Payroll or Payables. maxLength: 10 example: Investment companyName: type: string description: The company name specified in the checking account record. maxLength: 16 example: Ventura paymentNumberSequence: type: string description: "Specify a string to generate a unique payment number sequence for payment files that are uploaded to the bank. \nPayment numbering should be ascending and incrementing. The same number sequence that you specified for traceNumberSequence.\n" maxLength: 7 example: '0000078' fileIdSequence: type: string description: "The first file generated for each calendar day starts with A. \nEach subsequent file increments by one letter, in alphabetical order then numeric order, and resets after the calendar day ends. Override values here.\n" maxLength: 1 pattern: ^[A-Za-z0-9]$ example: B postalAddress: type: object description: Postal address of the bank. properties: addressLine1: type: string description: Address line 1. example: 36900 Neward Blvd addressLine2: type: string description: Address line 2. example: Suite 100 postCode: type: string description: Postal code. example: '94536' county: type: string description: County. example: North Yorkshire countryCode: type: string description: ISO country code. readOnly: true example: GB audit: $ref: '#/components/schemas/audit' readOnly: true bankingCloudConnection: $ref: '#/components/schemas/banking-cloud-connection' financialInstitution: description: financial-institutionref type: object properties: id: type: string readOnly: true example: '1' key: type: string readOnly: true example: Fintte4 href: type: string readOnly: true example: /objects/cash-management/financial-institution/1 readOnly: true entity: $ref: '#/components/schemas/entity-ref' ruleSet: type: object description: Applied rule set properties: key: type: string example: '36' id: type: string example: 36--RuleSetToMatch name: type: string description: Name of the bank transaction rule set. example: rule-set-for-checking-accounts href: type: string readOnly: true example: /objects/cash-management/bank-txn-rule-set/2 restrictions: type: object description: >- Restrict a bank account to a specfic location or restrict one or more entity/locations to a specific account. properties: restrictionType: type: string description: > Set which entities/locations within the company can access and use this checking account. **Valid values** - `unrestricted` - (default) This account is available to the top-level company and all entity-level locations. - `rootOnly` - Only the top-level company of a multi-entity structure can access this account. - `restricted` - Only specified locations, location groups, departments, or department groups can access this account. enum: - unrestricted - rootOnly - restricted example: unrestricted default: unrestricted locations: type: array description: >- List of location ids that can access this checking account when `restrictionType` is set to `restricted`. items: type: string example: - 1--United States of America - 2--United Kingdom paymentProviderBankAccounts: type: array items: $ref: '#/components/schemas/cash-management-payment-provider-bank-account' cash-management-credit-card-accountRequiredProperties: type: object required: - id - vendor properties: accountDetails: type: object required: - accountType - cardType - expirationMonth - expirationYear accounting: type: object required: - offsetGLAccount cash-management-credit-card-account: type: object description: >- Credit card accounts are used to record transactions made outside of Sage Intacct. Credit card accounts include credit and debit payment method accounts. properties: key: type: string description: System-assigned key for the credit card account. readOnly: true example: '10' id: type: string description: >- Name or other unique identifier for the credit card account. The account ID cannot be modified. example: Card101 href: type: string description: URL endpoint for the credit card account. readOnly: true example: /objects/cash-management/credit-card-account/10 accountDetails: type: object description: Credit/debit card account details. properties: description: type: string description: Optional description about how this card is used. example: Travel Visa card 1 cardType: type: string description: >- Specifies the card type. The card type cannot be changed after the account is created. enum: - visa - mastercard - discover - americanExpress - dinersClub - otherChargeCard example: visa number: type: string description: >- Required only if the `cardType` is `americanExpress`. This is a 16-digit card number without spaces or hyphens. example: xxxxxxxxxxxx1111 accountType: type: string description: "Account type, credit or debit. Credit cards require an associated vendor and offset GL account. Debit cards used to pay bills require an associated checking account and vendor. \n" enum: - credit - debit example: credit expirationMonth: type: string description: Month when the credit card expires. enum: - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' example: '11' expirationYear: type: string description: Year when the credit card expires. example: '2032' currency: type: string description: Card currency readOnly: true example: USD billingAddress: type: object description: Billing address for the credit card. properties: addressLine1: type: string description: Street address example: 300 Park Ave addressLine2: type: string description: Suite or unit number example: '1400' addressLine3: type: string description: Address line 3 example: Western industrial area city: type: string description: City example: San Jose state: type: string description: State example: CA postCode: type: string description: Zip or postal code example: '10001' country: type: string description: Country example: USA countryCode: type: string description: >- ISO country code. When ISO country codes are enabled for a company, both `country` and `countryCode` must be provided. example: US debitCardCheckingAccount: description: >- For credit card accounts defined as a debit card, the checking account linked to the debit card. type: object properties: id: type: string description: ID for the checking account. example: BOA key: type: string description: System-assigned key for the checking account. readOnly: true example: '10' href: type: string description: URL endpoint for the checking account. readOnly: true example: /objects/cash-management/checking-account/10 readOnly: true accounting: type: object description: Accounting information for the credit card account. properties: offsetGLAccount: type: object description: >- Credit card offset GL account, which is the offset account used to track the credit card liability. properties: key: type: string description: System-assigned key of the offset GL account. example: '155' id: type: string description: ID for the offset GL account. example: '11000' href: type: string description: URL endpoint for the offset GL account. readOnly: true example: /objects/general-ledger/account/155 financeChargeGLAccount: type: object description: >- GL account to use for finance charges and other fees during reconciliation if those fees are to be tracked separately. properties: key: type: string description: System-assigned key for the GL account. example: '201' id: type: string description: ID for the GL account. example: '4562.67' href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/201 financeChargeAPAccountLabel: type: object description: Finance charges AP account label. properties: key: type: string description: System-assigned key for the AP account label. example: '22' id: type: string description: ID for the AP account label. example: Finance Charges href: type: string description: URL endpoint for the AP account label. readOnly: true example: /objects/accounts-payable/account-label/22 otherFeesGLAccount: type: object description: >- Other fees GL account used only for credit card reconciliation; does not apply to debit cards. properties: key: type: string description: System-assigned key for the GL account. example: '33' id: type: string description: ID for the GL account. example: '3556.1' href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/33 otherFeesAPAccountLabel: type: object description: Other fees AP account label. properties: key: type: string description: System-assigned key for the AP account label. example: '5' id: type: string description: ID for the AP account label. example: Other fees href: type: string description: URL endpoint for the AP account label. readOnly: true example: /objects/accounts-payable/account-label/5 defaultAccrualBasisGLJournal: type: object description: Default accrual basis journal. properties: key: type: string description: System-assigned key for the GL journal. example: '13' id: type: string description: ID for the GL journal. example: GJ href: type: string description: URL endpoint for the GL journal. readOnly: true example: /objects/general-ledger/journal/13 defaultCashBasisGLJournal: type: object description: >- Default cash basis journal. For dual-method reporting, separate accrual and cash journals can be specified. properties: key: type: string description: System-assigned key for the GL journal. example: '33' id: type: string description: ID for the GL journal. example: IJ href: type: string description: URL endpoint for the GL journal. readOnly: true example: /objects/general-ledger/journal/33 employeeExpenseGLAccount: type: object description: GL account to use for employee expense. properties: key: type: string description: System-assigned key for the GL account. example: '201' id: type: string description: ID for the GL account. example: '4562.67' href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/201 employeeExpenseAccountLabel: type: object description: Employee expense AP account label. properties: key: type: string description: System-assigned key for the AP account label. example: '22' id: type: string description: ID for the AP account label. example: Employee Expense href: type: string description: URL endpoint for the AP account label. readOnly: true example: /objects/accounts-payable/account-label/22 bankingTimeZone: type: string description: Time zone allOf: - $ref: '#/components/schemas/timezone' default: null example: GMT+02:00 Eastern Europe Time disableInterEntityTransfer: type: boolean description: Set to `true` to disable inter-entity transfers. default: false example: false useInEmployeeExpense: type: boolean description: >- Set to `true` to use this credit card account for employee expense. default: false example: false reconciliation: type: object description: >- Reconciliation information for the credit card account; does not apply to debit card accounts. properties: lastReconciledBalance: type: string description: >- If the account was previously reconciled, this is the balance of that reconciliation. format: decimal-precision-2 readOnly: true example: '110000.00' lastReconciledDate: type: string format: date description: >- If the account was previously reconciled, this is the date of that reconciliation. readOnly: true example: '2024-04-15' cutOffDate: type: string format: date description: The date after which the first reconciliation can begin. readOnly: true example: '2023-07-31' inProgressBalance: type: string description: >- For reconciliations in progress, the current reconciliation balance. format: decimal-precision-2 readOnly: true example: '160207.75' inProgressDate: type: string format: date description: >- For reconciliations in progress, the date of that reconciliation. readOnly: true example: '2024-04-21' matchSequence: type: object description: >- Reconciliation match sequence. This is a document sequence that tracks matches in reconciliation. properties: key: type: string description: System-assigned key for the document sequence number. example: '2' nullable: true id: type: string description: Document sequence ID example: 2--Bank sequence Id nullable: true href: type: string description: URL endpoint for the sequence number. readOnly: true example: /objects/company-config/document-sequence/2 nullable: true useMatchSequenceForAutoMatch: type: boolean default: true description: >- Use sequence number for transactions that were matched automatically with a rule set. example: false useMatchSequenceForManualMatch: type: boolean default: true description: Use sequence number for manually matched transactions. example: false department: type: object description: Default department to associate with this card account. properties: key: type: string description: System-assigned key for the department. example: '11' id: type: string description: ID for the department. example: '8' href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/11 location: type: object description: Default location for transactions that draw on this account. properties: key: type: string description: System-assigned key for the location. example: '5' id: type: string description: ID for the location. example: CA href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/6 vendor: type: object description: >- The vendor is the credit card provider. Associate the credit card with a vendor to pay off the credit card in accounts payable. All credit card charges and payments go to the ledger for this vendor. Use a unique vendor for each credit card account. The vendor cannot be changed after the credit card account is created. properties: key: type: string description: System-assigned key for the credit card vendor. example: '122' id: type: string description: ID for the credit card vendor. example: Amex 1 href: type: string description: URL endpoint for the credit card vendor. readOnly: true example: /objects/accounts-payable/vendor/122 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' entity: $ref: '#/components/schemas/entity-ref' bankingCloudConnection: $ref: '#/components/schemas/banking-cloud-connection' financialInstitution: description: >- Financial institution in Sage Intacct that the credit card is mapped to. Accounts are mapped to a financial institution record in Sage Intacct to manage multiple account logins for a bank feed. type: object properties: key: type: string description: System-assigned key for the financial institution. readOnly: true example: '5' id: type: string description: ID for the financial institution. readOnly: true example: '5' href: type: string description: URL endpoint for the financial institution. readOnly: true example: /objects/cash-management/financial-institution/5 readOnly: true ruleSet: type: object description: >- Rule set to use during reconciliation. If the credit card will be reconciled using a bank feed, this rule set matches incoming bank transactions to Sage Intacct transactions. properties: key: type: string description: System-assigned key for the rule set. example: '36' id: type: string description: ID for the rule set. example: 36--RuleSetToMatch href: type: string description: URL endpoint for the rule set. readOnly: true example: /objects/cash-management/bank-txn-rule-set/36 dimension-ref: type: object properties: location: type: object properties: key: type: string description: Location key example: '22' nullable: true id: type: string description: Location ID example: LOC-22 nullable: true name: type: string description: Location name readOnly: true example: California nullable: true href: type: string readOnly: true example: /objects/company-config/location/22 department: type: object properties: key: type: string description: Department key example: '11' nullable: true id: type: string description: Department ID example: DEP-11 nullable: true name: type: string description: Department name readOnly: true example: Sales and Marketing nullable: true href: type: string readOnly: true example: /objects/company-config/department/11 employee: type: object properties: key: type: string description: Employee key example: '10' nullable: true id: type: string description: Employee ID example: EMP-10 nullable: true name: type: string description: Employee name readOnly: true example: Thomas, Glenn nullable: true href: type: string example: /objects/company-config/employee/10 readOnly: true project: type: object properties: key: type: string description: Project key example: '2' nullable: true id: type: string description: Project ID example: NET-XML30-2 nullable: true name: type: string description: Project name readOnly: true example: Talcomp training nullable: true href: type: string readOnly: true example: /objects/projects/project/2 customer: type: object properties: key: type: string description: Customer key example: '13' nullable: true id: type: string description: Customer ID example: CUST-13 nullable: true name: type: string description: Customer name readOnly: true example: Jack In the Box nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/customer/13 vendor: type: object properties: key: type: string description: Vendor key example: '357' nullable: true id: type: string description: Vendor ID example: '1605212096809' nullable: true name: type: string description: Vendor name readOnly: true example: GenLab nullable: true href: type: string readOnly: true example: /objects/accounts-payable/vendor/357 item: type: object properties: key: type: string description: Item key example: '13' nullable: true id: type: string description: Item ID example: Case 13 nullable: true name: type: string description: Item name readOnly: true example: Platform pack nullable: true href: type: string readOnly: true example: /objects/inventory-control/item/13 warehouse: type: object properties: key: type: string description: Warehouse key example: '6' nullable: true id: type: string description: Warehouse ID example: WH01 nullable: true name: type: string description: Warehouse name readOnly: true example: WH01 nullable: true href: type: string readOnly: true example: /objects/inventory-control/warehouse/6 class: type: object properties: key: type: string description: Class key example: '731' nullable: true id: type: string description: Class ID example: REST_CLS_001 nullable: true name: type: string description: Class name readOnly: true example: Enterprises nullable: true href: type: string readOnly: true example: /objects/company-config/class/731 task: type: object properties: id: type: string description: Task ID example: '1' nullable: true key: type: string description: Task key example: '1' nullable: true name: type: string description: Task name readOnly: true example: Project Task nullable: true href: type: string readOnly: true example: /objects/projects/task/1 costType: type: object properties: id: type: string description: Cost Type ID example: '2' nullable: true key: type: string description: Cost Type key example: '2' nullable: true name: type: string description: Cost Type name readOnly: true example: Project Expense nullable: true href: type: string readOnly: true example: /objects/construction/cost-type/2 asset: type: object properties: id: type: string description: Asset ID example: A001 nullable: true key: type: string description: Asset key example: '1' nullable: true name: type: string description: Asset name readOnly: true example: Laptop 1 nullable: true href: type: string readOnly: true example: /objects/fixed-assets/asset/1 contract: type: object properties: id: type: string description: Contract ID example: CON-0045-1 nullable: true key: type: string description: Contract key example: '12' nullable: true name: type: string description: Contract name readOnly: true example: ACME Widgets - Service nullable: true href: type: string readOnly: true example: /objects/contracts/contract/12 affiliateEntity: type: object properties: key: type: string description: Affiliate entity key example: '23' nullable: true id: type: string description: Affiliate entity ID example: AFF-23 nullable: true href: type: string readOnly: true example: /objects/affiliate-entity/23 name: type: string readOnly: true description: Affiliate entity name example: 100-USA nullable: true cash-management-credit-card-txn-line-template: type: object description: >- Credit card transaction line templates provide a predefined structure to standardize credit card transaction line items. properties: key: type: string description: >- System-assigned unique key for the credit card transaction line template. readOnly: true example: '1' id: type: string description: Unique identifier for the credit card transaction line template. readOnly: true example: '1' href: type: string description: URL endpoint for the credit card transaction line template. readOnly: true example: /objects/cash-management/credit-card-txn-line-template/23 memo: type: string description: Memo example: memo-created-by-rule lineNumber: type: integer description: Line number for the line items that use this template. example: 1 isBillable: type: boolean description: Indicates whether the line item is billable. example: true default: false exchangeRate: type: object description: >- Exchange rate used to calculate the base amount for line items using this template. properties: date: type: string format: date example: '2021-01-23' description: > Date of the exchange rate used to calculate the base amount from the transaction amount. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: '1' accountLabel: type: object description: >- Label for the accounts payable account associated with the line item using this template. properties: key: type: string description: System-assigned unique key for the account label. example: '14' id: type: string description: Unique identifier for the account label. example: Entertainment href: type: string description: URL endpoint for the account label. readOnly: true example: /objects/accounts-payable/account-label/14 glAccount: type: object description: General ledger account the line item is assigned to. properties: key: type: string description: System assigned unique key for the general ledger account. example: '2' id: type: string description: Unique identifier for the general ledger account. example: '1501.01' name: type: string description: Name or title of the general ledger account. readOnly: true example: Entertainment href: type: string description: URL for the general ledger account. readOnly: true example: /objects/general-ledger/account/2 dimensions: $ref: '#/components/schemas/dimension-ref' creditCardTxnTemplate: type: object description: Credit card transaction template that contains the line items. properties: id: type: string description: Unique identifier for the credit card transaction template. example: '2' key: type: string description: >- System-assigned unique key for the credit card transaction template. example: '2' href: type: string description: URL endpoint for the credit card transaction template. readOnly: true example: /objects/cash-management/credit-card-txn-template/2 status: $ref: '#/components/schemas/status' audit: readOnly: true $ref: '#/components/schemas/audit' 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 location-ref: type: object properties: key: type: string description: Location key example: '1' id: type: string description: Location ID example: US name: type: string description: Location name readOnly: true example: United States of America href: type: string description: URL endpoint for the location. example: /objects/company-config/location/1 readOnly: true tax-entries: description: Tax entries for line items. type: object properties: key: type: string description: System-assigned key for the tax entry. example: '7149' readOnly: true id: type: string description: Unique identifier for the tax entry. example: '7149' readOnly: true baseTaxAmount: type: string description: Base tax amount. format: decimal-precision-2 example: '100.00' txnTaxAmount: type: string description: >- Transaction tax amount. For a PATCH request, set to `null` if you want Sage Intacct to recalculate the amount, or set to the value you want if you don't want the system to recalculate. format: decimal-precision-2 example: '100.00' taxRate: type: number description: Tax rate. example: 1.0299 cash-management-credit-card-txn-tax-entry: type: object description: Tax entry details for credit card transaction line items. allOf: - $ref: '#/components/schemas/tax-entries' - type: object properties: purchasingTaxDetail: type: object description: > Specifies tax information for individual line items in credit card transactions, including entries relating to accounts receivable, accounts payable and purchasing. properties: key: type: string description: System-assigned unique key for the purchasing tax detail. example: '1' id: type: string description: Unique identifier of the purchasing tax detail. example: Alaska Tax Detail href: type: string description: URL endpoint of the purchasing tax detail. readOnly: true example: /objects/tax/purchasing-tax-detail/1 creditCardTxnLine: title: creditCardTxnLine description: >- Credit card transaction line item to which this tax information applies. type: object readOnly: true properties: id: type: string description: Unique identifier for the credit card transaction line item. example: '100' readOnly: true key: type: string description: >- System-assigned unique key for the credit card transaction line item. example: '100' readOnly: true href: type: string description: URL endpoint for the credit card transaction line item. readOnly: true example: /objects/cash-management/credit-card-txn-line/100 cash-management-credit-card-txn-line: type: object description: >- Line items in a credit card transaction represent charges applied to credit and debit cards. properties: id: type: string description: Unique identifier for the credit card transaction line item. readOnly: true example: '62' key: type: string description: System-assigned unique key for the line item. readOnly: true example: '62' href: type: string description: URL endpoint for the line item. readOnly: true example: /objects/cash-management/credit-card-txn-line/62 amount: 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: '3000.54' totalTxnAmount: type: string format: decimal-precision-2 description: For multi-currency companies, amount of the line item. example: '100.99' txnAmount: type: string format: decimal-precision-2 description: >- For multi-currency companies, the amount of the line item in the transaction currency. example: '2003.00' currency: type: object description: Currency details for the credit card transaction. readOnly: true properties: baseCurrency: type: string description: Base currency for the entity or company. readOnly: true example: USD txnCurrency: type: string description: For multi-currency companies, the currency for the line item. readOnly: true example: GBP exchangeRate: type: object title: exchangeRate readOnly: true description: >- Exchange rate used to calculate the base amount for this line item. properties: date: type: string format: date example: '2021-01-23' description: >- Date of the exchange rate 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 description: type: string description: Additional information about the line item. example: Entertainment charges lineNumber: type: integer description: Line number for the line item. readOnly: true example: 1 totalPaid: type: string format: decimal-precision-2 description: Total paid for the line item in the company's base currency. readOnly: true example: '777.10' txnTotalPaid: type: string readOnly: true format: decimal-precision-2 description: >- In multi-currency companies, total paid for the line item in the transaction currency. example: '1000.99' isBillable: type: boolean description: Indicates whether a line item is billable. default: false example: true isBilled: type: boolean description: Indicates whether a line item is already billed. default: false example: false accountLabel: type: object description: >- Label for the accounts payable account associated with the line item. properties: key: type: string description: System-assigned unique key for the account label. example: '14' id: type: string description: Unique identifier for the account label. example: Entertainment href: type: string description: URL endpoint for the account label. readOnly: true example: /objects/accounts-payable/account-label/14 glAccount: $ref: '#/components/schemas/gl-account-ref' taxDetail: type: object description: Specific tax information that applies to the line item. properties: key: type: string description: System-assigned unique key for the tax detail. example: '5' id: type: string description: Unique identifier for the tax detail. example: CATAXDETAIL taxRate: type: number description: Percentage rate of tax used for the line item. example: 1.0299 href: type: string description: URL endpoint for the tax detail. readOnly: true example: /objects/tax/purchasing-tax-detail/5 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 unique 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: URL 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 unique key for the department. readOnly: true example: '9' id: type: string description: Unique identifier of the department. example: '01' name: type: string description: Name of the department. readOnly: true example: Accounting href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/9 baseLocation: type: object description: Base location for the line item in multi-entity companies. allOf: - $ref: '#/components/schemas/location-ref' - type: object properties: key: type: string description: Base location key. example: '4' creditCardTxn: type: object description: Credit card transaction that contains the line items. properties: key: type: string description: System-assigned unique key for the credit card transaction. readOnly: true example: '100' id: type: string description: Unique identifier for the credit card transaction. readOnly: true example: '100' href: type: string description: URL endpoint for the credit card transaction. readOnly: true example: /objects/cash-management/credit-card-txn/100 readOnly: true audit: $ref: '#/components/schemas/audit' readOnly: true taxEntries: type: array description: Tax Entries of the credit card transaction line item. items: $ref: '#/components/schemas/cash-management-credit-card-txn-tax-entry' cash-management-credit-card-txn-templateRequiredProperties: type: object required: - id - name cash-management-credit-card-txn-template: type: object description: >- Credit card transaction templates provide a predefined structure to standardize credit card transactions. properties: key: type: string description: System-assigned unique key for the credit card transaction template. readOnly: true example: '1' id: type: string description: Unique identifier for the credit card transaction template. example: CC-TXN-001 href: type: string description: URL endpoint for the credit card transaction template. readOnly: true example: /objects/cash-management/credit-card-txn-template/23 name: type: string description: Name for the credit card transaction template. example: CC-TXN-001 - Business Purchases - Office Supplies description: type: string description: Description for the credit card transaction template. example: >- Credit card transaction template for purchasing business office supplies payee: type: string description: >- Payee associated with the credit card transactions using this template. example: Office Solutions numberOfRulesUsingTemplate: type: integer description: >- Number of rules associated with this credit card transactions using this template. readOnly: true example: 1 default: 0 taxImplication: type: string description: >- Defines how tax-related details are handled for credit card transactions using this template. Only applies to companies using the Taxes application. example: inbound nullable: true enum: - null - none - inbound default: null isInclusiveTax: type: boolean description: >- Specifies whether credit card transactions using this template are inclusive of tax. Only applies to companies using the Taxes application. example: false readOnly: true default: true taxSchedule: type: object description: >- Defines the tax structure to be applied to credit card transactions using this template. Only applies to companies using the Taxes application. properties: key: type: string description: System-assigned unique key for the tax schedule. example: '11' id: type: string description: Unique identifier of the tax schedule. example: '11' name: type: string description: Name for the tax schedule. readOnly: true example: PO-TaxSched-0011 href: type: string description: URL endpoint for the tax schedule. readOnly: true example: /objects/tax/purchasing-tax-schedule/11 taxSolution: type: object description: > Specifies the tax solution used to calculate or manage taxes for credit card transactions using this template. Only applies to companies using the Taxes application. properties: key: type: string description: System-assigned unique key for the tax solution. example: '2' id: type: string description: Unique identifier for the tax solution. example: Australia - GST href: type: string description: URL endpoint for the tax solution. readOnly: true example: /objects/tax/tax-solution/2 lines: type: array description: Line items for the credit card transactions using this template. items: $ref: '#/components/schemas/cash-management-credit-card-txn-line-template' audit: readOnly: true type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Date and time of the submission. format: date-time example: '2024-01-08T11:28:12Z' readOnly: true status: $ref: '#/components/schemas/status' entity: $ref: '#/components/schemas/entity-ref' cash-management-credit-card-txnRequiredProperties: type: object required: - txnDate properties: creditCardAccount: required: - id currency: required: - txnCurrency lines: type: array items: required: - txnAmount - glAccount cash-management-credit-card-txn: type: object description: Transaction record containing charges made to credit and debit cards. properties: key: type: string description: System-assigned unique key for the credit card transaction. readOnly: true example: '1001' id: type: string description: Unique identifier for the transaction. readOnly: true example: '1001' href: type: string description: URL endpoint for the transaction. readOnly: true example: /objects/cash-management/credit-card-txn/1001 txnDate: type: string format: date example: '2021-11-30' description: Date of the transaction. creditCardAccount: type: object description: Credit card account used for this transaction. properties: key: type: string description: System-assigned unique key for the credit card account. example: '3' id: type: string description: Unique identifier for the credit card account. example: amex-card-1 href: type: string description: URL endpoint for the credit card account. readOnly: true example: /objects/cash-management/credit-card-account/3 referenceNumber: type: string description: >- Reference number for the transaction, such as the transaction number from the credit card statement. example: Ref--cc12 payee: type: string description: Name of the payee for the transaction. example: Vend-1 description: type: string description: Brief description of the purpose of the transaction. example: Meals attachment: type: object description: Supporting document attached to this transaction. properties: key: type: string description: System-assigned unique key for the attachment. example: '1' id: type: string description: Unique identifier for the attachment. example: '1' href: type: string description: URL endpoint for the attachment. readOnly: true example: /objects/company-config/attachment/1 currency: type: object description: Currency details for the transaction. properties: baseCurrency: type: string description: The base currency for the entity or company. example: USD txnCurrency: type: string description: >- For multi-currency companies, the currency in which the transaction was incurred. example: GBP exchangeRate: type: object title: exchangeRate description: >- Exchange rate used to calculate the base amount for this transaction. properties: date: type: string format: date example: '2021-01-23' description: >- Date of the exchange rate used to calculate the base amount from the transaction amount. 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 totalEntered: type: string format: decimal-precision-2 description: >- Total amount entered for the transaction in the company's base currency. readOnly: true example: '1500.01' txnTotalEntered: type: string format: decimal-precision-2 description: >- For multi-currency companies, the total amount entered in the transaction currency. readOnly: true example: '2500.10' totalPaid: type: string format: decimal-precision-2 description: >- Total amount paid for the transaction in the company's base currency. readOnly: true example: '101.00' txnTotalPaid: type: string format: decimal-precision-2 description: >- For multi-currency companies, the total amount paid in the transaction currency. readOnly: true example: '200.10' whenPaid: type: string format: date readOnly: true example: '2021-01-23' description: Date the transaction was paid. state: type: string description: State of the credit card transaction. enum: - reversed - reversal - posted - paid - partiallyPaid - selected readOnly: true example: posted reconciliationState: type: string description: >- Indicates if this transaction has been cleared or matched for card account reconciliation. readOnly: true example: matched enum: - cleared - uncleared - matched default: uncleared totalDue: type: string readOnly: true format: decimal-precision-2 description: Total amount due for the transaction in the company's base currency. example: '1600.00' txnTotalDue: type: string readOnly: true format: decimal-precision-2 description: Total amount due in the transaction currency. example: '1000.45' totalSelected: type: string readOnly: true format: decimal-precision-2 description: >- Total amount selected for the transaction in the company's base currency. example: '1234.67' txnTotalSelected: type: string readOnly: true format: decimal-precision-2 description: Total amount selected in the transaction currency. example: '1234.56' isInclusiveTax: type: boolean description: Indicates whether the transaction is tax inclusive. example: true default: false transactionSource: type: string description: >- Source of the transaction. For transactions auto-created from a bank feed, this value is `bank`, otherwise the value is null. readOnly: true enum: - null - bank nullable: true default: null example: bank reversedBy: type: object description: >- For transactions with a state of `reversed`, a reference to the transaction that reversed this transaction. readOnly: true properties: key: type: string description: System-assigned unique key for the reversing transaction. readOnly: true example: '221' id: type: string description: Unique identifier for the reversing transaction. readOnly: true example: '221' reversalDate: type: string format: date readOnly: true example: '2021-01-23' description: Date the transaction was reversed. href: type: string description: URL endpoint for the reversing transaction. readOnly: true example: /objects/cash-management/credit-card-txn/221 reversalOf: type: object description: >- For transactions with a state of `reversal`, a reference to the transaction that was reversed by this transaction. readOnly: true properties: key: type: string description: System-assigned unique key for the reversed transaction. readOnly: true example: '125' id: type: string description: Unique identifier for the reversed transaction. readOnly: true example: '125' txnDate: type: string format: date readOnly: true example: '2021-10-22' description: Date of the reversed transaction. href: type: string description: URL endpoint for the reversed transaction. readOnly: true example: /objects/cash-management/credit-card-txn/125 taxSolution: type: object description: >- Tax solution used to calculate and capture taxes on this transaction. properties: key: type: string description: System-assigned unique key for the tax solution. example: '4' id: type: string description: Unique identifier for the tax solution. example: Australia GST href: type: string description: URL endpoint for the tax solution. readOnly: true example: /objects/tax/tax-solution/4 lines: type: array description: Line items for the credit card transaction. items: $ref: '#/components/schemas/cash-management-credit-card-txn-line' audit: $ref: '#/components/schemas/audit' readOnly: true entity: $ref: '#/components/schemas/entity-ref' cash-management-deposit-detail: type: object description: >- Deposit detail contains the deposit information related to the parent deposit. properties: key: type: string description: System-assigned key for the deposit-detail. example: '23' id: type: string description: Deposit details ID. example: '23' href: type: string description: Endpoint for the deposit-detail. readOnly: true example: /objects/cash-management/deposit-detail/23 summary: type: string description: Summary. readOnly: true example: 'Cash Management Transactions: 2022/04/08 Batch' customer: type: object description: Customer associated with the deposit. readOnly: true properties: key: type: string description: System-assigned key for the customer. readOnly: true example: '23' id: type: string description: Identifier for the customer. readOnly: true maxLength: 21 example: Cust-1 name: type: string description: Name of the customer. readOnly: true example: Peter Hansen href: type: string description: URL for the customer. example: /objects/accounts-receivable/customer/23 readOnly: true payee: type: string description: Payee. readOnly: true example: Alter Windows Inc totalEntered: type: string format: decimal-precision-2 description: Base amount. readOnly: true example: '100.99' txnTotalEntered: type: string format: decimal-precision-2 description: Transaction amount. readOnly: true example: '100.99' currency: type: string description: Transaction currency. readOnly: true example: USD paymentMethod: type: string description: Payment method. readOnly: true example: cash enum: - check - chargeCard - onlineChargeCard - recordTransfer - cash documentNumber: type: string description: Transaction number. readOnly: true example: Check 0019 state: type: string description: Deposit state. readOnly: true example: undeposited enum: - undeposited - deposited deposit: type: object description: Header level details for the deposit details. readOnly: true properties: key: type: string description: System-assigned key for the deposit. readOnly: true example: '10' id: type: string description: ID for the deposit. readOnly: true example: '10' href: type: string readOnly: true example: /objects/cash-management/deposit/10 status: readOnly: true $ref: '#/components/schemas/status' audit: readOnly: true $ref: '#/components/schemas/audit' cash-management-deposit-line: type: object description: Line items in a deposit represent payments received from customers. properties: key: type: string description: System-assigned key for the deposit line item. readOnly: true example: '101' id: type: string description: ID for the deposit line item. Same as `key` for this object. readOnly: true example: '101' amount: type: string format: decimal-precision-2 readOnly: true description: Base amount of the payment. example: '100.99' txnAmount: type: string format: decimal-precision-2 readOnly: true description: Transaction amount of the payment. example: '100.99' description: type: string readOnly: true description: Optional description for the line item. example: Deposit from other receipt 101 currency: type: object description: Currency details for the deposit line item. properties: baseCurrency: type: string description: Base currency for the company. readOnly: true example: USD txnCurrency: type: string description: Transaction currency for the company. readOnly: true example: GBP exchangeRate: type: object title: exchangeRate description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date used to calculate the base amount from the transaction amount. readOnly: true rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. readOnly: true example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. readOnly: true example: '-1' baseLocation: type: object description: Location assigned to the deposit. allOf: - $ref: '#/components/schemas/location-ref' - type: object properties: key: type: string description: Base location key. example: '4' arAccountLabel: type: object readOnly: true description: Label for the AR account associated with the line item. properties: key: type: string readOnly: true description: System-assigned key for the account label. example: '10' id: type: string readOnly: true description: ID for the account label. example: '10' label: type: string readOnly: true description: AR account label example: SALES href: type: string description: URL endpoint for the account label. readOnly: true example: /objects/accounts-receivable/account-label/102 glAccount: type: object description: General Ledger (GL) account for the deposit line item. readOnly: true properties: key: type: string description: System-assigned key for the GL account. readOnly: true example: '9' id: type: string description: Identifier for the GL account. readOnly: true example: '9' accountNumber: type: string description: Number of the GL account. readOnly: true example: '9010' name: type: string description: Name of the GL account. readOnly: true example: Service Payments href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/102 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of locations to reflect how your company is organized. title: location properties: key: type: string description: System-assigned key for the location. example: '4' id: type: string description: Unique identifier of the location. example: AU name: type: string description: Name of the location. readOnly: true example: Australia href: type: string description: Endpoint URL for the location. readOnly: true example: /objects/company-config/location/4 department: type: object description: >- Standard Sage Intacct dimension that allows you to create a hierarchy of departments to reflect how your company is organized. title: department properties: key: type: string description: System-assigned key for the department. example: '9' id: type: string description: Unique identifier of the department. example: '01' name: type: string description: Name of the department. readOnly: true example: Accounting href: type: string description: Endpoint URL for the department. readOnly: true example: /objects/company-config/department/9 deposit: type: object description: Header level details for the deposit's line entries. readOnly: true properties: key: type: string description: System-assigned key for the deposit. readOnly: true example: '10' id: type: string description: ID for the deposit. readOnly: true example: '10' depositType: type: string description: Record type for the deposit. readOnly: true example: cr href: type: string description: Endpoint URL for the deposit. readOnly: true example: /objects/cash-management/deposit/10 status: readOnly: true $ref: '#/components/schemas/status' audit: readOnly: true $ref: '#/components/schemas/audit' cash-management-depositRequiredProperties: type: object required: - txnDate - bankAccount properties: details: type: array items: required: - id cash-management-deposit: type: object description: Transaction record for a deposit. properties: key: type: string description: System-assigned key for the deposit. readOnly: true example: '1234' id: type: string description: Identifier for the deposit object. Same as `key` for this object. example: '1234' depositId: type: string description: >- ID to correlate the deposit transaction record with the actual deposit slip from the bank. example: Deposit slip 09/21/2023 txnDate: type: string format: date example: '2023-09-21' description: Date when the transaction occurred. description: type: string description: Description of the deposit. example: Cash deposit for online service baseCurrency: type: string description: For multi-currency companies, the base currency for the company. readOnly: true example: USD txnCurrency: type: string description: >- For multi-currency companies, the transaction currency for the bank deposit. readOnly: true example: USD totalEntered: type: string format: decimal-precision-2 description: Total base amount of the deposit. readOnly: true example: '100.99' txnTotalEntered: type: string format: decimal-precision-2 description: Total transaction amount of the deposit. readOnly: true example: '100.99' state: type: string description: State of the deposit. readOnly: true example: void enum: - null - void - approve nullable: true default: null reconciliationState: type: string description: Indicates whether the deposit has been cleared or matched. example: cleared enum: - cleared - uncleared - matched default: uncleared readOnly: true bankAccount: type: object description: Bank account in which to make the deposit. properties: key: type: string description: System-assigned key for the bank account. example: '1' id: type: string description: Account number or other unique identifier for the bank account. example: BOA name: type: string description: Name of the bank account. example: Bank of America href: type: string description: URL endpoint for the bank account. readOnly: true example: /objects/cash-management/bank-account/1 reversalDate: type: string format: date example: '2021-09-23' description: Date transaction reversal started. readOnly: true reversedDate: type: string format: date example: '2021-09-23' description: Date transaction was reversed. readOnly: true reversedVoidPaymentKey: type: string description: System-assigned key to uniquely identify reversed voided payments. readOnly: true example: '1235' voidPaymentKey: type: string description: System-assigned key to uniquely identify voided payments. readOnly: true example: '1236' postingDate: type: string format: date example: '2021-09-23' description: Date the deposit was posted. attachment: type: object description: Supporting document attached to the deposit. properties: key: type: string description: System-assigned key for the supporting document. example: '18' id: type: string description: System-assigned ID for the supporting document. example: '18' href: type: string description: URL endpoint for the supporting document. readOnly: true example: /objects/company-config/attachment/18 lines: type: array description: Line items for the deposited receipts. items: readOnly: true $ref: '#/components/schemas/cash-management-deposit-line' details: type: array description: Funds that are part of this deposit. items: $ref: '#/components/schemas/cash-management-deposit-detail' audit: readOnly: true type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true entity: $ref: '#/components/schemas/entity-ref' cash-management-financial-institutionRequiredProperties: type: object required: - id cash-management-financial-institution: type: object properties: key: type: string description: System-assigned key for the financial institution. readOnly: true example: '1' id: type: string description: Unique identifier for the financial institution. example: USA_FinInst name: type: string description: Name of the financial institution. example: USA financial institution addOnServices: type: array description: Services associated with the financial institution. items: type: object properties: name: type: string example: MAL serviceContract: type: object properties: key: type: string example: BOA accountType: type: string enum: - checking - savings - creditCard example: checking checkingAccounts: type: array description: Checking accounts associated with the financial institution. items: type: object properties: key: type: string example: '2' externalBankAccount: type: object properties: id: type: string writeOnly: true example: a421d6c8-ed48-454d-a60e-7b697c67b956 name: type: string writeOnly: true example: Plaid Checking requestedStartDate: type: string format: date writeOnly: true example: '2021-01-23' savingsAccounts: type: array description: Savings accounts associated with the financial institution. items: type: object properties: key: type: string example: '2' externalBankAccount: type: object properties: id: type: string writeOnly: true example: a421d6c8-ed48-454d-a60e-7b697c67b956 name: type: string writeOnly: true example: Plaid Saving requestedStartDate: type: string format: date writeOnly: true example: '2021-01-23' creditCards: type: array description: Credit card accounts associated with the financial institution. readOnly: true items: type: object properties: key: type: string example: '2' externalBankAccount: type: object properties: id: type: string writeOnly: true example: a421d6c8-ed48-454d-a60e-7b697c67b956 name: type: string writeOnly: true example: Plaid CC requestedStartDate: type: string format: date writeOnly: true example: '2021-01-23' totalAccounts: type: integer description: Total number of accounts associated with the financial institution. readOnly: true example: 5 href: type: string readOnly: true example: /objects/cash-management/financial-institution/1 audit: readOnly: true type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: modifiedBy: type: string description: User who modified this. example: Admin readOnly: true entity: $ref: '#/components/schemas/entity-ref' 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 cash-management-funds-transfer-line: type: object description: >- Funds transfer transaction line items representing the general ledger postings generated by the funds transfer transaction. properties: id: type: string description: Unique identifier for the funds transfer line item. readOnly: true example: '62' key: type: string description: System-assigned unique key for the funds transfer line item. readOnly: true example: '62' href: type: string description: URL endpoint for the funds transfer line item. readOnly: true example: /objects/cash-management/funds-transfer-line/62 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 funds transfer transaction. readOnly: true example: '3000.54' txnAmount: type: string readOnly: true format: decimal-precision-2 description: >- For multi-currency companies, provide a transaction amount, which is the amount in the transaction currency. example: '2003.00' currency: type: object allOf: - $ref: '#/components/schemas/currency' readOnly: true lineNumber: type: integer description: Line number for the funds transfer line items. readOnly: true example: 1 glAccount: $ref: '#/components/schemas/gl-account-ref' readOnly: true 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: Unique 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: URL endpoint for the location. readOnly: true example: /objects/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: Unique key for the department. readOnly: true example: '9' id: type: string description: Unique identifier of the department. example: '01' name: type: string description: Name of the department. readOnly: true example: Accounting href: type: string description: URL endpoint for the department. readOnly: true example: /objects/department/9 fundsTransfer: type: object description: >- Funds transfer transaction that contains the funds transfer line items. readOnly: true properties: key: type: string description: Unique key for the funds transfer transaction. readOnly: true example: '100' id: type: string description: Unique identifier for the funds transfer transaction. readOnly: true example: '100' href: type: string description: URL for the funds transfer transaction. readOnly: true example: /objects/cash-management/funds-transfer/100 audit: $ref: '#/components/schemas/audit' readOnly: true funds-transferRequiredProperties: type: object required: - sendDate properties: transferFromAccount: type: object required: - transferAmount properties: bankAccount: type: object required: - id transferToAccount: type: object required: - receivedAmount properties: bankAccount: type: object required: - id cash-management-funds-transfer: type: object description: >- Transaction that records the movement of funds from one cash account to another. Cash accounts include checking accounts and savings accounts. properties: key: type: string description: System-assigned unique key for the funds transfer transaction. readOnly: true example: '1001' id: type: string description: Unique identifier for the transaction. readOnly: true example: '1001' href: type: string description: URL endpoint for the transaction. readOnly: true example: /objects/cash-management/funds-transfer/1001 sendDate: type: string format: date example: '2021-11-30' description: Date the funds transfer is scheduled or sent for processing. referenceNumber: type: string description: Reference number assigned to the transaction. example: TRANSFER-155 BOA to CHSE description: type: string description: Brief description of the purpose of the funds transfer. example: Funds transfer from Bank of America to Chase Bank. attachment: type: object description: >- Supporting document attached to the transaction to provide additional information. properties: key: type: string description: Unique key for the attachment example: '1' id: type: string description: Unique identifier for the attachment. example: '1' href: type: string description: URL endpoint for the attachment. readOnly: true example: /objects/attachment/1 transferFromAccount: type: object description: >- Originating bank account from which the funds are withdrawn for the transfer. properties: bankAccount: type: object properties: key: type: string readOnly: true description: Unique key for the originating account. example: '1004' id: type: string description: >- Unique identifier for the originating account, for example the account number. example: CHASE name: type: string readOnly: true description: >- Name of the account from which the funds are withdrawn for the transfer. example: Chase bank href: type: string description: URL endpoint for the for the originating account. readOnly: true example: /objects/cash-management/bank-account/1004 currency: type: string readOnly: true description: Currency associated with the originating account. example: USD accountType: type: string description: >- Type of account from which the funds are withdrawn for the transfer. readOnly: true example: checking enum: - checking - savings - debit - credit glAccountNumber: type: string readOnly: true description: >- General ledger account number associated with the originating account. example: '1010' transferAmount: type: string format: decimal-precision-2 description: >- For multi-currency companies, specify the transaction amount in the currency of the originating account. example: '2500.10' transferToAccount: type: object description: >- Receiving bank account into which the funds are deposited during the funds transfer. properties: bankAccount: type: object properties: key: type: string readOnly: true description: Unique key for the receiving account. example: '1002' id: type: string description: >- Unique identifier for the receiving account, for example the account number. example: BOA name: type: string readOnly: true description: Name of the account receiving the funds during the transfer. example: Bank of America href: type: string description: URL endpoint for the receiving account. readOnly: true example: /objects/cash-management/bank-account/10 currency: type: string description: Currency associated with the receiving account. readOnly: true example: EUR accountType: type: string description: Type of account receiving the funds during the transfer. readOnly: true example: checking enum: - checking - savings - debit - credit glAccountNumber: type: string readOnly: true description: >- General ledger account number associated with the receiving account. example: '1001' receivedAmount: type: string format: decimal-precision-2 description: >- For multi-currency companies, specify the transaction amount in the currency of the receiving account. example: '2500.10' baseCurrencyConversion: type: object description: >- Exchange rate information used for the base currency conversion in the funds transfer transaction. properties: transferFromCurrency: type: object description: >- Currency of the originating account used in the funds transfer transaction. properties: companyBaseCurrency: type: string description: Base currency assigned to the originating account. example: USD exchangeRateDate: type: string format: date example: '2014-01-08' description: >- Date of the exchange rate used to convert the originating account's currency into the transaction currency. exchangeRateTypeId: type: string description: >- Type of exchange rate used for the originating account's currency conversion. example: Intacct Daily Rate exchangeRate: type: number description: >- Exchange rate used for the originating account's currency conversion. example: 0.78 baseCurrencyAmount: type: string format: decimal-precision-2 description: >- Total amount withdrawn from the originating account, recorded in the account's base currency. readOnly: true example: '1500.01' transferToCurrency: type: object description: >- Currency of the receiving account used in the funds transfer transaction. properties: companyBaseCurrency: type: string description: >- Company's designated base currency for recording deposits into the receiving account. example: USD exchangeRateDate: type: string format: date example: '2014-01-08' description: >- Date of the exchange rate used to convert receiving account's currency into the transaction currency. exchangeRateTypeId: type: string description: >- Exchange rate type used for the receiving account's currency conversion. example: Intacct Daily Rate exchangeRate: type: number description: >- Exchange rate used for the receiving account's currency conversion. example: 0.78 baseCurrencyAmount: type: string format: decimal-precision-2 description: >- Total amount deposited to the receiving account, recorded in the company's base currency. readOnly: true example: '1500.01' state: type: string description: >- State of the funds transfer transaction. `Reversed` means the transaction has been reversed. `Reversal` is the state of the new transaction created when the original transaction was reversed. enum: - reversed - reversal - posted readOnly: true example: posted reconciliationState: type: string description: >- Indicates the reconciliation state of the funds transfer transaction, if this transaction has been cleared or matched for financial account reconciliation. readOnly: true example: matched enum: - cleared - uncleared - matched default: uncleared reversedBy: type: object description: >- Reference to the funds transfer transaction that reversed this transaction. This will have a value when the transaction state is `reversed`. readOnly: true properties: key: type: string description: Unique key for the reversing transaction. readOnly: true example: '221' id: type: string description: Unique identifier for the reversing transaction. readOnly: true example: '221' reversalDate: type: string format: date readOnly: true example: '2021-01-23' description: Date of the transaction reversal. href: type: string description: URL endpoint for the reversing transaction. readOnly: true example: /objects/cash-management/funds-transfer/221 reversalOf: type: object description: >- Reference to the funds transfer transaction that was reversed by this transaction. This will have a value when the transaction state is `reversal`. readOnly: true properties: key: type: string description: Unique key for the reversed transaction. readOnly: true example: '125' id: type: string description: Unique identifier for the reversed transaction. readOnly: true example: '125' txnDate: type: string format: date readOnly: true example: '2021-10-22' description: Date of original funds transfer transaction. href: type: string description: URL endpoint for the reversed transaction. readOnly: true example: /objects/cash-management/funds-transfer/125 lines: type: array description: Line items for the funds transfer transaction. items: $ref: '#/components/schemas/cash-management-funds-transfer-line' entity: $ref: '#/components/schemas/entity-ref' audit: readOnly: true type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2024-01-08T11:28:12Z' readOnly: true cash-management-journal-entry-line-template: type: object description: Template for bank transaction rule journal entry lines. properties: key: type: string description: >- System-assigned key for the bank transaction rule journal entry line template. readOnly: true example: '1' id: type: string description: >- ID for the bank transaction rule journal entry line template. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '1' href: type: string description: URL for the bank transaction rule journal entry line template. readOnly: true example: /objects/cash-management/journal-entry-line-template/1 documentId: type: string description: Document number of the transaction. example: doc11 memo: type: string description: Memo example: memo-created-by-rule numberOfUnits: type: integer description: Number of units example: 100 exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: '1' txnType: type: string description: Transaction type; 1 for Debit, -1 for Credit. example: debit enum: - null - debit - credit nullable: true default: null isBillable: type: boolean description: Indicates whether the transaction is billable. example: true default: false allocation: type: object properties: id: type: string example: '2' key: type: string example: '2' href: type: string readOnly: true example: /objects/allocation/2 glAccount: $ref: '#/components/schemas/gl-account-ref' dimensions: $ref: '#/components/schemas/dimension-ref' journalEntryTemplate: type: object description: Header level details for the journal entry template's lines. properties: id: type: string description: ID for the bank transaction rule journal entry template. example: '2' key: type: string description: >- System-assigned key for the bank transaction rule journal entry template. example: '2' href: type: string description: URL for the bank transaction rule journal entry template. readOnly: true example: /objects/cash-management/journal-entry-template/2 cash-management-journal-entry-templateRequiredProperties: type: object required: - id - name - glJournal - lines cash-management-journal-entry-template: type: object description: >- Transaction templates define how to create new transactions in Sage Intacct based on data from an import file or bank feed. properties: key: type: string description: System-assigned key for the journal entry transaction template. readOnly: true example: '1' id: type: string description: ID for the journal entry transaction template. example: JE-tmpl-1 href: type: string description: URL for the journal entry transaction template. readOnly: true example: /objects/cash-management/journal-entry-template/1 name: type: string description: Name of the journal entry transaction template. example: JournalEntry-tmpl-1 description: type: string description: Description of the journal entry transaction template. example: GL template for banks postingState: type: string description: >- Set the state in which to create the transaction, `Draft` or `Posted`. example: draft enum: - draft - posted glJournal: type: object description: GL journal to which entries will post. properties: key: type: string description: System-assigned key for the gl-journal. example: '3' id: type: string description: Symbol of the journal to which entries will post. example: APJ href: type: string description: URL for this journal. example: /objects/general-ledger/journal/3 readOnly: true lines: type: array items: $ref: '#/components/schemas/cash-management-journal-entry-line-template' audit: readOnly: true $ref: '#/components/schemas/audit' status: $ref: '#/components/schemas/status' entity: $ref: '#/components/schemas/entity-ref' numberOfRulesUsingTemplate: type: integer description: Count of rules this transaction template is used in. readOnly: true example: 1 default: 0 taxImplication: type: string description: Tax implications to the transaction in tax enabled companies. example: none nullable: true enum: - null - none - inbound - outbound default: null taxSolution: type: object description: >- Tax solution. Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK Vat. properties: key: type: string description: System-assigned key for the tax solution. example: '11' id: type: string description: ID for the tax solution. example: Australia GST href: readOnly: true description: URL for the tax solution. type: string example: /objects/tax/tax-solution/11 purchasingTaxSchedule: type: object description: >- In tax enabled companies tax schedule used to capture tax details in the purchasng transaction. properties: key: type: string description: System-assigned key for the tax schedule. example: '1' id: type: string description: Unique identifier of the tax schedule. example: '1' name: type: string readOnly: true description: Tax Schedule ID. example: PO-TaxSched-001 href: type: string description: URL of the tax schedule object. readOnly: true example: /objects/tax/purchasing-tax-schedule/1 salesTaxSchedule: type: object description: >- In tax enabled companies tax schedule used to capture tax details in the sales transaction. properties: key: type: string description: System-assigned key for the tax schedule. example: '7' id: type: string description: Unique identifier of the tax schedule. example: '7' name: type: string readOnly: true description: Tax Schedule ID. example: SO-TaxSched-001 href: type: string description: URL of the tax schedule object. readOnly: true example: /objects/tax/order-entry-tax-schedule/7 customer: type: object description: Tax customer. properties: key: type: string description: System-assigned key for customer. example: '23' id: type: string description: Tax customer id. example: Cust-1 name: type: string readOnly: true description: Tax customer name. example: Customer 1 href: type: string description: Tax customer. readOnly: true example: /objects/accounts-receivable/customer/23 vendor: type: object description: Tax vendor. properties: key: type: string description: System-assigned key for vendor. example: '3' id: type: string description: Tax vendor id. example: Vend-1 name: type: string readOnly: true description: Tax vendor name. example: Vendor 1 href: type: string description: Tax vendor. readOnly: true example: /objects/accounts-payable/vendor/3 cash-management-other-receipt-tax-entry: type: object description: Other receipt tax entry allOf: - $ref: '#/components/schemas/tax-entries' - type: object properties: taxDetail: type: object description: >- Order Entry tax details describe a specific type of tax that applies to lines in Accounts Receivable and Order Entry transactions. properties: key: type: string description: System-assigned key for the tax detail. example: '1' id: type: string description: Unique identifier of the tax detail. example: Alaska Tax Detail href: type: string description: URL of the tax detail object. readOnly: true example: /objects/tax/order-entry-tax-detail/1 otherReceiptLine: title: otherReceiptLine type: object properties: id: type: string description: Identifier for the other receipt line object. example: '100' readOnly: true key: type: string description: System-assigned key for the other receipt line object. example: '100' readOnly: true href: type: string description: URL for the other receipt line object. readOnly: true example: /objects/cash-management/other-receipt-line/100 cash-management-other-receipt-line: type: object description: >- Line items in an other receipts object represent transactions that are not associated with a customer or invoice. properties: key: type: string description: System-assigned key for the other receipts line item. readOnly: true example: '123' id: type: string description: Identifier for the other receipts line item. readOnly: true example: '123' href: type: string description: URL for the other receipts line item. readOnly: true example: /objects/cash-management/other-receipt/10 amount: type: string format: decimal-precision-2 description: For single-currency companies, amount of the line item receipt. example: '100.99' totalTxnAmount: type: string format: decimal-precision-2 description: For multi-currency companies, amount of the line item receipt. example: '100.99' txnAmount: type: string format: decimal-precision-2 description: For multi-currency companies, amount of the line item receipt. example: '100.99' description: type: string description: Description of the other receipts line item. example: Cash receipt for rental invoice account 101 exchangeRate: type: object description: Exchange rate used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: '1' lineNumber: type: integer description: Line number for the other receipts line item. example: 1 baseCurrency: type: string description: For multi-currency companies, the company's base currency. readOnly: true example: USD currency: type: string description: For multi-currency companies, the currency for the transaction. readOnly: true example: USD isTax: type: boolean description: Indicates whether the line item amount includes taxes. example: false default: false arAccountLabel: type: object description: Label for the account associated with the line item. properties: key: type: string description: System-assigned key for the account label. example: '102' id: type: string description: ID for the account label. example: SW Sales href: type: string description: URL for the account label. readOnly: true example: /objects/araccountlabel/102 glAccount: type: object description: GL account for the line item. properties: key: type: string description: System-assigned key for the GL account. example: '55' id: type: string description: Unique identifier for the GL account. example: '1001' href: type: string description: URL for the GL account. readOnly: true example: /objects/glaccount/55 dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object description: Location associated with this line item. properties: key: type: string description: System-assigned key for the location. example: '5' id: type: string description: Location ID example: CAHO name: type: string description: Location name example: California Head Office href: type: string description: URL for the location. readOnly: true example: /objects/company-config/location/5 department: type: object description: Department associated with the line item. properties: key: type: string description: System-assigned key for the department. example: '10' id: type: string description: Unique identifier for the department. example: ENGINEERING number: type: string description: Department number example: '10' name: type: string description: Department name example: Engineering department href: type: string description: URL for the department. readOnly: true example: /objects/company-config/department/10 otherReceipts: type: object description: Header level details for the other receipts object's line entries. properties: key: type: string description: System-assigned key for the other receipts object. readOnly: true example: '100' id: type: string description: Identifier for the other receipts object. readOnly: true example: '100' recordType: type: string description: Record type of the other receipts object. readOnly: true example: cr href: type: string description: URL for the other receipts object. readOnly: true example: /objects/cash-management/other-receipt/5 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' taxEntries: type: array description: Tax Entries of the other receipt items: $ref: '#/components/schemas/cash-management-other-receipt-tax-entry' cash-management-other-receiptRequiredProperties: type: object required: - payer - txnDate - depositDate - txnPaidDate - paymentMethod - bankAccount properties: lines: type: array items: type: object required: - txnAmount - glAccount cash-management-other-receipt: type: object description: >- Other receipts are receipts that are not associated with a customer or invoice. Other receipts can include cash, a card charge, a cash transfer, or a check payment. properties: key: type: string description: System-assigned key for the other receipts object. readOnly: true example: '1299' id: type: string description: >- Identifier for the other receipts object. This value is the same as the key for this object. readOnly: true example: '1299' recordType: type: string description: Record type for the other receipts object. readOnly: true example: cr payer: type: string description: Name of the payer. example: Benson Hugo txnDate: type: string format: date description: >- Date of the transaction. Typically, this is the check date, but can be the date of a credit card, record transfer, or cash transaction. example: '2021-01-23' txnPaidDate: type: string format: date description: Date the transaction was paid. example: '2021-01-23' txnNumber: type: string description: Transaction number. example: '22365' description: type: string description: Description of the other receipts object. example: Refund for overpayment arSummary: type: object description: AR summary in which the other receipts transaction is included. properties: key: type: string description: System-assigned key for the AR summary. example: '100' id: type: string description: Identifier for the AR summary. example: '100' date: type: string format: date description: Summary date. example: '2023-10-10' href: type: string description: URL endpoint for the AR summary. readOnly: true example: /objects/accounts-receivable/summary/10 baseCurrency: type: string description: For multi-currency companies, the company's base currency. example: USD currency: type: string description: For multi-currency companies, the currency for the transaction. example: USD totalEntered: type: string format: decimal-precision-2 description: Total base amount entered. example: '100.99' readOnly: true txnTotalEntered: type: string format: decimal-precision-2 description: Total transaction amount entered. example: '100.99' readOnly: true reconciliationDate: type: string format: date description: Reconciliation date for the payment. example: '2021-01-23' state: type: string description: State of the other receipts object. example: approved enum: - approved - reversed - reversal - reconciled - deposited reconciliationState: type: string description: Indicates whether the receipts have been cleared or matched. example: cleared enum: - cleared - uncleared - matched default: uncleared parentDeposit: type: object description: Parent deposit payment. properties: href: type: string description: URL endpoint for the parent deposit. readOnly: true example: /objects/cash-management/deposit/3319 key: type: string description: System-assigned key for the parent deposit. example: '3319' id: type: string description: Identifier for the parent deposit. example: '3319' isInclusiveTax: type: boolean description: >- Set to `true` if the amount for each line item already includes taxes. example: true default: false bankAccount: type: object description: >- Bank account into which all payments in the other receipts object are deposited. This account is required if an 'undepositedAccount' is not specified. properties: key: type: string description: System-assigned key for the bank account. example: '1002' id: type: string description: Account number or other unique identifier for the bank account. example: BOA name: type: string description: Name of the bank account. example: Bank of America currency: type: string description: Currency for the bank account. example: USD href: type: string description: URL for the bank account. readOnly: true example: /objects/cash-management/bank-account/10 undepositedAccount: type: object description: >- The GL undeposited funds account to use when accumulating receipts for deposit. This account is required if a 'bankAccount' is not specified. properties: key: type: string description: System-assigned key for the undeposited funds account. example: '19' id: type: string description: General ledger undeposited funds account number. example: 1020--Undeposited Funds href: type: string readOnly: true example: /objects/general-ledger/account/19 depositDate: type: string format: date description: Deposit date for payments deposited to a bank account. example: '2021-01-23' exchangeRate: type: object description: Exchange rate details used to calculate the base amount. properties: date: type: string format: date example: '2021-01-23' description: >- Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid. rate: type: number description: >- Exchange rate used to calculate the base amount from the transaction amount. example: 1.0789 typeId: type: string description: >- Exchange rate type used to calculate the base amount from the transaction amount. example: '1' paymentMethod: type: string description: Payment method for the transaction. enum: - printedCheck - creditCard - eft - cash example: eft reversalDate: type: string format: date example: '2024-01-23' description: Date transaction reversal started. readOnly: true reversedDate: type: string format: date example: '2024-01-23' description: Date transaction was reversed. readOnly: true reversedVoidPaymentKey: type: string description: System-assigned key to uniquely identify reversed void payments. readOnly: true example: '1400' taxSolution: type: object description: Tax solution used to calculate taxes on the transaction. properties: key: type: string description: System-assigned key for the tax solution. example: '123' id: type: string description: Unique identifier for the tax solution. example: CATAXSOLUTIONID enableMultilineTax: type: boolean description: Set to `true` to enable multiple taxes per line. example: false default: false taxCalculationMethod: type: string description: >- Method used to apply sales tax during transaction entry, such as Advanced or Simple. example: Simple href: type: string description: URL endpoint for the tax solution. readOnly: true example: /objects/tax/tax-solution/5 voidPaymentKey: type: string description: System-assigned key to uniquely identify reversed, voided payments. readOnly: true example: '1923' sourceModule: type: string description: Source module for the other receipt. enum: - cashManagement - loanManagement example: cashManagement default: cashManagement href: type: string description: URL endpoint for the other receipts object. readOnly: true example: /objects/cash-management/other-receipt/10 audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission format: date-time example: '2014-01-08T11:28:12Z' readOnly: true lines: type: array description: Line items of the other receipts transaction. items: $ref: '#/components/schemas/cash-management-other-receipt-line' entity: $ref: '#/components/schemas/entity-ref' paymentProviderRequiredProperties: type: object required: - id - name cash-management-provider-payment-method: type: object description: Provider payment methods properties: key: type: string description: System-assigned key for the provider payment method. readOnly: true example: '454' id: type: string description: Unique identifier for the provider payment method. readOnly: true example: '454' href: type: string readOnly: true example: /objects/cash-management/provider-payment-method/454 paymentType: type: string description: Payment type for the provider payment method. example: CHECK status: $ref: '#/components/schemas/status' paymentProvider: type: object properties: key: type: string description: System-assigned key for the payment provider. example: '3' id: type: string description: Unique identifier for the payment provider. example: CSI name: type: string description: Name of the payment provider. example: CSI href: type: string readOnly: true example: /objects/cash-management/payment-provider/3 example: id: CSI name: CSI key: '3' href: /objects/cash-management/payment-provider/3 audit: $ref: '#/components/schemas/audit' cash-management-payment-provider: type: object description: Payment provider object properties: key: type: string description: System-assigned key for the payment provider. readOnly: true example: '3' id: type: string description: Unique identifier for the payment provider. example: CSI readOnly: true href: type: string readOnly: true example: /objects/cash-management/payment-provider/3 state: type: string enum: - requestInitiated - inProgress - requestReceived - requestFailed - awaitingAuthorization - subscribed - canceled - suspended - pending description: Subscription state of the payment provider. default: inProgress example: requestInitiated name: type: string description: Name of the payment provider. example: CSI paymentWithdrawalType: type: string description: Mode of withdrawal of payment funds. enum: - lumpSum - perTransaction example: lumpSum readOnly: true contactInfo: type: object properties: email: type: string description: Email Id of the primary contact person for notifications. example: pavan@company.com readOnly: true firstName: type: string description: First name of the primary contact person. readOnly: true example: John lastName: type: string description: Last name of the primary contact person. readOnly: true example: Doe paymentMethods: type: array items: $ref: '#/components/schemas/cash-management-provider-payment-method' audit: $ref: '#/components/schemas/audit' providerPaymentMethodRequiredProperties: type: object required: - id - name cash-management-savings-accountRequiredProperties: type: object required: - id - location properties: bankAccountDetails: type: object required: - bankName - currency accounting: type: object required: - glAccount cash-management-savings-account: type: object properties: key: type: string description: System-assigned key for the savings account. readOnly: true example: '34' id: type: string description: >- Name or other unique identifier for the savings account. The account ID cannot be modified. example: SBI href: type: string description: URL for the savings account. readOnly: true example: /objects/cash-management/savings-account/34 bankAccountDetails: type: object description: Bank account details properties: accountNumber: type: string description: Bank account number for this savings account. example: '4356789400' bankName: type: string description: Name of the bank for this savings account. example: Bank of the West routingNumber: type: string description: Routing number for this savings account. example: '123456791' branchId: type: string description: Bank branch ID for this savings account. example: 123456791' phoneNumber: type: string description: Phone number of the bank branch. example: 555-927-6200 currency: type: string description: >- The currency for this account. The default is the base currency for the company or entity. If this account is with a foreign bank, the currency should match the country. example: USD bankAddress: type: object properties: city: type: string description: City where the bank is located. example: Fremont state: type: string description: State where the bank is located. example: CA postCode: type: string description: Zip or postal code for the bank. example: '94536' country: type: string description: Country where the bank is located. example: United States addressLine1: type: string description: Line 1 of the street address for the bank. example: 39148 Paseo Padre Pkwy addressLine2: type: string description: Line 2 of the street address for the bank. example: Suite 104 addressLine3: type: string description: >- Line 3 of the street address for the bank which provides additional geographical information. example: Western industrial area accounting: type: object description: Accounting information properties: glAccount: type: object description: >- General Ledger account that this savings account is associated with. properties: key: type: string example: '90' id: type: string example: 1047--Savings a/c France href: type: string readOnly: true example: /objects/general-ledger/account/31 apJournal: type: object description: Default payables GL journal properties: key: type: string description: System-assigned key for the gl-journal. example: '3' id: type: string description: The id of the journal example: AP ADJ--AP Adjustment Journal href: type: string description: URL for this journal. example: /objects/general-ledger/journal/3 readOnly: true arJournal: type: object description: Default receivables GL journal properties: key: type: string description: System-assigned key for the gl-journal. example: '3' id: type: string description: The id of the journal example: AR ADJ--AR Adjustment Journal href: type: string description: URL for this journal. example: /objects/general-ledger/journal/3 readOnly: true bankingTimeZone: type: string description: Time zone allOf: - $ref: '#/components/schemas/timezone' default: null example: GMT+02:00 Eastern Europe Time disableInterEntityTransfer: type: boolean description: >- Exclude this account from inter-entity transfers (IET) even if IET is globally enabled for the entire multi-entity shared structure of companies. default: false example: 'false' serviceChargeGLAccount: type: object description: >- General ledger account for service charges. Used for reconciliation. properties: key: type: string example: '13' id: type: string example: 1004--Lloyds bank href: type: string readOnly: true example: /objects/general-ledger/account/13 serviceChargeAccountLabel: type: object description: General ledger account label for service charges. properties: key: type: string example: '8' id: type: string example: Accounting Fees href: type: string example: /objects/accounts-payable/account-label/8 interestGLAccount: type: object description: >- General ledger account for earned interest. Used for reconciliation. properties: key: type: string example: '15' id: type: string example: 1006--Banorte Bank href: type: string readOnly: true example: /objects/general-ledger/account/15 interestAccountLabel: type: object description: General ledger account label for earned interest. properties: key: type: string example: '35' id: type: string example: Interest Fees href: type: string readOnly: true example: /objects/accounts-receivable/account-label/35 reconciliation: type: object description: Reconciliation information properties: lastReconciledBalance: type: string description: Last reconciled balance. format: decimal-precision-2 readOnly: true example: '600.00' lastReconciledDate: type: string format: date description: Date of the last reconciliation. readOnly: true example: '2022-02-28' cutOffDate: type: string format: date description: The date after which initial reconciliation can begin. readOnly: true example: '2022-02-28' inProgressBalance: type: string description: In progress reconciliation balance. format: decimal-precision-2 readOnly: true example: '200.00' inProgressDate: type: string format: date description: In progress reconciliation date. readOnly: true example: '2022-01-28' matchSequence: type: object description: Reconciliation match sequence properties: key: type: string description: System-assigned key for the document sequence number. example: '2' id: type: string description: Document sequence ID example: 2--Bank sequence Id href: type: string description: URL for the sequence number. example: /objects/company-config/document-sequence/2 readOnly: true useMatchSequenceForAutoMatch: type: boolean default: true description: Use sequence number for automatically matched transactions. example: false useMatchSequenceForManualMatch: type: boolean default: true description: Use sequence number for manually matched transactions. example: false department: type: object description: department properties: key: type: string example: '8' id: type: string example: 8--Finance href: type: string readOnly: true example: /objects/company-config/department/8 location: type: object description: location properties: key: type: string example: '4' id: type: string example: 4--Australia href: type: string readOnly: true example: /objects/company-config/location/4 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' entity: $ref: '#/components/schemas/entity-ref' bankingCloudConnection: $ref: '#/components/schemas/banking-cloud-connection' financialInstitution: description: Financial institution reference type: object properties: id: type: string readOnly: true example: FinOne key: type: string readOnly: true example: '1' href: type: string readOnly: true example: /objects/cash-management/financial-institution/1 readOnly: true ruleSet: type: object description: Applied rule set properties: key: type: string example: '1' id: type: string example: 36--RuleSetToMatch href: type: string readOnly: true example: /objects/cash-management/bank-txn-rule-set/1 restrictions: type: object description: >- Restrict a bank account to a specfic location or restrict one or more entity/locations to a specific account. properties: restrictionType: type: string description: > Set which entities/locations within the company can access and use this checking account. **Valid values** - `unrestricted` - (default) This account is available to the top-level company and all entity-level locations. - `rootOnly` - Only the top-level company of a multi-entity structure can access this account. - `restricted` - Only specified locations, location groups, departments, or department groups can access this account. enum: - unrestricted - rootOnly - restricted example: unrestricted default: unrestricted locations: type: array description: >- List of locations that can access this checking account when `restrictionType` is set to `restricted`. items: type: string example: - 1--United States of America - 2--United Kingdom responses: 400error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error-response' 404error: description: Not Found content: application/json: schema: $ref: '#/components/schemas/error-response' 422error: description: Unprocessable entity content: application/json: schema: $ref: '#/components/schemas/error-response' securitySchemes: OAuth2: description: Sage Intacct OAuth 2.0 authorization code flow type: oauth2 flows: authorizationCode: authorizationUrl: https://api.intacct.com/ia/api/v1/oauth2/authorize tokenUrl: https://api.intacct.com/ia/api/v1/oauth2/token refreshUrl: https://api.intacct.com/ia/api/v1/oauth2/token scopes: {}