- 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
All the API methods available for invoice.
All the API methods available for invoice.
Table of Contents
Parameters
Allows the API to create and view your invoices. You can retrieve individual invoices as well as a list of all your invoices.
Allows the API to create and view your invoices. You can retrieve individual invoices as well as a list of all your invoices.
description optional |
String A description of the invoice |
status optional |
String Custom status of the invoice if any are defined in invoice settings |
customer optional |
Long The customer ID this invoice is for |
locationId optional |
Long The Id of the location this invoice is for |
category optional |
Long Category ID of the invoice's categories if any are defined in invoice settings |
assignedTo optional |
String A invoice can be assigned to user existing in MobiWork |
externalId required |
String The third-party client's internal ID |
dueDate required |
String The date which the invoice is due |
address optional |
Address Object The address object associated with this invoice |
contact optional |
Contact Object The contact object associated with this invoice |
Example
<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>
<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>