Features - Connectors Framework - Inbound REST API - Customers
Customer
Overview
All the API methods available for customer
Parameters
Allows the API to create and update your customers. You can retrieve individual customers as well as a list of all your customers.
mobiworkCustomerId
required
Long
An unique ID representing an internal ID at MobiWork
externalCustomerId
optional
String
The third-party clients internal ID
companyName
optional
String
Company Name of the customer if customer is business type
fromDate
optional
String
Date from which this customer is active
type
optional
String
Type of the customer. RESIDENTIAL or BUSINESS. Default is BUSINESS
statusId
optional
Long
Custom status of the customer if any defined in customer settings
enabled
optional
String
Indicates if the customer is enabled or not
assignedTo
optional
Long
A customer can be assigned to user existing in MobiWork
closingDate
optional
String
Expected Closing Date if the customer is a prospect
prospectFlag
optional
String
Indicates if this customer is a prospect
address
required
Address Object
Address of the customer
contact
required
Contact Object
Primary contact of the customer
addressList
required
List of Address Objects
List of Addresses of the customer
contactList
required
List of Contact Objects
List of contacts of the customer
customFields
optional
Object
List of custom fields defined in customer settings
mobiForms
optional
Object
List of Forms and Form fields defined in customer settings
Example
<customer>
<mobiworkCustomerId>501266</mobiworkCustomerId>
<externalCustomerId>API4444</externalCustomerId>
<companyName>API Test</companyName>
<fromDate>05/19/2021</fromDate>
<type>BUSINESS</type>
<statusId>589</statusId>
<enabled>true</enabled>
<assignedTo></assignedTo>
<closingDate></closingDate>
<prospectFlag>false</prospectFlag>
<address>
<addressId>818635</addressId>
<address1>160 Congress Park Dr</address1>
<address2></address2>
<city>Delray Beach</city>
<state>Florida</state>
<zipCode>33445</zipCode>
<countryId>1</countryId>
<latitude>26.4582132</latitude>
<longitude>-80.0940502</longitude>
<name>Primary Address</name>
<baseDistance>9022407</baseDistance>
</address>
<contact>
<contactId>685033</contactId>
<customerId>501266</customerId>
<firstName>API4</firstName>
<lastName>API4</lastName>
<title></title>
<email></email>
<phoneNumber>516156111</phoneNumber>
<altPhoneNumber></altPhoneNumber>
<phoneExt></phoneExt>
<altPhoneExt></altPhoneExt>
<pin>8921</pin>
<enabled>true</enabled>
<createdDate>Mon Sep 26 06:35:29 EDT 2016</createdDate>
<fax></fax>
<admin>true</admin>
<employeeId></employeeId>
<loginId></loginId>
<password></password>
</contact>
<addressList></addressList>
<contactList></contactList>
<customFields>
<customField>
<fieldType>4</fieldType>
<apiName>ServiceContract</apiName>
<index>0</index>
<value>false</value>
<name>Service Contract?</name>
</customField>
<customField>
<fieldType>4</fieldType>
<apiName>ServiceContract</apiName>
<index>0</index>
<value>false</value>
<name>Service Contract?</name>
</customField>
</customFields>
<mobiForms>
<mobiForm>
<filledFormId>1034</filledFormId>
<apiName>CustomFields</apiName>
<name>Custom Fields</name>
<pdfUrl></pdfUrl>
<createdDate>05/19/2021</createdDate>
<name>Custom Fields</name>
<customFields>
<customField>
</customField>
</customFields>
</mobiForm>
</mobiForms>
</customer>