Overview
Retrieve expense List of the client
Retrieve expense List of the client
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/expense/list.html?token=XXXXXXXX&userId={userId}
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/expense/list.html?token=XXXXXXXX&userId={userId}
Arguments
| clientId required |
MobiWork assigned unique ID of the company |
| versionNumber required |
Version number of MobiWork API SDK release. Current version is: 10.0.78 |
| token required |
Part of URL as a request parameter and is required in every call to verify access to API calls |
| userId optional |
If provided, this User ID will be taken as a logged in user |
Filter or Search Criteria
| description | By expense description |
| status | By status of expense |
| externalId | By external ID of expense |
| category | By cateogry of expense |
| createdDateFrom | By created date of expense |
| createdDateTo | By created date of expense |
| dueDateFrom | By due date of expense |
| dueDateTo | By due date of expense |
Return
Returns a list of expense Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 expenses will be returned. Returns an error if not a valid request
Returns a list of expense Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 expenses will be returned. Returns an error if not a valid request
Request Body XSD
Response Body XSD
Curl Example
| HTTP Method: | POST |
| Request: | curl -k -X POST "https://www.mobiwork.com/api/rest/12014/5.0.141/expense/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data'<request><status>Status 1</status></request>' |
| Response: |
<?xml version="1.0" encoding="UTF-8" ?> <response version="5.0.141" statusCode="1"> <expenseList> <expense> <customStatusName></customStatusName> <amount></amount> <categoryName>1</categoryName> <createdById>123</createdById> <createdByName></createdByName> <createdDate>Mon Sep 26 06:35:29 EDT 2018</createdDate> <entityId></entityId> <entityName>Name</entityName> <entityReferenceId>160</entityReferenceId> <entityReferenceName></entityReferenceName> <entityType>Type</entityType> <expenseId>10</expenseId> <externalId>33445</externalId> </expense> </expenseList> </response> |