GET api/bankcodes/{bankCodeId}/payments/summary?asOfDate={asOfDate}
load summary data for the bankCode
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bankCodeId |
|
integer |
Required |
asOfDate |
|
date |
None. |
Body Parameters
None.
Response Information
Resource Description
BankCodePaymentSummaryViewModelName | Description | Type | Additional information |
---|---|---|---|
PostedBalance |
|
decimal number |
None. |
MinimumAllowedBalance |
|
decimal number |
None. |
AchHoldbacksDetails |
|
Collection of AchHoldbacksSummaryViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "postedBalance": 1.0, "minimumAllowedBalance": 2.0, "achHoldbacksDetails": [ { "description": "sample string 1", "monthlyBudget": 2.0, "monthlyActualPaid": 3.0 }, { "description": "sample string 1", "monthlyBudget": 2.0, "monthlyActualPaid": 3.0 } ] }
application/xml, text/xml
Sample:
<BankCodePaymentSummaryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Controllers.Banks.Models"> <AchHoldbacksDetails> <AchHoldbacksSummaryViewModel> <Description>sample string 1</Description> <MonthlyActualPaid>3</MonthlyActualPaid> <MonthlyBudget>2</MonthlyBudget> </AchHoldbacksSummaryViewModel> <AchHoldbacksSummaryViewModel> <Description>sample string 1</Description> <MonthlyActualPaid>3</MonthlyActualPaid> <MonthlyBudget>2</MonthlyBudget> </AchHoldbacksSummaryViewModel> </AchHoldbacksDetails> <MinimumAllowedBalance>2</MinimumAllowedBalance> <PostedBalance>1</PostedBalance> </BankCodePaymentSummaryViewModel>