Deposit lines

Line items in a deposit represent payments received from customers.

List deposit lines

get/objects/cash-management/deposit-line

Returns a collection with a key, ID, and link for each deposit line. 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.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "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
    }
}
Get a deposit line
get/objects/cash-management/deposit-line/{key}
Returns detailed information for a specified deposit line.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the deposit line.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "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": {
        },
      • "location": {
        }
      },
    • "baseLocation": {
      • "name": "United States of America",
      • "key": "1"
      },
    • "description": "Deposit from other receipt for Convivia grapes inc",
    • "currency": {
      • "exchangeRate": {
        },
      • "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
    }
}