| GET | /payments/paymentApplication |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| transactionID | query | int? | No | |
| groupID | query | string | No | |
| userID | query | string | No | |
| bhUserID | query | int? | No | |
| transactionBeginDate | query | DateTime? | No | |
| transactionEndDate | query | DateTime? | No | |
| fiscalYear | query | int? | No | |
| page | query | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsError | form | bool | No | |
| users | form | List<PaymentApplicationUser> | No | |
| ErrorMessage | form | string | No | |
| paging | form | Paging | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| groupID | form | string | No | |
| fiscalYear | form | int | No | |
| userID | form | string | No | |
| bhUserID | form | int | No | |
| autoPayStatus | form | string | No | |
| userTransactions | form | List<UserTransaction> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| transactionID | form | long | No | |
| date | form | string | No | |
| type | form | string | No | |
| accountLast4 | form | string | No | |
| amount | form | decimal | No | |
| unapplied | form | decimal | No | |
| unappliedFee | form | decimal | No | |
| returnReason | form | string | No | |
| returnDate | form | string | No | |
| refundAmount | form | decimal | No | |
| lineItems | form | List<LineItem> | No | |
| transactionHistory | form | List<TransactionHistory> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| chartOfAccountRefID | form | string | No | |
| chartOfAccountDescription | form | string | No | |
| cashAccount | form | string | No | |
| amount | form | decimal | No | |
| fee | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| type | form | string | No | |
| date | form | string | No | |
| lineItems | form | List<LineItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| page | form | int | No | |
| totalPages | form | int | No | |
| next | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /payments/paymentApplication HTTP/1.1 Host: devapi.billhighway.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"IsError":true,"users":[{"groupID":"String","fiscalYear":0,"userID":"String","bhUserID":0,"autoPayStatus":"String","userTransactions":[{"transactionID":0,"date":"String","type":"String","accountLast4":"String","amount":0,"unapplied":0,"unappliedFee":0,"returnReason":"String","returnDate":"String","refundAmount":0,"lineItems":[{"chartOfAccountRefID":"String","chartOfAccountDescription":"String","cashAccount":"String","amount":0,"fee":0}],"transactionHistory":[{"type":"String","date":"String","lineItems":[{"chartOfAccountRefID":"String","chartOfAccountDescription":"String","cashAccount":"String","amount":0,"fee":0}]}]}]}],"ErrorMessage":"String","paging":{"page":0,"totalPages":0,"next":"String"}}