A checking account object models a real-world checking account at a bank and supports checking account reconciliation.
Returns detailed information for a specified checking account.
key required | string System-assigned key for the checking account. Example: 99 |
OK
Bad Request
{- "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
}
}
Creates a new checking account.
key required | string System-assigned key for the checking account. Example: 99 |
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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Bank account details | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Accounting Information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Reconciliation information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Department to use for GL posting (optional). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Automated clearing house details. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Applied rule set | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Restrict a bank account to a specfic location or restrict one or more entity/locations to a specific account. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Created checking account
{- "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"
}
}
{- "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"
}
}
Updates an existing checking account by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the checking account. Example: 99 |
object Bank account details | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Accounting Information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Reconciliation information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Department to use for GL posting (optional). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Location to use for GL posting (optional). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Automated clearing house details. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Applied rule set | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Restrict a bank account to a specfic location or restrict one or more entity/locations to a specific account. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Updated checking account
{- "bankAccountDetails": {
- "bankName": "Bank of America New"
}, - "ruleSet": {
- "key": "53",
- "id": "MatchDateAmountGrpbyDateRuleSet"
}, - "restrictions": {
- "restrictionType": "unrestricted",
- "locations": [ ]
}, - "reconciliation": {
- "matchSequence": {
- "key": "48"
}, - "useMatchSequenceForAutoMatch": true,
- "useMatchSequenceForManualMatch": true
}
}
{- "ia::result": {
- "key": "12345",
- "id": "ID123",
- "href": "/objects/<application>/<name>/12345"
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}
Deletes a checking account.
key required | string System-assigned key for the checking account. Example: 99 |
No Content
Bad Request
{- "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
}
}
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 the query service to find objects that meet certain criteria and to specify properties that are returned.
OK
Bad Request
{- "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
}
}