SynergiTech\Iplicit\ContactAccountApi

All URIs are relative to https://api.iplicit.com, except if the operation defines another base path.

Method	HTTP request	Description
addContactAccountContact()	POST /api/ContactAccount/{contactAccountRef}/contacts	Add related contacts
addContactToContactAccount()	POST /api/ContactAccount/{ca}/contactLinks/{cb}	Add an existing contact to a contact account.
createContactAccount()	POST /api/ContactAccount	Create a contact account
deleteContactAccount()	DELETE /api/ContactAccount/{contactAccountRef}/contacts/{contactRef}	Delete a related contact
deleteContactFromContactAccount()	DELETE /api/ContactAccount/{ca}/contactLinks/{cb}	Remove an existing contact from a contact account.
getContactAccount()	GET /api/ContactAccount/{contactAccountRef}	Get a contact account
getContactAccountBankAccounts()	GET /api/ContactAccount/{contactAccountRef}/bankDetails	Get all the bank details
getContactAccountCustomerDetails()	GET /api/ContactAccount/{contactAccountRef}/customer	Get the customer details of the contact account
getContactAccountDefaultBankAccount()	GET /api/ContactAccount/{contactAccountRef}/defaultBankDetails	Get the default bank details
getContactAccountMainContact()	GET /api/ContactAccount/{contactAccountRef}/contact	Get the main contact details of the contact account
getContactAccountRelatedContact()	GET /api/ContactAccount/{contactAccountRef}/contacts/{contactRef}	Get an existing related contact
getContactAccountRelatedContacts()	GET /api/ContactAccount/{contactAccountRef}/contacts	Get the related contacts
getContactAccountResource()	GET /api/ContactAccount/{contactAccountRef}/resource	Get the resource details of the contact account
getContactAccountSupplierDefaults()	GET /api/ContactAccount/{contactAccountRef}/supplier	Get the supplier details of the contact account
getContactAccounts()	GET /api/ContactAccount	Gets a list of contact accounts with a search filter
lockContactAccount()	POST /api/ContactAccount/{contactAccountRef}/lock
lockContactAccountResource()	POST /api/ContactAccount/{contactAccountRef}/resource/lock	Lock the contact account resource
lockCustomer()	POST /api/ContactAccount/{contactAccountRef}/customer/lock	Lock the customer
lockSupplier()	POST /api/ContactAccount/{contactAccountRef}/supplier/lock	Lock the supplier
unlockContactAccount()	POST /api/ContactAccount/{contactAccountRef}/unlock	Unlock the contact account
unlockContactAccountResource()	POST /api/ContactAccount/{contactAccountRef}/resource/unlock	Unlock the contact account resource
unlockCustomer()	POST /api/ContactAccount/{contactAccountRef}/customer/unlock	Unlock the customer
unlockSupplier()	POST /api/ContactAccount/{contactAccountRef}/supplier/unlock	Unlock the supplier
updateContactAccount()	PATCH /api/ContactAccount/{contactAccountRef}	Update a contact account
updateContactAccountBankDetails()	PATCH /api/ContactAccount/{contactAccountRef}/bankDetails/default	Replace bank details
updateContactAccountContact()	PATCH /api/ContactAccount/{contactAccountRef}/contacts/{contactRef}	Update an existing related contact
updateContactAccountMainContact()	PATCH /api/ContactAccount/{contactAccountRef}/contact	Update the main contact details
updateContactAccountRelatedContacts()	PATCH /api/ContactAccount/{contactAccountRef}/contacts	Update existing contacts. Existing contacts are matched to request contacts by ID, IntRef or Description and updated. Existing contacts that do not match any request contact are left unchanged. Request contacts that do not match any existing contact are added.

`addContactAccountContact()`

addContactAccountContact($contactAccountRef, $contactUpdate): string

Add related contacts

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
$contactUpdate = new \SynergiTech\Iplicit\Model\ContactUpdate(); // \SynergiTech\Iplicit\Model\ContactUpdate |

try {
    $result = $apiInstance->addContactAccountContact($contactAccountRef, $contactUpdate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->addContactAccountContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
contactUpdate	\SynergiTech\Iplicit\Model\ContactUpdate		[optional]

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`addContactToContactAccount()`

addContactToContactAccount($ca, $cb)

Add an existing contact to a contact account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$ca = 'ca_example'; // string | contact account id or code
$cb = 'cb_example'; // string | contact id or intRef

try {
    $apiInstance->addContactToContactAccount($ca, $cb);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->addContactToContactAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
ca	string	contact account id or code
cb	string	contact id or intRef

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createContactAccount()`

createContactAccount($contactAccountCreate): string

Create a contact account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountCreate = new \SynergiTech\Iplicit\Model\ContactAccountCreate(); // \SynergiTech\Iplicit\Model\ContactAccountCreate |

try {
    $result = $apiInstance->createContactAccount($contactAccountCreate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->createContactAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountCreate	\SynergiTech\Iplicit\Model\ContactAccountCreate		[optional]

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteContactAccount()`

deleteContactAccount($contactAccountRef, $contactRef)

Delete a related contact

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
$contactRef = 'contactRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact

try {
    $apiInstance->deleteContactAccount($contactAccountRef, $contactRef);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->deleteContactAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
contactRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteContactFromContactAccount()`

deleteContactFromContactAccount($ca, $cb)

Remove an existing contact from a contact account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$ca = 'ca_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
$cb = 'cb_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact

try {
    $apiInstance->deleteContactFromContactAccount($ca, $cb);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->deleteContactFromContactAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
ca	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
cb	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getContactAccount()`

getContactAccount($contactAccountRef, $include): \SynergiTech\Iplicit\Model\ContactAccountRead

Get a contact account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
$include = 'customer,supplier'; // string | Comma separated list of detail notes to include. Permitted values are `customer`, `supplier`, `resource`, `contact`, `contacts`, `defaultBankDetails`, `allBankDetails`. Default is `customer,supplier`.

try {
    $result = $apiInstance->getContactAccount($contactAccountRef, $include);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->getContactAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
include	string	Comma separated list of detail notes to include. Permitted values are `customer`, `supplier`, `resource`, `contact`, `contacts`, `defaultBankDetails`, `allBankDetails`. Default is `customer,supplier`.	[optional] [default to 'customer,supplier']

Return type

\SynergiTech\Iplicit\Model\ContactAccountRead

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getContactAccountBankAccounts()`

getContactAccountBankAccounts($contactAccountRef): \SynergiTech\Iplicit\Model\ContactBankDetailsRead[]

Get all the bank details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $result = $apiInstance->getContactAccountBankAccounts($contactAccountRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->getContactAccountBankAccounts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

\SynergiTech\Iplicit\Model\ContactBankDetailsRead[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getContactAccountCustomerDetails()`

getContactAccountCustomerDetails($contactAccountRef): \SynergiTech\Iplicit\Model\ContactCustomerRead

Get the customer details of the contact account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $result = $apiInstance->getContactAccountCustomerDetails($contactAccountRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->getContactAccountCustomerDetails: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

\SynergiTech\Iplicit\Model\ContactCustomerRead

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getContactAccountDefaultBankAccount()`

getContactAccountDefaultBankAccount($contactAccountRef): \SynergiTech\Iplicit\Model\ContactBankDetailsRead

Get the default bank details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $result = $apiInstance->getContactAccountDefaultBankAccount($contactAccountRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->getContactAccountDefaultBankAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

\SynergiTech\Iplicit\Model\ContactBankDetailsRead

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getContactAccountMainContact()`

getContactAccountMainContact($contactAccountRef): \SynergiTech\Iplicit\Model\ContactRead

Get the main contact details of the contact account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $result = $apiInstance->getContactAccountMainContact($contactAccountRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->getContactAccountMainContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

\SynergiTech\Iplicit\Model\ContactRead

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getContactAccountRelatedContact()`

getContactAccountRelatedContact($contactAccountRef, $contactRef): \SynergiTech\Iplicit\Model\ContactRead

Get an existing related contact

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
$contactRef = 'contactRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact

try {
    $result = $apiInstance->getContactAccountRelatedContact($contactAccountRef, $contactRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->getContactAccountRelatedContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
contactRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact

Return type

\SynergiTech\Iplicit\Model\ContactRead

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getContactAccountRelatedContacts()`

getContactAccountRelatedContacts($contactAccountRef): \SynergiTech\Iplicit\Model\ContactRead[]

Get the related contacts

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $result = $apiInstance->getContactAccountRelatedContacts($contactAccountRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->getContactAccountRelatedContacts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

\SynergiTech\Iplicit\Model\ContactRead[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getContactAccountResource()`

getContactAccountResource($contactAccountRef): \SynergiTech\Iplicit\Model\ContactResourceRead

Get the resource details of the contact account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $result = $apiInstance->getContactAccountResource($contactAccountRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->getContactAccountResource: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

\SynergiTech\Iplicit\Model\ContactResourceRead

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getContactAccountSupplierDefaults()`

getContactAccountSupplierDefaults($contactAccountRef): \SynergiTech\Iplicit\Model\ContactSupplierRead

Get the supplier details of the contact account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $result = $apiInstance->getContactAccountSupplierDefaults($contactAccountRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->getContactAccountSupplierDefaults: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

\SynergiTech\Iplicit\Model\ContactSupplierRead

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getContactAccounts()`

getContactAccounts($code, $intRef, $descriptionContains, $lastModifiedFrom, $lastModifiedTo, $isCustomer, $isSupplier, $isResource, $include, $take, $skip): \SynergiTech\Iplicit\Model\ContactAccountRead[]

Gets a list of contact accounts with a search filter

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$code = 'code_example'; // string | Code. <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">Learn more</a>
$intRef = 'intRef_example'; // string | Optional interface reference. If provided, it must be unique. <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">Learn more</a>
$descriptionContains = 'descriptionContains_example'; // string | Description contains
$lastModifiedFrom = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Last modified from (UTC)
$lastModifiedTo = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Last modified until (UTC)
$isCustomer = True; // bool | Include/exclude customers
$isSupplier = True; // bool | Include/exclude suppliers
$isResource = True; // bool | Include/exclude resources
$include = 'customer,supplier'; // string | Comma separated list of detail notes to include: `customer`, `supplier`, `resource`, `contact`, `contacts`, `defaultBankDetails`, `allBankDetails`. If omitted, will default to `customer,supplier`.
$take = 100; // int | The number of records to return
$skip = 0; // int | The number of records to skip

try {
    $result = $apiInstance->getContactAccounts($code, $intRef, $descriptionContains, $lastModifiedFrom, $lastModifiedTo, $isCustomer, $isSupplier, $isResource, $include, $take, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->getContactAccounts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
code	string	Code. <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">Learn more</a>	[optional]
intRef	string	Optional interface reference. If provided, it must be unique. <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">Learn more</a>	[optional]
descriptionContains	string	Description contains	[optional]
lastModifiedFrom	\DateTime	Last modified from (UTC)	[optional]
lastModifiedTo	\DateTime	Last modified until (UTC)	[optional]
isCustomer	bool	Include/exclude customers	[optional]
isSupplier	bool	Include/exclude suppliers	[optional]
isResource	bool	Include/exclude resources	[optional]
include	string	Comma separated list of detail notes to include: `customer`, `supplier`, `resource`, `contact`, `contacts`, `defaultBankDetails`, `allBankDetails`. If omitted, will default to `customer,supplier`.	[optional] [default to 'customer,supplier']
take	int	The number of records to return	[optional] [default to 100]
skip	int	The number of records to skip	[optional] [default to 0]

Return type

\SynergiTech\Iplicit\Model\ContactAccountRead[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`lockContactAccount()`

lockContactAccount($contactAccountRef)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string

try {
    $apiInstance->lockContactAccount($contactAccountRef);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->lockContactAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`lockContactAccountResource()`

lockContactAccountResource($contactAccountRef)

Lock the contact account resource

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $apiInstance->lockContactAccountResource($contactAccountRef);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->lockContactAccountResource: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`lockCustomer()`

lockCustomer($contactAccountRef)

Lock the customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $apiInstance->lockCustomer($contactAccountRef);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->lockCustomer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`lockSupplier()`

lockSupplier($contactAccountRef)

Lock the supplier

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $apiInstance->lockSupplier($contactAccountRef);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->lockSupplier: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`unlockContactAccount()`

unlockContactAccount($contactAccountRef)

Unlock the contact account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $apiInstance->unlockContactAccount($contactAccountRef);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->unlockContactAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`unlockContactAccountResource()`

unlockContactAccountResource($contactAccountRef)

Unlock the contact account resource

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $apiInstance->unlockContactAccountResource($contactAccountRef);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->unlockContactAccountResource: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`unlockCustomer()`

unlockCustomer($contactAccountRef)

Unlock the customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $apiInstance->unlockCustomer($contactAccountRef);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->unlockCustomer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`unlockSupplier()`

unlockSupplier($contactAccountRef)

Unlock the supplier

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

try {
    $apiInstance->unlockSupplier($contactAccountRef);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->unlockSupplier: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateContactAccount()`

updateContactAccount($contactAccountRef, $contactAccountUpdate): string

Update a contact account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
$contactAccountUpdate = new \SynergiTech\Iplicit\Model\ContactAccountUpdate(); // \SynergiTech\Iplicit\Model\ContactAccountUpdate |

try {
    $result = $apiInstance->updateContactAccount($contactAccountRef, $contactAccountUpdate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->updateContactAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
contactAccountUpdate	\SynergiTech\Iplicit\Model\ContactAccountUpdate		[optional]

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateContactAccountBankDetails()`

updateContactAccountBankDetails($contactAccountRef, $contactBankDetailsUpdateable)

Replace bank details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
$contactBankDetailsUpdateable = new \SynergiTech\Iplicit\Model\ContactBankDetailsUpdateable(); // \SynergiTech\Iplicit\Model\ContactBankDetailsUpdateable |

try {
    $apiInstance->updateContactAccountBankDetails($contactAccountRef, $contactBankDetailsUpdateable);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->updateContactAccountBankDetails: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
contactBankDetailsUpdateable	\SynergiTech\Iplicit\Model\ContactBankDetailsUpdateable		[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateContactAccountContact()`

updateContactAccountContact($contactAccountRef, $contactRef, $contactUpdate)

Update an existing related contact

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
$contactRef = 'contactRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact
$contactUpdate = new \SynergiTech\Iplicit\Model\ContactUpdate(); // \SynergiTech\Iplicit\Model\ContactUpdate |

try {
    $apiInstance->updateContactAccountContact($contactAccountRef, $contactRef, $contactUpdate);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->updateContactAccountContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
contactRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact
contactUpdate	\SynergiTech\Iplicit\Model\ContactUpdate		[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateContactAccountMainContact()`

updateContactAccountMainContact($contactAccountRef, $contactUpdate)

Update the main contact details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
$contactUpdate = new \SynergiTech\Iplicit\Model\ContactUpdate(); // \SynergiTech\Iplicit\Model\ContactUpdate |

try {
    $apiInstance->updateContactAccountMainContact($contactAccountRef, $contactUpdate);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->updateContactAccountMainContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
contactUpdate	\SynergiTech\Iplicit\Model\ContactUpdate		[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateContactAccountRelatedContacts()`

updateContactAccountRelatedContacts($contactAccountRef, $contactUpdate)

Update existing contacts. Existing contacts are matched to request contacts by ID, IntRef or Description and updated. Existing contacts that do not match any request contact are left unchanged. Request contacts that do not match any existing contact are added.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactAccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactAccountRef = 'contactAccountRef_example'; // string | Id, code or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
$contactUpdate = array(new \SynergiTech\Iplicit\Model\ContactUpdate()); // \SynergiTech\Iplicit\Model\ContactUpdate[] |

try {
    $apiInstance->updateContactAccountRelatedContacts($contactAccountRef, $contactUpdate);
} catch (Exception $e) {
    echo 'Exception when calling ContactAccountApi->updateContactAccountRelatedContacts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactAccountRef	string	Id, code or <a href="https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact account
contactUpdate	\SynergiTech\Iplicit\Model\ContactUpdate[]		[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ContactAccountApi.md

Latest commit

History

ContactAccountApi.md

File metadata and controls

SynergiTech\Iplicit\ContactAccountApi

addContactAccountContact()

Example

Parameters

Return type

Authorization

HTTP request headers

addContactToContactAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

createContactAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteContactAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteContactFromContactAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

getContactAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

getContactAccountBankAccounts()

Example

Parameters

Return type

Authorization

HTTP request headers

getContactAccountCustomerDetails()

Example

Parameters

Return type

Authorization

HTTP request headers

getContactAccountDefaultBankAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

getContactAccountMainContact()

Example

Parameters

Return type

Authorization

HTTP request headers

getContactAccountRelatedContact()

Example

Parameters

Return type

Authorization

HTTP request headers

getContactAccountRelatedContacts()

Example

Parameters

Return type

Authorization

HTTP request headers

getContactAccountResource()

`addContactAccountContact()`

`addContactToContactAccount()`

`createContactAccount()`

`deleteContactAccount()`

`deleteContactFromContactAccount()`

`getContactAccount()`

`getContactAccountBankAccounts()`

`getContactAccountCustomerDetails()`

`getContactAccountDefaultBankAccount()`

`getContactAccountMainContact()`

`getContactAccountRelatedContact()`

`getContactAccountRelatedContacts()`

`getContactAccountResource()`

`getContactAccountSupplierDefaults()`

`getContactAccounts()`

`lockContactAccount()`

`lockContactAccountResource()`

`lockCustomer()`

`lockSupplier()`

`unlockContactAccount()`

`unlockContactAccountResource()`

`unlockCustomer()`

`unlockSupplier()`