Bank deposits

Deposits into a bank account.

The object#

FieldTypeDescription
idread-onlyintegerNolaPro id.
cashtotalmoneystring(4dp)Stored as decimal(19,4).
checktotalmoneystring(4dp)Stored as decimal(19,4).
othertotalmoneystring(4dp)Stored as decimal(19,4).
cashoutmoneystring(4dp)Stored as decimal(19,4).
depositdatestringDate of the bank deposit - the accounting date it posts under.
checkaccountidintegerChecking account the deposit goes into.
checkaccountstring(30)The name of the referenced checkaccounts, instead of the id. Send this or checkaccountid, not both unless they agree.
onbankstatementread-onlyinteger1 once the deposit has been matched to a bank statement.
cancelbooleanCancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydatestringWhen the record was created.
bankstatement_enddateread-onlystringEnd date of the bank statement the deposit was reconciled under. Maintained by bank reconciliation.
voucheridintegerVoucherid. Id only.
voucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or voucherid, not both unless they agree.
depositdescriptionstring(255)Description printed on the deposit slip.
currencystring(10)Currency of the deposit.
ccdepositinteger1 when the deposit records credit-card settlement funds rather than checks and cash.
ardailycloseidintegerArdailycloseid. Id only.
bankstatement_cleardateread-onlystringDate the deposit cleared the bank. Maintained by bank reconciliation.
cancelvoucheridintegerCancelvoucherid. Id only.
cancelvoucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or cancelvoucherid, not both unless they agree.
externalidstring(100)Your own key. Scoped to your company.

Endpoints#

GET/bankdeposits/{id}/lines 200422

What went into a deposit.

The composition of a bank deposit - each payment or item that made up the total. Reconciling a deposit against a bank statement needs the parts, not the sum: the statement shows one credit, and matching it means knowing which receipts were banked together.

Requires scope banking:read.

Parameters
NameInTypeNotes
idrequiredpathintegerThe deposit id.
When it fails
StatusCodeMeaning
422unknown_valueNo such parent record in this company.
curl \
  'https://acme.nolapro.com/!/api/v2/bankdeposits/104/lines' \
  -H 'Authorization: Bearer $NP_TOKEN'
POST/bankdeposits/batch 207

Create many.

Requires scope banking:write.

Parameters
NameInTypeNotes
Body array
FieldTypeDescription
idread-onlyintegerNolaPro id.
cashtotalmoneystring(4dp)Stored as decimal(19,4).
checktotalmoneystring(4dp)Stored as decimal(19,4).
othertotalmoneystring(4dp)Stored as decimal(19,4).
cashoutmoneystring(4dp)Stored as decimal(19,4).
depositdatestringDate of the bank deposit - the accounting date it posts under.
checkaccountidintegerChecking account the deposit goes into.
checkaccountstring(30)The name of the referenced checkaccounts, instead of the id. Send this or checkaccountid, not both unless they agree.
onbankstatementread-onlyinteger1 once the deposit has been matched to a bank statement.
cancelbooleanCancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydatestringWhen the record was created.
bankstatement_enddateread-onlystringEnd date of the bank statement the deposit was reconciled under. Maintained by bank reconciliation.
voucheridintegerVoucherid. Id only.
voucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or voucherid, not both unless they agree.
depositdescriptionstring(255)Description printed on the deposit slip.
currencystring(10)Currency of the deposit.
ccdepositinteger1 when the deposit records credit-card settlement funds rather than checks and cash.
ardailycloseidintegerArdailycloseid. Id only.
bankstatement_cleardateread-onlystringDate the deposit cleared the bank. Maintained by bank reconciliation.
cancelvoucheridintegerCancelvoucherid. Id only.
cancelvoucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or cancelvoucherid, not both unless they agree.
externalidstring(100)Your own key. Scoped to your company.
curl -X POST \
  'https://acme.nolapro.com/!/api/v2/bankdeposits/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "cashtotal": "125.0000",
        "checktotal": "125.0000",
        "othertotal": "125.0000",
        "cashout": "125.0000",
        "depositdate": "2026-08-01",
        "checkaccountid": 104
    }
]'
GET/bankdeposits 200403

List bank deposits.

Requires scope banking:read.

Parameters
NameInTypeNotes
cancelquerystringDefaults to false. Pass true or any.
externalidquerystringExact match on your own key.
includequerystringComma-separated extras to embed. Only custom_fields is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.
When it fails
StatusCodeMeaning
403insufficient_scopeToken lacks read scope.
curl \
  'https://acme.nolapro.com/!/api/v2/bankdeposits' \
  -H 'Authorization: Bearer $NP_TOKEN'
POST/bankdeposits 201400

Create.

Requires scope banking:write.

Parameters
NameInTypeNotes
Body
FieldTypeDescription
idread-onlyintegerNolaPro id.
cashtotalmoneystring(4dp)Stored as decimal(19,4).
checktotalmoneystring(4dp)Stored as decimal(19,4).
othertotalmoneystring(4dp)Stored as decimal(19,4).
cashoutmoneystring(4dp)Stored as decimal(19,4).
depositdatestringDate of the bank deposit - the accounting date it posts under.
checkaccountidintegerChecking account the deposit goes into.
checkaccountstring(30)The name of the referenced checkaccounts, instead of the id. Send this or checkaccountid, not both unless they agree.
onbankstatementread-onlyinteger1 once the deposit has been matched to a bank statement.
cancelbooleanCancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydatestringWhen the record was created.
bankstatement_enddateread-onlystringEnd date of the bank statement the deposit was reconciled under. Maintained by bank reconciliation.
voucheridintegerVoucherid. Id only.
voucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or voucherid, not both unless they agree.
depositdescriptionstring(255)Description printed on the deposit slip.
currencystring(10)Currency of the deposit.
ccdepositinteger1 when the deposit records credit-card settlement funds rather than checks and cash.
ardailycloseidintegerArdailycloseid. Id only.
bankstatement_cleardateread-onlystringDate the deposit cleared the bank. Maintained by bank reconciliation.
cancelvoucheridintegerCancelvoucherid. Id only.
cancelvoucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or cancelvoucherid, not both unless they agree.
externalidstring(100)Your own key. Scoped to your company.
When it fails
StatusCodeMeaning
400invalid_requestA required field was missing.
curl -X POST \
  'https://acme.nolapro.com/!/api/v2/bankdeposits' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "cashtotal": "125.0000",
    "checktotal": "125.0000",
    "othertotal": "125.0000",
    "cashout": "125.0000",
    "depositdate": "2026-08-01",
    "checkaccountid": 104
}'
Response 201
{
    "cashtotal": "125.0000",
    "checktotal": "125.0000",
    "othertotal": "125.0000",
    "cashout": "125.0000",
    "depositdate": "2026-08-01",
    "checkaccountid": 104
}
GET/bankdeposits/{id} 200404

Retrieve one record.

Requires scope banking:read.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
includequerystringComma-separated extras to embed. Only custom_fields is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl \
  'https://acme.nolapro.com/!/api/v2/bankdeposits/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "cashtotal": "125.0000",
    "checktotal": "125.0000",
    "othertotal": "125.0000",
    "cashout": "125.0000",
    "depositdate": "2026-08-01",
    "checkaccountid": 104
}
PATCH/bankdeposits/{id} 200404

Update.

Requires scope banking:write.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
Body
FieldTypeDescription
idread-onlyintegerNolaPro id.
cashtotalmoneystring(4dp)Stored as decimal(19,4).
checktotalmoneystring(4dp)Stored as decimal(19,4).
othertotalmoneystring(4dp)Stored as decimal(19,4).
cashoutmoneystring(4dp)Stored as decimal(19,4).
depositdatestringDate of the bank deposit - the accounting date it posts under.
checkaccountidintegerChecking account the deposit goes into.
checkaccountstring(30)The name of the referenced checkaccounts, instead of the id. Send this or checkaccountid, not both unless they agree.
onbankstatementread-onlyinteger1 once the deposit has been matched to a bank statement.
cancelbooleanCancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydatestringWhen the record was created.
bankstatement_enddateread-onlystringEnd date of the bank statement the deposit was reconciled under. Maintained by bank reconciliation.
voucheridintegerVoucherid. Id only.
voucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or voucherid, not both unless they agree.
depositdescriptionstring(255)Description printed on the deposit slip.
currencystring(10)Currency of the deposit.
ccdepositinteger1 when the deposit records credit-card settlement funds rather than checks and cash.
ardailycloseidintegerArdailycloseid. Id only.
bankstatement_cleardateread-onlystringDate the deposit cleared the bank. Maintained by bank reconciliation.
cancelvoucheridintegerCancelvoucherid. Id only.
cancelvoucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or cancelvoucherid, not both unless they agree.
externalidstring(100)Your own key. Scoped to your company.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/bankdeposits/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "cashtotal": "125.0000",
    "checktotal": "125.0000",
    "othertotal": "125.0000",
    "cashout": "125.0000",
    "depositdate": "2026-08-01",
    "checkaccountid": 104
}'
Response 200
{
    "cashtotal": "125.0000",
    "checktotal": "125.0000",
    "othertotal": "125.0000",
    "cashout": "125.0000",
    "depositdate": "2026-08-01",
    "checkaccountid": 104
}
DELETE/bankdeposits/{id} 200404

Cancel.

Requires scope banking:cancel.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/bankdeposits/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "cashtotal": "125.0000",
    "checktotal": "125.0000",
    "othertotal": "125.0000",
    "cashout": "125.0000",
    "depositdate": "2026-08-01",
    "checkaccountid": 104
}
GET/bankdeposits/{id}/pdf 200

Deposit slip as a PDF

The deposit slip listing everything banked together. Answers application/pdf, not JSON. Because the body is binary it cannot be carried inside a /batch results array; asking for it there returns 415 not_batchable.

Requires scope banking:read.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
curl \
  'https://acme.nolapro.com/!/api/v2/bankdeposits/104/pdf' \
  -H 'Authorization: Bearer $NP_TOKEN'