BusinessActivityTypesApi.md

SynergiTech\Sage\BusinessActivityTypesApi

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

Method	HTTP request	Description
getBusinessActivityTypes()	GET /business_activity_types	Returns all Business Activity Types
getBusinessActivityTypesKey()	GET /business_activity_types/{key}	Returns a Business Activity Type

getBusinessActivityTypes()

getBusinessActivityTypes($itemsPerPage, $page, $attributes): \SynergiTech\Sage\Model\BusinessActivityType[]

Returns all Business Activity Types

Endpoint Availability * Accounting Plus: 🇫🇷 * Accounting Standard: 🇫🇷 * Accounting Start: 🇫🇷

Example

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



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

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

Parameters

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

Return type

\SynergiTech\Sage\Model\BusinessActivityType[]

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]

getBusinessActivityTypesKey()

getBusinessActivityTypesKey($key, $attributes): \SynergiTech\Sage\Model\BusinessActivityType

Returns a Business Activity Type

Endpoint Availability * Accounting Plus: 🇫🇷 * Accounting Standard: 🇫🇷 * Accounting Start: 🇫🇷

Example

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



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

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

Parameters

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

Return type

\SynergiTech\Sage\Model\BusinessActivityType

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]