- Overview
- Account Settings
- Assets
- Connectors Framework
- Customer Portal
- Customers
- Dashboards
- Devices
- Dispatching
- Forms
- Inventory
- Invoices & Billing
- Locations
- Payments
- Parts
- Projects
- Quotes
- Recurrent Routes
- Recurrent Services
- Reports
- Sales Orders
- Schedule
- Services
- Tasks
- Text Messaging
- Time Tracking
- Users
- Work Orders
Overview
Retrieve invoice List of the client
Retrieve invoice List of the client
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/invoice/list.html?token=XXXXXXXX&userId={userId}
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/invoice/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 invoice description |
| status | By status of invoice |
| externalId | By external ID of invoice |
| category | By cateogry of invoice |
| createdDateFrom | By created date of invoice |
| createdDateTo | By created date of invoice |
| dueDateFrom | By due date of invoice |
| dueDateTo | By due date of invoice |
Return
Returns a list of invoice Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 invoices will be returned. Returns an error if not a valid request
Returns a list of invoice Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 invoices 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/invoice/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data'<request><invoice> <externalId></externalId> <createdBy>1</createdBy> <createdDateFrom></createdDateFrom> <createdDateTo></createdDateTo> <status></status> <integrationStatus></integrationStatus> </invoice> </request>' |
| Response: |
<?xml version="1.0" encoding="UTF-8" ?> <response version="5.0.141" statusCode="1"> <invoiceList> <invoice><status>OPEN</status><balance>0.0</balance><comments>null</comments><createdBy>Mobi Admin</createdBy><createdDate>Thu May 16 14:12:04 CAT 2019</createdDate> <customer> <status>0</status><address><address1>927 Warehouse Road</address1><address2></address2><city>Kansas City</city><countryId>0</countryId><latitude>0.0</latitude> <longitude>0.0</longitude><name>927 Warehouse Road</name><state>null</state><zipCode>59782-1775</zipCode></address><assignedTo>0</assignedTo><companyName>ACME Plumbing</companyName> <externalCustomerId>74,QBO</externalCustomerId> <primaryContact> <altPhoneExt>null</altPhoneExt><altPhoneNumber>null</altPhoneNumber><email>carlj@netgateway.com</email><fax> </fax><firstName>Mr. Carl Jenner</firstName><lastName>Mr. Carl Jenner</lastName><PhoneExt>null</PhoneExt><PhoneNumber></PhoneNumber><title>null</title> </primaryContact> <taxable>false</taxable><typeId>BUSINESS</typeId> </customer> <customerId>81</customerId><externalId>null</externalId><integrationStatus>null</integrationStatus><invoiceDate>null</invoiceDate><invoiceDueDate>null</invoiceDueDate><invoiceId>3</invoiceId> <invoicePaymentDate>null</invoicePaymentDate><taxAmount>0.0</taxAmount><total>0.0</total> <invoiceItemList> <invoiceItem> <quantity>1.0</quantity><cost>0.0</cost><createdDate>Thu May 16 14:12:08 CAT 2019</createdDate><description>null</description><invoiceItemId>5</invoiceItemId><price>0.0</price> <product> <externalId>A11050</externalId><categoryName>null</categoryName><competitorProduct>false</competitorProduct><cost>0.0</cost><description>13W Mini Fluorescent Bulb</description> <discountPercentAllowed>false</discountPercentAllowed><enabled>true</enabled><hasSerialNumbers>false</hasSerialNumbers><maxDiscountPercent>0.0</maxDiscountPercent> <mobiworkProductId>12</mobiworkProductId><modelNumber>A11050</modelNumber><name>13W Mini Fluorescent Bulb</name><points>0.0</points><price>0.0</price><priceIncludesTax>false</priceIncludesTax> <productType>PRODUCT</productType><quantity>0</quantity><sku>A11050</sku><subCategoryName>null</subCategoryName><tax>0.0</tax><taxable>false</taxable> </product> <rebate>0.0</rebate> <rebatePercent>0.0</rebatePercent><subTotal>0.0</subTotal><tax>0.0</tax><total>0.0</total><totalCost>0.0</totalCost><uomName>null</uomName><uomQty>1.0</uomQty> </invoiceItem> </invoiceItemList> <paymentList> </paymentList> </invoice> </invoiceList> </response> |