Checking accounts

A checking account object models a real-world checking account at a bank and supports checking account reconciliation.

Get a checking account

get/objects/cash-management/checking-account/{key}

Returns detailed information for a specified checking account.

Permissions and other requirements
SubscriptionCash Management
User typeBusiness, Employee, Project Manager
PermissionsList, View Checking Accounts
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the checking account.

Example: 99
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "BOA-000987g",
    • "bankAccountDetails": {
      • "accountNumber": "890000088",
      • "bankName": "Bank of America",
      • "routingNumber": "123456789",
      • "branchId": "00-1355",
      • "phoneNumber": "9007780000",
      • "bankAddress": {
        },
      • "currency": "GBP",
      • "accountHolderName": "ACME Software"
      },
    • "accounting": {
      • "glAccount": {
        },
      • "apJournal": {
        },
      • "arJournal": {
        },
      • "bankingTimeZone": "GMT+05:30 Bombay, Calcutta, Madras, New Delhi",
      • "serviceChargeGLAccount": {
        },
      • "serviceChargeAccountLabel": {
        },
      • "interestGLAccount": {
        },
      • "interestAccountLabel": {
        },
      • "disableInterEntityTransfer": false
      },
    • "checkPrinting": {
      • "addressSettings": {
        },
      • "micrSettings": {
        },
      • "printSettings": {
        },
      • "signatures": {
        },
      • "disablePrinting": false
      },
    • "reconciliation": {
      • "matchSequence": {
        },
      • "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
    }
}
Create a checking account
post/objects/cash-management/checking-account/{key}
Creates a new checking account.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the checking account.


 
 Example:  99
Request Body schema: application/json
required
id
required
string
Name or other unique identifier for the checking account. The ID cannot be modified.


 
 Example:  "BOA"
required
object
Location to use for GL posting (optional).


 
key
string
 
 Example:  "1"
id
string
 
 Example:  "1--United States of America"
object
Bank account details


 
bankName
required
string
Name of the bank for this checking account.


 
 Example:  "Bank of America"
currency
required
string
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"
accountNumber
string
Bank account number for this checking account.


 
 Example:  "4356789402"
accountHolderName
string  <= 100 characters 
The official name that the bank has on file for this checking account.


 
 Example:  "ABC Software"
routingNumber
string
Routing number for this checking account.


 
 Example:  "121000358"
branchId
string
Bank branch ID for this checking account.


 
 Example:  "89099"
phoneNumber
string
Phone number of the bank branch.


 
 Example:  "5559878978"
object
 
city
string
City where the bank is located.


 
 Example:  "Newark"
state
string
State where the bank is located.


 
 Example:  "CA"
postCode
string
Zip or postal code for the bank.


 
 Example:  "94560"
country
string
Country where the bank is located.


 
 Example:  "United States"
addressLine1
string
Line 1 of the street address for the bank.


 
 Example:  "36900 Neward Blvd"
addressLine2
string
Line 2 of the street address for the bank.


 
 Example:  "Suite 101"
addressLine3
string
Line 3 of the street address for the bank which provides additional geographical information.


 
 Example:  "Western industrial area"
object
Accounting Information


 
required
object
General Ledger account that this checking account is associated with.


 
key
string
 
 Example:  "256"
id
string
 
 Example:  "9899--My Ledger Account-33"
name
string
Name or title of the account, which appears on report headings.


 
 Example:  "Expense Account"
object
Default payables GL journal


 
key
string
System-assigned key for the gl-journal.


 
 Example:  "3"
id
string
The id of the journal


 
 Example:  "AP ADJ--AP Adjustment Journal"
object
Default receivables GL journal


 
key
string
System-assigned key for the gl-journal.


 
 Example:  "3"
id
string
The id of the journal


 
 Example:  "AR ADJ--AR Adjustment Journal"
disableInterEntityTransfer
boolean
 Default:  false
Exclude this account from inter-entity transfers (IET) even if IET is globally enabled for the entire multi-entity shared structure of companies.


 
 Example:  false
object
General ledger account for service charges. Used for reconciliation.


 
key
string
 
 Example:  "432"
id
string
 
 Example:  "0077--My Ledger Account 54"
object
General ledger account label for service charges.


 
key
string
 
 Example:  "15"
id
string
 
 Example:  "Car Payment"
object
General ledger account for earned interest. Used for reconciliation.


 
key
string
 
 Example:  "419"
id
string
 
 Example:  "0099--My Ledger Account 40"
object
General ledger account label for earned interest.


 
key
string
 
 Example:  "35"
id
string
 
 Example:  "Sales"
bankingTimeZone
string or null
 Default:  null
Time zone


 Enum: "GMT (Greenwich Mean Time) Dublin, Edinburgh, London" "GMT+00:00 Western Europe Time" "GMT+01:00 Berlin, Stockholm, Rome, Bern, Brussels" "GMT+01:00 British Summer Time" "GMT+01:00 Central Europe Time" "GMT+01:00 Irish Summer Time" "GMT+01:00 Lisbon, Warsaw" "GMT+01:00 Paris, Madrid" "GMT+01:00 Prague" "GMT+01:00 Western Europe Summer Time" "GMT+02:00 Athens, Helsinki, Istanbul" "GMT+02:00 Cairo" "GMT+02:00 Central Europe Summer Time" "GMT+02:00 Eastern Europe Time" "GMT+02:00 Harare, Pretoria" "GMT+02:00 Israel" "GMT+03:00 Baghdad, Kuwait, Nairobi, Riyadh" "GMT+03:00 Eastern Europe Summer Time" "GMT+03:00 Moscow, St. Petersburg, Volgograd" "GMT+03:30 Tehran" "GMT+04:00 Abu Dhabi, Muscat, Tbilisi, Kazan" "GMT+04:00 Moscow Summer Time" "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 (Australian) Western Standard Time" "GMT+08:00 Beijing, Chongqing, Urumqi" "GMT+08:00 Hong Kong SAR, Perth, Singapore, Taipei" "GMT+09:00 Tokyo, Osaka, Sapporo, Seoul, Yakutsk" "GMT+09:30 (Australian) Central Standard Time" "GMT+09:30 Adelaide" "GMT+09:30 Darwin" "GMT+10:00 (Australian) Eastern Standard Time" "GMT+10:00 Brisbane, Melbourne, Sydney" "GMT+10:00 Guam, Port Moresby" "GMT+10:00 Vladivostok" "GMT+10:30 (Australian) Central Daylight 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-02:30 Newfoundland Daylight Time" "GMT-03:00 Atlantic Daylight Time" "GMT-03:00 Brasilia" "GMT-03:00 Buenos Aires, Georgetown" "GMT-03:30 Newfoundland Standard Time" "GMT-04:00 Atlantic Standard Time" "GMT-04:00 Caracas, La Paz" "GMT-04:00 Eastern Daylight Saving Time" "GMT-05:00 Bogota, Lima" "GMT-05:00 Central Daylight Saving Time" "GMT-05:00 Eastern Standard Time" "GMT-05:00 Indiana (East)" "GMT-06:00 Central Standard Time" "GMT-06:00 Mexico City, Tegucigalpa" "GMT-06:00 Mountain Daylight Saving Time" "GMT-06:00 Saskatchewan" "GMT-07:00 Arizona" "GMT-07:00 Mountain Standard Time" "GMT-07:00 Pacific Daylight Saving Time" "GMT-08:00 Alaska Standard Daylight Saving Time" "GMT-08:00 Pacific Standard Time" "GMT-09:00 Alaska Standard Time" "GMT-10:00 Hawaii" "GMT-11:00 Midway Island, Samoa" "GMT-12:00 Eniwetok, Kwajalein" null  
 Example:  "GMT+02:00 Eastern Europe Time"
object
Reconciliation information


 
object
Reconciliation match sequence


 
key
string or null
System-assigned key for the document sequence number.


 
 Example:  "2"
id
string or null
Document sequence ID


 
 Example:  "2--Bank sequence Id"
useMatchSequenceForAutoMatch
boolean
 Default:  true
Use sequence number for automatically matched transactions.


 
 Example:  false
useMatchSequenceForManualMatch
boolean
 Default:  true
Use sequence number for manually matched transactions.


 
 Example:  false
object
 
disablePrinting
boolean
 Default:  false
Disable check printing for this account.


 
 Example:  false
object
Address settings for check printing.


 
printAddress
boolean
 Default:  false
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
string or null
 Default:  null
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: "company" "custom" null  
 Example:  "company"
name
string  <= 100 characters 
Company name to print on checks if addressToPrint is set to custom.


 
 Example:  "Zine Inc."
object
Address to print on checks if addressToPrint is set to custom.


 
printLogo
boolean
 Default:  false
Set to true to print company logo on checks. A logo image file must be uploaded through the Sage Intacct user interface.


 
 Example:  false
object
Uploaded signature images to print on checks.


 
firstSignature
string
First signature file name.


 
 Example:  "sigimg1_j.jpg"
limitForFirstSignatureAmount
string <decimal-precision-2> 
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
boolean
 Default:  false
Include second signature on qualifying checks. Set to false to always show just one signature.


 
 Example:  true
secondSignature
string
Second signature file name.


 
 Example:  "sigimg2_j.jpg"
limitForSecondSignatureAmount
string <decimal-precision-2> 
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
string <decimal-precision-2> 
Print second signature only for checks that are for more than this amount.


 
 Example:  "60.00"
object
 
printOn
string
 Default:  "blankCheckStock"
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: "blankCheckStock" "prePrintedCheckStock"  
 Example:  "blankCheckStock"
nextCheckNumber
string or null  <= 10 characters ^[0-9]{1,10}$
Enter a starting check number. For example, 1001. The check number increments by 1 for each succeeding check.


 
 Example:  "1012"
printingFormat
string
 Default:  "standard"
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: "business" "cadCheck" "highSecurity" "jpmorganChaseBusiness" "jpmorganChaseStandard" "standard"  
 Example:  "standard"
paperFormat
string
 Default:  "top"
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: "bottom" "middle" "top"  
 Example:  "top"
printLineItems
boolean
 Default:  false
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.


 
 Example:  true
printLocation
string
 Default:  "id"
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: "both" "id" "name"  
 Example:  "id"
additionalText
string or null
Additional text to print under the signatures.


 
 Example:  "Pay to check holder"
numberOfChecksInPreview
string or null
 Default:  null
Number of checks per page.


 Enum: null "one" "three"  
 Example:  "one"
object
Magnetic Ink Character Recognition (MICR) settings. Use these settings if your bank requires special alignment of the account number on your check.


 
accountNumberAlignment
string
 Default:  "right"
Bank account number alignment in the MICR.


 Enum: "left" "right"  
 Example:  "right"
accountNumberPositioning
integer or null
Number of spaces to append before or after the bank account portion of the MICR.


 
 Example:  1
minCheckNumberLength
string or null
Set this value to pad short check numbers with zeros. The minimum number of digits is 6.


 
 Example:  "6"
object
Regional settings for Magnetic Ink Character Recognition (MICR).


 
object
Department to use for GL posting (optional).


 
key
string
 
 Example:  "9"
id
string
 
 Example:  "11--Accounting"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
Automated clearing house details.


 
enableACH
boolean
 Default:  false
Set to true to enable your account to make standard ACH or American Express ACH Payment Services payments.


 
 Example:  true
bankId
string
The ID of the bank record associated with this bank account.


 
 Example:  "BOA_ACH"
companyName
string  <= 16 characters 
The company name specified in the ACH bank record.


 
 Example:  "Ventura"
companyIdentification
string  <= 10 characters ^[\w\s_\-\.]{0,20}$
The 10-digit company ID as specified in the ACH bank record.


 
 Example:  "Ventura"
originatingFinancialInstitution
string  <= 8 characters ^[0-9]{1,8}$
The first 8 digits of your bank's routing number, as specified in the ACH bank record.


 
 Example:  "89096789"
companyEntryDescription
string  <= 10 characters 
Optional text that can be included with ACH payments.


 
 Example:  "Investmant"
companyDiscretionaryData
string  <= 20 characters 
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.


 
 Example:  "89078900"
useRecommendedSetup
boolean
 Default:  false
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.


 
 Example:  true
serviceClassCode
string or null
 Default:  null
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: "200" "220" null  
 Example:  "220"
batchId
string
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
string
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
string
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
string or null
 Default:  "useAsPayment"
Use trace number.


 Enum: null "useAsPayment" "useNumberingSequence"  
 Example:  "useAsPayment"
object
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.


 
enableBankFile
boolean
 Default:  false
Set to true to enable bank file payments to vendors.


 
 Example:  true
bankFileFormat
string
Bank file format of the bank associated with this checking account. Valid values depend on the country. See About bank files for more information.


 
 Example:  "ABA - Westpac"
bankCode
string
Bank code for the bank associated with this checking account.


 
 Example:  "Westpac Banking Corporation"
apcaNumber
string
The unique six-digit number used by Australian banks that identifies the company or individual making direct payments.


 
 Example:  "865551"
bsbNumber
string
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
string
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
string or null  <= 10 characters 
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.


 
 Example:  "23-44-16"
seedValue
string or null  <= 40 characters 
Seed value for South African banks. The 32-character NedBank seed value for the account from which payments are made.


 
 Example:  "ABFGHETOUFEH1234IOIADRTO78DD899"
userReference
string or null  <= 10 characters 
User reference


 
 Example:  "USER123"
clientCode
string or null  <= 10 characters 
Client user code


 
 Example:  "ProLite"
serviceType
string or null  <= 10 characters 
Type of service


 
 Example:  "PAYMENT"
originatorId
string  <= 20 characters 
Originator Identification Number


 
 Example:  "IE26SCT803015"
businessIdCode
string  <= 20 characters 
Business Identifier Code


 
 Example:  "BOFIIE2DXXX"
processingDataCenterCode
string  <= 5 characters 
5 digit originating direct clearer's allocated data centre ID number.


 
 Example:  "01674"
debtorBankNumber
string  <= 3 characters 
This is the settlement institutional bank (processing bank) number.


 
 Example:  "674"
branchTransitNumber
string  <= 5 characters 
This is the settlement institutional bank (processing bank) branch transit number.


 
 Example:  "43876"
returnAccountNumber
string  <= 12 characters 
Return account number.


 
 Example:  "IE26SCT80301"
messageIdPrefix
string  <= 23 characters 
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
string  <= 9 characters 
The bank routing number for the institution receiving the payment file.


 
 Example:  "984569845"
immediateOriginId
string  <= 9 characters 
The bank routing number for the institution sending the payment file.


 
 Example:  "878767675"
immediateOriginName
string  <= 50 characters 
The name of the company sending the payment file.


 
 Example:  "Investment corp"
immediateDestinationName
string  <= 50 characters 
The name of the company receiving the payment file.


 
 Example:  "BOA"
companyEntryDescription
string  <= 10 characters 
A description of the general nature of the transactions to help with identification purposes, for example Payroll or Payables.


 
 Example:  "Investment"
companyName
string  <= 16 characters 
The company name specified in the checking account record.


 
 Example:  "Ventura"
paymentNumberSequence
string  <= 7 characters 
Specify a string to generate a unique payment number sequence for payment files that are uploaded to the bank. 
Payment numbering should be ascending and incrementing. The same number sequence that you specified for traceNumberSequence.


 
 Example:  "0000078"
fileIdSequence
string  <= 1 characters ^[A-Za-z0-9]$
The first file generated for each calendar day starts with A. 
Each subsequent file increments by one letter, in alphabetical order then numeric order, and resets after the calendar day ends. Override values here.


 
 Example:  "B"
object
Postal address of the bank.


 
addressLine1
string
Address line 1.


 
 Example:  "36900 Neward Blvd"
addressLine2
string
Address line 2.


 
 Example:  "Suite 100"
postCode
string
Postal code.


 
 Example:  "94536"
county
string
County.


 
 Example:  "North Yorkshire"
object
 
object
Applied rule set


 
key
string
 
 Example:  "36"
id
string
 
 Example:  "36--RuleSetToMatch"
name
string
Name of the bank transaction rule set.


 
 Example:  "rule-set-for-checking-accounts"
object
Restrict a bank account to a specfic location or restrict one or more entity/locations to a specific account.


 
restrictionType
string
 Default:  "unrestricted"
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: "restricted" "rootOnly" "unrestricted"  
 Example:  "unrestricted"
locations
Array of strings
List of location ids that can access this checking account when restrictionType is set to restricted.


 
 Example:  ["1--United States of America","2--United Kingdom"]
Array of objects
 
 Array 
checkStartNumber
string
Starting check number specific to the payment provider.


 
 Example:  "111999"
isRebateAccount
boolean
 Default:  false
Indicates whether this is the account in which virtual card payment rebates are deposited.


 
 Example:  true
remittanceEmail
string
Email address to receive the bank remittance.


 
 Example:  "[email protected]"
object
 
object
 
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created checking account


Request samples 
application/json
{
  • "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": {
        },
      • "name": "Zine Inc."
      },
    • "micrSettings": {
      • "regionalSettings": {
        },
      • "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"
    }
}
Response samples 
application/json
{
  • "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": {
        },
      • "name": "Zine Inc."
      },
    • "micrSettings": {
      • "regionalSettings": {
        },
      • "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"
    }
}
Update a checking account
patch/objects/cash-management/checking-account/{key}
Updates an existing checking account by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the checking account.


 
 Example:  99
Request Body schema: application/json
required
object
Bank account details


 
accountNumber
string
Bank account number for this checking account.


 
 Example:  "4356789402"
bankName
string
Name of the bank for this checking account.


 
 Example:  "Bank of America"
accountHolderName
string  <= 100 characters 
The official name that the bank has on file for this checking account.


 
 Example:  "ABC Software"
routingNumber
string
Routing number for this checking account.


 
 Example:  "121000358"
branchId
string
Bank branch ID for this checking account.


 
 Example:  "89099"
phoneNumber
string
Phone number of the bank branch.


 
 Example:  "5559878978"
currency
string
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"
object
 
city
string
City where the bank is located.


 
 Example:  "Newark"
state
string
State where the bank is located.


 
 Example:  "CA"
postCode
string
Zip or postal code for the bank.


 
 Example:  "94560"
country
string
Country where the bank is located.


 
 Example:  "United States"
addressLine1
string
Line 1 of the street address for the bank.


 
 Example:  "36900 Neward Blvd"
addressLine2
string
Line 2 of the street address for the bank.


 
 Example:  "Suite 101"
addressLine3
string
Line 3 of the street address for the bank which provides additional geographical information.


 
 Example:  "Western industrial area"
object
Accounting Information


 
object
General Ledger account that this checking account is associated with.


 
key
string
 
 Example:  "256"
id
string
 
 Example:  "9899--My Ledger Account-33"
name
string
Name or title of the account, which appears on report headings.


 
 Example:  "Expense Account"
object
Default payables GL journal


 
key
string
System-assigned key for the gl-journal.


 
 Example:  "3"
id
string
The id of the journal


 
 Example:  "AP ADJ--AP Adjustment Journal"
object
Default receivables GL journal


 
key
string
System-assigned key for the gl-journal.


 
 Example:  "3"
id
string
The id of the journal


 
 Example:  "AR ADJ--AR Adjustment Journal"
disableInterEntityTransfer
boolean
 Default:  false
Exclude this account from inter-entity transfers (IET) even if IET is globally enabled for the entire multi-entity shared structure of companies.


 
 Example:  false
object
General ledger account for service charges. Used for reconciliation.


 
key
string
 
 Example:  "432"
id
string
 
 Example:  "0077--My Ledger Account 54"
object
General ledger account label for service charges.


 
key
string
 
 Example:  "15"
id
string
 
 Example:  "Car Payment"
object
General ledger account for earned interest. Used for reconciliation.


 
key
string
 
 Example:  "419"
id
string
 
 Example:  "0099--My Ledger Account 40"
object
General ledger account label for earned interest.


 
key
string
 
 Example:  "35"
id
string
 
 Example:  "Sales"
bankingTimeZone
string or null
 Default:  null
Time zone


 Enum: "GMT (Greenwich Mean Time) Dublin, Edinburgh, London" "GMT+00:00 Western Europe Time" "GMT+01:00 Berlin, Stockholm, Rome, Bern, Brussels" "GMT+01:00 British Summer Time" "GMT+01:00 Central Europe Time" "GMT+01:00 Irish Summer Time" "GMT+01:00 Lisbon, Warsaw" "GMT+01:00 Paris, Madrid" "GMT+01:00 Prague" "GMT+01:00 Western Europe Summer Time" "GMT+02:00 Athens, Helsinki, Istanbul" "GMT+02:00 Cairo" "GMT+02:00 Central Europe Summer Time" "GMT+02:00 Eastern Europe Time" "GMT+02:00 Harare, Pretoria" "GMT+02:00 Israel" "GMT+03:00 Baghdad, Kuwait, Nairobi, Riyadh" "GMT+03:00 Eastern Europe Summer Time" "GMT+03:00 Moscow, St. Petersburg, Volgograd" "GMT+03:30 Tehran" "GMT+04:00 Abu Dhabi, Muscat, Tbilisi, Kazan" "GMT+04:00 Moscow Summer Time" "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 (Australian) Western Standard Time" "GMT+08:00 Beijing, Chongqing, Urumqi" "GMT+08:00 Hong Kong SAR, Perth, Singapore, Taipei" "GMT+09:00 Tokyo, Osaka, Sapporo, Seoul, Yakutsk" "GMT+09:30 (Australian) Central Standard Time" "GMT+09:30 Adelaide" "GMT+09:30 Darwin" "GMT+10:00 (Australian) Eastern Standard Time" "GMT+10:00 Brisbane, Melbourne, Sydney" "GMT+10:00 Guam, Port Moresby" "GMT+10:00 Vladivostok" "GMT+10:30 (Australian) Central Daylight 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-02:30 Newfoundland Daylight Time" "GMT-03:00 Atlantic Daylight Time" "GMT-03:00 Brasilia" "GMT-03:00 Buenos Aires, Georgetown" "GMT-03:30 Newfoundland Standard Time" "GMT-04:00 Atlantic Standard Time" "GMT-04:00 Caracas, La Paz" "GMT-04:00 Eastern Daylight Saving Time" "GMT-05:00 Bogota, Lima" "GMT-05:00 Central Daylight Saving Time" "GMT-05:00 Eastern Standard Time" "GMT-05:00 Indiana (East)" "GMT-06:00 Central Standard Time" "GMT-06:00 Mexico City, Tegucigalpa" "GMT-06:00 Mountain Daylight Saving Time" "GMT-06:00 Saskatchewan" "GMT-07:00 Arizona" "GMT-07:00 Mountain Standard Time" "GMT-07:00 Pacific Daylight Saving Time" "GMT-08:00 Alaska Standard Daylight Saving Time" "GMT-08:00 Pacific Standard Time" "GMT-09:00 Alaska Standard Time" "GMT-10:00 Hawaii" "GMT-11:00 Midway Island, Samoa" "GMT-12:00 Eniwetok, Kwajalein" null  
 Example:  "GMT+02:00 Eastern Europe Time"
object
Reconciliation information


 
object
Reconciliation match sequence


 
key
string or null
System-assigned key for the document sequence number.


 
 Example:  "2"
id
string or null
Document sequence ID


 
 Example:  "2--Bank sequence Id"
useMatchSequenceForAutoMatch
boolean
 Default:  true
Use sequence number for automatically matched transactions.


 
 Example:  false
useMatchSequenceForManualMatch
boolean
 Default:  true
Use sequence number for manually matched transactions.


 
 Example:  false
object
 
disablePrinting
boolean
 Default:  false
Disable check printing for this account.


 
 Example:  false
object
Address settings for check printing.


 
printAddress
boolean
 Default:  false
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
string or null
 Default:  null
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: "company" "custom" null  
 Example:  "company"
name
string  <= 100 characters 
Company name to print on checks if addressToPrint is set to custom.


 
 Example:  "Zine Inc."
object
Address to print on checks if addressToPrint is set to custom.


 
printLogo
boolean
 Default:  false
Set to true to print company logo on checks. A logo image file must be uploaded through the Sage Intacct user interface.


 
 Example:  false
object
Uploaded signature images to print on checks.


 
firstSignature
string
First signature file name.


 
 Example:  "sigimg1_j.jpg"
limitForFirstSignatureAmount
string <decimal-precision-2> 
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
boolean
 Default:  false
Include second signature on qualifying checks. Set to false to always show just one signature.


 
 Example:  true
secondSignature
string
Second signature file name.


 
 Example:  "sigimg2_j.jpg"
limitForSecondSignatureAmount
string <decimal-precision-2> 
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
string <decimal-precision-2> 
Print second signature only for checks that are for more than this amount.


 
 Example:  "60.00"
object
 
printOn
string
 Default:  "blankCheckStock"
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: "blankCheckStock" "prePrintedCheckStock"  
 Example:  "blankCheckStock"
nextCheckNumber
string or null  <= 10 characters ^[0-9]{1,10}$
Enter a starting check number. For example, 1001. The check number increments by 1 for each succeeding check.


 
 Example:  "1012"
printingFormat
string
 Default:  "standard"
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: "business" "cadCheck" "highSecurity" "jpmorganChaseBusiness" "jpmorganChaseStandard" "standard"  
 Example:  "standard"
paperFormat
string
 Default:  "top"
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: "bottom" "middle" "top"  
 Example:  "top"
printLineItems
boolean
 Default:  false
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.


 
 Example:  true
printLocation
string
 Default:  "id"
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: "both" "id" "name"  
 Example:  "id"
additionalText
string or null
Additional text to print under the signatures.


 
 Example:  "Pay to check holder"
numberOfChecksInPreview
string or null
 Default:  null
Number of checks per page.


 Enum: null "one" "three"  
 Example:  "one"
object
Magnetic Ink Character Recognition (MICR) settings. Use these settings if your bank requires special alignment of the account number on your check.


 
accountNumberAlignment
string
 Default:  "right"
Bank account number alignment in the MICR.


 Enum: "left" "right"  
 Example:  "right"
accountNumberPositioning
integer or null
Number of spaces to append before or after the bank account portion of the MICR.


 
 Example:  1
minCheckNumberLength
string or null
Set this value to pad short check numbers with zeros. The minimum number of digits is 6.


 
 Example:  "6"
object
Regional settings for Magnetic Ink Character Recognition (MICR).


 
object
Department to use for GL posting (optional).


 
key
string
 
 Example:  "9"
id
string
 
 Example:  "11--Accounting"
object
Location to use for GL posting (optional).


 
key
string
 
 Example:  "1"
id
string
 
 Example:  "1--United States of America"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
Automated clearing house details.


 
enableACH
boolean
 Default:  false
Set to true to enable your account to make standard ACH or American Express ACH Payment Services payments.


 
 Example:  true
bankId
string
The ID of the bank record associated with this bank account.


 
 Example:  "BOA_ACH"
companyName
string  <= 16 characters 
The company name specified in the ACH bank record.


 
 Example:  "Ventura"
companyIdentification
string  <= 10 characters ^[\w\s_\-\.]{0,20}$
The 10-digit company ID as specified in the ACH bank record.


 
 Example:  "Ventura"
originatingFinancialInstitution
string  <= 8 characters ^[0-9]{1,8}$
The first 8 digits of your bank's routing number, as specified in the ACH bank record.


 
 Example:  "89096789"
companyEntryDescription
string  <= 10 characters 
Optional text that can be included with ACH payments.


 
 Example:  "Investmant"
companyDiscretionaryData
string  <= 20 characters 
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.


 
 Example:  "89078900"
useRecommendedSetup
boolean
 Default:  false
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.


 
 Example:  true
serviceClassCode
string or null
 Default:  null
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: "200" "220" null  
 Example:  "220"
batchId
string
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
string
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
string
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
string or null
 Default:  "useAsPayment"
Use trace number.


 Enum: null "useAsPayment" "useNumberingSequence"  
 Example:  "useAsPayment"
object
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.


 
enableBankFile
boolean
 Default:  false
Set to true to enable bank file payments to vendors.


 
 Example:  true
bankFileFormat
string
Bank file format of the bank associated with this checking account. Valid values depend on the country. See About bank files for more information.


 
 Example:  "ABA - Westpac"
bankCode
string
Bank code for the bank associated with this checking account.


 
 Example:  "Westpac Banking Corporation"
apcaNumber
string
The unique six-digit number used by Australian banks that identifies the company or individual making direct payments.


 
 Example:  "865551"
bsbNumber
string
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
string
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
string or null  <= 10 characters 
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.


 
 Example:  "23-44-16"
seedValue
string or null  <= 40 characters 
Seed value for South African banks. The 32-character NedBank seed value for the account from which payments are made.


 
 Example:  "ABFGHETOUFEH1234IOIADRTO78DD899"
userReference
string or null  <= 10 characters 
User reference


 
 Example:  "USER123"
clientCode
string or null  <= 10 characters 
Client user code


 
 Example:  "ProLite"
serviceType
string or null  <= 10 characters 
Type of service


 
 Example:  "PAYMENT"
originatorId
string  <= 20 characters 
Originator Identification Number


 
 Example:  "IE26SCT803015"
businessIdCode
string  <= 20 characters 
Business Identifier Code


 
 Example:  "BOFIIE2DXXX"
processingDataCenterCode
string  <= 5 characters 
5 digit originating direct clearer's allocated data centre ID number.


 
 Example:  "01674"
debtorBankNumber
string  <= 3 characters 
This is the settlement institutional bank (processing bank) number.


 
 Example:  "674"
branchTransitNumber
string  <= 5 characters 
This is the settlement institutional bank (processing bank) branch transit number.


 
 Example:  "43876"
returnAccountNumber
string  <= 12 characters 
Return account number.


 
 Example:  "IE26SCT80301"
messageIdPrefix
string  <= 23 characters 
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
string  <= 9 characters 
The bank routing number for the institution receiving the payment file.


 
 Example:  "984569845"
immediateOriginId
string  <= 9 characters 
The bank routing number for the institution sending the payment file.


 
 Example:  "878767675"
immediateOriginName
string  <= 50 characters 
The name of the company sending the payment file.


 
 Example:  "Investment corp"
immediateDestinationName
string  <= 50 characters 
The name of the company receiving the payment file.


 
 Example:  "BOA"
companyEntryDescription
string  <= 10 characters 
A description of the general nature of the transactions to help with identification purposes, for example Payroll or Payables.


 
 Example:  "Investment"
companyName
string  <= 16 characters 
The company name specified in the checking account record.


 
 Example:  "Ventura"
paymentNumberSequence
string  <= 7 characters 
Specify a string to generate a unique payment number sequence for payment files that are uploaded to the bank. 
Payment numbering should be ascending and incrementing. The same number sequence that you specified for traceNumberSequence.


 
 Example:  "0000078"
fileIdSequence
string  <= 1 characters ^[A-Za-z0-9]$
The first file generated for each calendar day starts with A. 
Each subsequent file increments by one letter, in alphabetical order then numeric order, and resets after the calendar day ends. Override values here.


 
 Example:  "B"
object
Postal address of the bank.


 
addressLine1
string
Address line 1.


 
 Example:  "36900 Neward Blvd"
addressLine2
string
Address line 2.


 
 Example:  "Suite 100"
postCode
string
Postal code.


 
 Example:  "94536"
county
string
County.


 
 Example:  "North Yorkshire"
object
 
object
Applied rule set


 
key
string
 
 Example:  "36"
id
string
 
 Example:  "36--RuleSetToMatch"
name
string
Name of the bank transaction rule set.


 
 Example:  "rule-set-for-checking-accounts"
object
Restrict a bank account to a specfic location or restrict one or more entity/locations to a specific account.


 
restrictionType
string
 Default:  "unrestricted"
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: "restricted" "rootOnly" "unrestricted"  
 Example:  "unrestricted"
locations
Array of strings
List of location ids that can access this checking account when restrictionType is set to restricted.


 
 Example:  ["1--United States of America","2--United Kingdom"]
Array of objects
 
 Array 
checkStartNumber
string
Starting check number specific to the payment provider.


 
 Example:  "111999"
isRebateAccount
boolean
 Default:  false
Indicates whether this is the account in which virtual card payment rebates are deposited.


 
 Example:  true
remittanceEmail
string
Email address to receive the bank remittance.


 
 Example:  "[email protected]"
object
 
object
 
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Updated checking account


Request samples 
application/json
{
  • "bankAccountDetails": {
    • "bankName": "Bank of America New"
    },
  • "ruleSet": {
    • "key": "53",
    • "id": "MatchDateAmountGrpbyDateRuleSet"
    },
  • "restrictions": {
    • "restrictionType": "unrestricted",
    • "locations": [ ]
    },
  • "reconciliation": {
    • "matchSequence": {
      • "key": "48"
      },
    • "useMatchSequenceForAutoMatch": true,
    • "useMatchSequenceForManualMatch": true
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12345",
    • "id": "ID123",
    • "href": "/objects/<application>/<name>/12345"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}
Delete a checking account
delete/objects/cash-management/checking-account/{key}
Deletes a checking account.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the checking account.


 
 Example:  99
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
List checking accounts
get/objects/cash-management/checking-account
Returns up to 100 object references from the collection with a key, ID, and link for each checking account. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.



Permissions and other requirements



SubscriptionCash Management


User typeBusiness, Employee, Project Manager


PermissionsList, View Checking Accounts







SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "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
    }
}
Query checking accounts
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "cash-management/checking-account"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or has (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "cash-management/checking-account",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "bankAccountDetails.accountNumber",
    • "bankAccountDetails.bankName",
    • "bankAccountDetails.routingNumber"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "CHK0001",
      • "bankAccountDetails.accountNumber": "1020",
      • "bankAccountDetails.bankName": "HSBC",
      • "bankAccountDetails.routingNumber": "123456789"
      },
    • {
      • "key": "4",
      • "id": "CHK002",
      • "bankAccountDetails.accountNumber": "123456",
      • "bankAccountDetails.bankName": "Prosperous Bank",
      • "bankAccountDetails.routingNumber": "123456789"
      },
    • {
      • "key": "9",
      • "id": "CHK003",
      • "bankAccountDetails.accountNumber": "5431678",
      • "bankAccountDetails.bankName": "First National Bank",
      • "bankAccountDetails.routingNumber": "458976129"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}