The Direct Deposit API allows users to retrieve all direct deposits for a given employee.
Resource URL| Example Request | |
| GET | https://serverurl/api/v1.1/employee/26/deposit |
| Return Value |
| Http header "Accept" value -- "text/xml" or "application/xml" will return XML, otherwise JSON will be returned. |
| XML | <deposits xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns |
| JSON |
{ "deposits": [ { "bank": "BankName", "acctNumber": "AcctNumber", "acctNickname": "AcctNickname", "nameOnAcct": "NameOnAcct", "routingNbr": "ABARouting", "accountType": "AcctTypeCode", "depositType": DDepositCodeID, "depositTypeDesc": "Deposit code Name from DDepositeCode table", "amount": Amount, "priority": Priority, "startDate": "StartDate", "stopDate": "StopDate" }, { "bank": "GESA Credit Union", "acctNumber": "50505968", "nameOnAcct": "Tanisha Jones", "routingNbr": "123123123", "accountType": "2", "depositType": 5, "depositTypeDesc": "Flat Amount", "amount": 400, "priority": 2, "startDate": "2003-08-01T00:00:00" } ] } |
| |
| Resource Information | |
| Requires Authentication? | Yes |
| Response Formats | json xml |
| HTTP Methods | GET |
| Request Content | N/A |
| Return Code | 200: Response Completed 403: Incorrect Authorization 400: Bad Data 404: No changes exist |
| API Version | v1.1 only |