Deposits
List deposits
List all deposits
get/deposits
Query parameters
deposit_idstring
Search deposits by deposit id
asset_accountstring
Search deposits by asset account name
asset_account_idinteger
Search deposits by asset account id
liability_accountstring
Search deposits by liability account name
liability_account_idinteger
Search deposits by liability account id
{"stackTrail":"paths:/deposits:get:parameters:5:schema","oasType":"schema","type":"unknown"}
Search deposits by trust deposited amount
client_namestring
Search deposits by client name
deposited_onstring date
Search deposits by deposited on date
descriptionstring
Search deposits by description
payment_methodstring
Search deposits by payment method
filtersobject
Filter deposits by the above query parameters. <br /> <b>Example:</b> { "trust_deposited[gt]" : 6000 } which will search for deposits that have a deposited trust greater than "6000".
sort[asc]'id' | 'trust_deposited' | 'payment_method'
Sort deposits in ascending order
sort[desc]'id' | 'trust_deposited' | 'payment_method'
Sort deposits in descending order
pageinteger
The particular page to return
per_pageinteger
The number of items to return per page Default: 50 Limit: 200
Response
Get All Deposits
Example response
{
"message": "Success",
"deposit": [
{
"id": 1,
"deposit_id": "DP1",
"organization_id": 1,
"voucher_header_id": 10,
"deposited_on": "2024-01-15",
"client_id": 2,
"client_name": "John Doe",
"currency_id": 234,
"exchange_rate": 1,
"foreign_amount": 100,
"trust_deposited": 100,
"payment_method": "Cash",
"ref_num": "0000001",
"description": "Deposit description",
"liability_account_id": 119,
"liability_account": "John Doe Trust Liability Account - USD (2)",
"liability_account_fl1": "John Doe Trust Liability Account - USD (2)",
"liability_account_fl2": "John Doe Trust Liability Account - USD (2)",
"asset_account_id": 20,
"asset_account": "Trust Asset Account - USD (1)",
"asset_account_fl1": "Compte d'actifs fiduciaires - USD (1)",
"asset_account_fl2": "حساب ائتماني للعملاء - USD (1)"
}
],
"page_context": {
"page": 1,
"per_page": 10,
"next_page_url": "http://localhost/lexzur/api/v2/money/deposits?page=2",
"total": 25,
"count": 10
}
}