Skip to content

Latest commit

 

History

History
329 lines (231 loc) · 15 KB

ContactsApi.md

File metadata and controls

329 lines (231 loc) · 15 KB

SynergiTech\Sage\ContactsApi

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

Method HTTP request Description
deleteContactsKey() DELETE /contacts/{key} Deletes a Contact
getContacts() GET /contacts Returns all Contacts
getContactsKey() GET /contacts/{key} Returns a Contact
postContacts() POST /contacts Creates a Contact
putContactsKey() PUT /contacts/{key} Updates a Contact

deleteContactsKey()

deleteContactsKey($key)

Deletes a Contact

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any mentioned role in one of the listed areas: * Area: Contacts: Full Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$key = 'key_example'; // string | The Contact Key.

try {
    $apiInstance->deleteContactsKey($key);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->deleteContactsKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
key string The Contact Key.

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]

getContacts()

getContacts($updatedOrCreatedSince, $deletedSince, $contactTypeId, $excludeSystem, $nestedAttributes, $showBalance, $contextDate, $search, $email, $showUnfinishedRecurringInvoicesStatus, $filterInactiveContacts, $itemsPerPage, $page, $attributes): \SynergiTech\Sage\Model\Contact[]

Returns all Contacts

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any mentioned role in one of the listed areas: * Area: Contacts: Read Only, Restricted Access, Full Access * Area: Sales: Read Only, Restricted Access, Full Access * Area: Purchases: Read Only, Restricted Access, Full Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$updatedOrCreatedSince = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to limit the response to Contacts changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.
$deletedSince = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to limit the response to Contacts deleted since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Not inclusive of the passed timestamp.
$contactTypeId = 'contactTypeId_example'; // string | Use this to filter by contact type id
$excludeSystem = True; // bool | Use this to filter out system entities, not applicable for transaction creation
$nestedAttributes = 'nestedAttributes_example'; // string | Specify the attributes that you want to expose for nested entities of the Contacts (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)
$showBalance = True; // bool | Use this to display the balance for a contact.
$contextDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to determine the correct tax treatment for a contact on a given date.
$search = 'search_example'; // string | Use this to filter by the contact name, company name or reference.
$email = 'email_example'; // string | Use this to filter by the contact person email address.
$showUnfinishedRecurringInvoicesStatus = True; // bool
$filterInactiveContacts = True; // bool | Use this to filter inactive contacts
$itemsPerPage = 20; // int | Returns the given number of Contacts per request.
$page = 1; // int | Go to specific page of Contacts
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Contacts (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

try {
    $result = $apiInstance->getContacts($updatedOrCreatedSince, $deletedSince, $contactTypeId, $excludeSystem, $nestedAttributes, $showBalance, $contextDate, $search, $email, $showUnfinishedRecurringInvoicesStatus, $filterInactiveContacts, $itemsPerPage, $page, $attributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->getContacts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
updatedOrCreatedSince \DateTime Use this to limit the response to Contacts changed since a given date (format: YYYY-MM-DDT(+ -)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+
deletedSince \DateTime Use this to limit the response to Contacts deleted since a given date (format: YYYY-MM-DDT(+ -)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+
contactTypeId string Use this to filter by contact type id [optional]
excludeSystem bool Use this to filter out system entities, not applicable for transaction creation [optional]
nestedAttributes string Specify the attributes that you want to expose for nested entities of the Contacts (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path) [optional]
showBalance bool Use this to display the balance for a contact. [optional]
contextDate \DateTime Use this to determine the correct tax treatment for a contact on a given date. [optional]
search string Use this to filter by the contact name, company name or reference. [optional]
email string Use this to filter by the contact person email address. [optional]
showUnfinishedRecurringInvoicesStatus bool [optional]
filterInactiveContacts bool Use this to filter inactive contacts [optional]
itemsPerPage int Returns the given number of Contacts per request. [optional] [default to 20]
page int Go to specific page of Contacts [optional] [default to 1]
attributes string Specify the attributes that you want to expose for the Contacts (expose all attributes with 'all'). These are in addition to the base attributes (name, path) [optional]

Return type

\SynergiTech\Sage\Model\Contact[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

getContactsKey()

getContactsKey($key, $nestedAttributes, $showBalance, $contextDate, $showUnfinishedRecurringInvoicesStatus, $attributes): \SynergiTech\Sage\Model\Contact

Returns a Contact

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any mentioned role in one of the listed areas: * Area: Contacts: Read Only, Restricted Access, Full Access * Area: Sales: Read Only, Restricted Access, Full Access * Area: Purchases: Read Only, Restricted Access, Full Access * Area: Bank: Read Only, Restricted Access, Full Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$key = 'key_example'; // string | The Contact Key.
$nestedAttributes = 'nestedAttributes_example'; // string | Specify the attributes that you want to expose for nested entities of the Contact (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)
$showBalance = True; // bool | Use this to display the balance for a contact.
$contextDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to determine the correct tax treatment for a contact on a given date.
$showUnfinishedRecurringInvoicesStatus = true; // bool
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Contact (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

try {
    $result = $apiInstance->getContactsKey($key, $nestedAttributes, $showBalance, $contextDate, $showUnfinishedRecurringInvoicesStatus, $attributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->getContactsKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
key string The Contact Key.
nestedAttributes string Specify the attributes that you want to expose for nested entities of the Contact (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path) [optional]
showBalance bool Use this to display the balance for a contact. [optional]
contextDate \DateTime Use this to determine the correct tax treatment for a contact on a given date. [optional]
showUnfinishedRecurringInvoicesStatus bool [optional] [default to true]
attributes string Specify the attributes that you want to expose for the Contact (expose all attributes with 'all'). These are in addition to the base attributes (name, path) [optional]

Return type

\SynergiTech\Sage\Model\Contact

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

postContacts()

postContacts($contacts): \SynergiTech\Sage\Model\Contact

Creates a Contact

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any mentioned role in one of the listed areas: * Area: Contacts: Restricted Access, Full Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$contacts = new \SynergiTech\Sage\Model\PostContacts(); // \SynergiTech\Sage\Model\PostContacts

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

Parameters

Name Type Description Notes
contacts \SynergiTech\Sage\Model\PostContacts

Return type

\SynergiTech\Sage\Model\Contact

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

putContactsKey()

putContactsKey($key, $contacts): \SynergiTech\Sage\Model\Contact

Updates a Contact

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any mentioned role in one of the listed areas: * Area: Contacts: Restricted Access, Full Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$key = 'key_example'; // string | The Contact Key.
$contacts = new \SynergiTech\Sage\Model\PutContacts(); // \SynergiTech\Sage\Model\PutContacts

try {
    $result = $apiInstance->putContactsKey($key, $contacts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->putContactsKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
key string The Contact Key.
contacts \SynergiTech\Sage\Model\PutContacts

Return type

\SynergiTech\Sage\Model\Contact

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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