CountryOfRegistrationsApi.md

SynergiTech\Sage\CountryOfRegistrationsApi

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

Method	HTTP request	Description
getCountriesOfRegistration()	GET /countries_of_registration	Returns all Country Of Registrations
getCountriesOfRegistrationKey()	GET /countries_of_registration/{key}	Returns a Country Of Registration

getCountriesOfRegistration()

getCountriesOfRegistration($itemsPerPage, $page, $attributes): \SynergiTech\Sage\Model\Base[]

Returns all Country Of Registrations

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸

Example

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



$apiInstance = new SynergiTech\Sage\Api\CountryOfRegistrationsApi(
    // 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()
);
$itemsPerPage = 20; // int | Returns the given number of Registered Countries per request.
$page = 1; // int | Go to specific page of Registered Countries
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Registered Countries (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

try {
    $result = $apiInstance->getCountriesOfRegistration($itemsPerPage, $page, $attributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountryOfRegistrationsApi->getCountriesOfRegistration: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
itemsPerPage	int	Returns the given number of Registered Countries per request.	[optional] [default to 20]
page	int	Go to specific page of Registered Countries	[optional] [default to 1]
attributes	string	Specify the attributes that you want to expose for the Registered Countries (expose all attributes with 'all'). These are in addition to the base attributes (name, path)	[optional]

Return type

\SynergiTech\Sage\Model\Base[]

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]

getCountriesOfRegistrationKey()

getCountriesOfRegistrationKey($key, $attributes): \SynergiTech\Sage\Model\Base

Returns a Country Of Registration

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸

Example

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



$apiInstance = new SynergiTech\Sage\Api\CountryOfRegistrationsApi(
    // 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 Country Of Registration Key.
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Registered Country (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

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

Parameters

Name	Type	Description	Notes
key	string	The Country Of Registration Key.
attributes	string	Specify the attributes that you want to expose for the Registered Country (expose all attributes with 'all'). These are in addition to the base attributes (name, path)	[optional]

Return type

\SynergiTech\Sage\Model\Base

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]