All docs This doc

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel3
typeflat

...

Overview

The following operations allow you to work with contacts. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with contacts, see Sample configuration

OperationDescription

1Working with Contacts in BillomatcreateContact

Creates a contact for a specific client.

1Working with Contacts in BillomatgetContact

Retrieves specific contact details by its ID.

1Working with Contacts in BillomatlistContactsRetrieves all contacts.
1Working with Contacts in BillomatupdateContactUpdates the details of the contact.

Operation details

This section provides further details on the operations related to contacts.

Anchor
createContact
createContact
Creating a contact

The createContact operation creates a contact for a specific client.

Code Block
languagexml
titlecreateContact
<billomat.createContact>
    <clientId>{$ctx:clientId}</clientId>
    <label>{$ctx:label}</label>
    <name>{$ctx:name}</name>
    <street>{$ctx:street}</street>
    <zip>{$ctx:zip}</zip>
    <city>{$ctx:city}</city>
    <state>{$ctx:state}</state>
    <countryCode>{$ctx:countryCode}</countryCode>
    <firstName>{$ctx:firstName}</firstName>
    <lastName>{$ctx:lastName}</lastName>
    <salutation>{$ctx:salutation}</salutation>
    <phone>{$ctx:phone}</phone>
    <fax>{$ctx:fax}</fax>
    <mobile>{$ctx:mobile}</mobile>
    <email>{$ctx:email}</email>
	<webAddress>{$ctx:webAddress}</webAddress>
</billomat.createContact>
Properties
  • clientId: The ID of the client.
  • label: Label for the contact.
  • name: Company name of the contact.
  • street: Street of the contact.
  • zip: Zip code of the contact.
  • city: City of the contact.
  • state: State of the contact.
  • countryCode: Country of the contact.
  • firstName: First name of the contact.
  • lastName: Last name of the contact.
  • salutation: Salutation of the contact
  • lastName: Last name of the contact.
  • salutation: Salutation of the contact.
  • phone: Phone of the contact.
  • fax: Fax of the contact.
  • mobile: Mobile number of the contact.
  • email: E-mail of the contact.
  • webAddress: Website of the contact.
  
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the createContact operation.

Code Block
languagexml
titleSample Request for createContact
{
    "clientId": "567687",
    "label": "l1",
    "name": "elena gilbert",
    "street": "melb",
    "zip": "24",
    "city": "Leichster",
    "state": "Ontario",
    "countryCode": "CAN",
    "firstName": "elena",
    "lastName": "gilbert",
    "salutation": "Mrs",
    "phone": "35769809002",
    "fax": "1436578",
    "mobile": "1246778434",
    "email": "elena@gmail.com",
    "webAddress": "elena.com",
    "apiUrl": "https://mycompany.billomat.net",
    "apiKey": "735478efc440e219669e243c0fd71840",
    "format":"xml"
}
Related Billomat documentation

http://www.billomat.com/en/api/clients/contacts

Anchor
getContact
getContact
Retrieving specific contact details by its ID

The getContact operation retrieves specific contact details by its ID.

Code Block
languagexml
titlegetContact
<billomat.getContact>
    <contactId>{$ctx:contactId}</contactId>
</billomat.getContact>
Properties
  • contactId: The ID of the contact whose details need to be retrieved.
  
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the getContact operation.

Code Block
languagexml
titleSample Request for getContact
{
    "contactId": "243546",
    "apiUrl": "https://mycompany.billomat.net",
    "apiKey": "735478efc440e219669e243c0fd71840",
    "format":"xml"
}
Related Billomat documentation

http://www.billomat.com/en/api/clients/contacts

Anchor
listContacts
listContacts
Retrieving all contacts

The listContacts operation retrieves all contacts.

Code Block
languagexml
titlelistContacts
<billomat.listContacts>
    <clientId>{$ctx:clientId}</clientId>
    <page>{$ctx:page}</page>
    <perPage>{$ctx:perPage}</perPage>
	<orderBy>{$ctx:orderBy}</orderBy>
</billomat.listContacts>
Properties
  • clientId: The ID of the client.
  • page: Number of the page to return. Applies for paginated response.
  • perPage: Number of entries to return per page when results are paginated.
  • orderBy: Sorting orders to retrieve contacts.
  
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the listContacts operation.

Code Block
languagexml
titleSample Request for listContacts
{
    "clientId": "2454545",
    "page": "1",
    "perPage": "1",
    "apiUrl": "https://mycompany.billomat.net",
    "apiKey": "735478efc440e219669e243c0fd71840",
    "format":"xml",
    "orderBy":"id+DESC"
}
Related Billomat documentation

http://www.billomat.com/en/api/clients/contacts

Anchor
updateContact
updateContact
Updating the details of the contact

The updateContact operation updates the details of the contact.

Code Block
languagexml
titleupdateContact
<billomat.updateContact>
    <clientId>{$ctx:clientId}</clientId>
    <label>{$ctx:label}</label>
    <name>{$ctx:name}</name>
    <street>{$ctx:street}</street>
    <zip>{$ctx:zip}</zip>
    <city>{$ctx:city}</city>
    <state>{$ctx:state}</state>
    <countryCode>{$ctx:countryCode}</countryCode>
    <firstName>{$ctx:firstName}</firstName>
    <lastName>{$ctx:lastName}</lastName>
    <salutation>{$ctx:salutation}</salutation>
    <phone>{$ctx:phone}</phone>
    <fax>{$ctx:fax}</fax>
    <mobile>{$ctx:mobile}</mobile>
    <email>{$ctx:email}</email>
    <webAddress>{$ctx:webAddress}</webAddress>
	<contactId>{$ctx:contactId}</contactId>
</billomat.updateContact>
Properties
  • clientId: The ID of the client.
  • label: Label for the contact.
  • name: Company name of the contact.
  • street: Street of the contact.
  • zip: Zip code of the contact.
  • city: City of the contact.
  • state: State of the contact.
  • countryCode: Country of the contact.
  • firstName: First name of the contact.
  • lastName: Last name of the contact.
  • salutation: Salutation of the contact.
  • phone: Phone of the contact.
  • fax: Fax of the contact.
  • mobile: Mobile number of the contact.
  • email: E-mail address of the contact.
  • webAddress: Website of the contact.
  • contactId: The ID of the contact to update.
  
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the updateContact operation.

Code Block
languagexml
titleSample Request for updateContact
{
    "clientId": "567687",
    "label": "l1",
    "name": "elena gilbert",
    "street": "melb",
    "zip": "24",
    "city": "Leichster",
    "state": "Ontario",
    "countryCode": "CAN",
    "firstName": "elena",
    "lastName": "gilbert",
    "salutation": "Mrs",
    "phone": "35769809002",
    "fax": "1436578",
    "mobile": "1246778434",
    "email": "elena@gmail.com",
    "webAddress": "elena.com",
    "contactId": "3455678",
    "apiUrl": "https://mycompany.billomat.net",
    "apiKey": "735478efc440e219669e243c0fd71840",
    "format":"xml"
}
Related Billomat documentation

http://www.billomat.com/en/api/clients/contacts

Anchor
sampleconfiguration
sampleconfiguration
Sample configuration

Following is a sample proxy service that illustrates how to connect to Billomat with the init operation and use the createContact operation. The sample request for this proxy can be found in the createContact sample request.

Code Block
languagexml
titleSample Proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy name="billomat_createContact" startOnLoad="true" statistics="disable" trace="disable" transports="https,http" xmlns="http://ws.apache.org/ns/synapse">
   <target>
      <inSequence onError="faultHandlerSeq">
         <property name="apiUrl" expression="json-eval($.apiUrl)"/>
         <property name="apiKey" expression="json-eval($.apiKey)"/>
         <property name="clientId" expression="json-eval($.clientId)"/>
         <property name="label" expression="json-eval($.label)"/>
         <property name="name" expression="json-eval($.name)"/>
         <property name="street" expression="json-eval($.street)"/>
         <property name="zip" expression="json-eval($.zip)"/>
         <property name="city" expression="json-eval($.city)"/>
         <property name="state" expression="json-eval($.state)"/>
         <property name="countryCode" expression="json-eval($.countryCode)"/>
         <property name="firstName" expression="json-eval($.firstName)"/>
         <property name="lastName" expression="json-eval($.lastName)"/>
         <property name="salutation" expression="json-eval($.salutation)"/>
         <property name="phone" expression="json-eval($.phone)"/>
         <property name="fax" expression="json-eval($.fax)"/>
         <property name="mobile" expression="json-eval($.mobile)"/>
         <property name="email" expression="json-eval($.email)"/>
         <property name="webAddress" expression="json-eval($.webAddress)"/>
		 <property name="format" expression="json-eval($.format)"/>
         <billomat.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <apiKey>{$ctx:apiKey}</apiKey>
			<format>{$ctx:format}</format>
         </billomat.init>
         <billomat.createContact>
            <clientId>{$ctx:clientId}</clientId>
            <label>{$ctx:label}</label>
            <name>{$ctx:name}</name>
            <street>{$ctx:street}</street>
            <zip>{$ctx:zip}</zip>
            <city>{$ctx:city}</city>
            <state>{$ctx:state}</state>
            <countryCode>{$ctx:countryCode}</countryCode>
            <firstName>{$ctx:firstName}</firstName>
            <lastName>{$ctx:lastName}</lastName>
            <salutation>{$ctx:salutation}</salutation>
            <phone>{$ctx:phone}</phone>
            <fax>{$ctx:fax}</fax>
            <mobile>{$ctx:mobile}</mobile>
            <email>{$ctx:email}</email>
            <webAddress>{$ctx:webAddress}</webAddress>
         </billomat.createContact>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>