Skip to content

Latest commit

 

History

History
92 lines (70 loc) · 5.05 KB

TaxDeterminationsApi.md

File metadata and controls

92 lines (70 loc) · 5.05 KB

SynergiTech\Sage\TaxDeterminationsApi

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

Method HTTP request Description
getTaxDeterminations() GET /tax_determinations Returns all Tax Determinations

getTaxDeterminations()

getTaxDeterminations($usage, $artefactId, $artefactLineAmount, $artefactLineDescription, $artefactLineGoodsServicesType, $artefactLineId, $artefactLineTaxIncluded, $contactId, $date, $includeDestinationVat, $includeLineDetermination, $retailerRates, $itemsPerPage, $page, $attributes): \SynergiTech\Sage\Model\TaxRate[]

Returns all Tax Determinations

Endpoint Availability * Accounting Plus: 🇫🇷, 🇪🇸, 🇬🇧, 🇮🇪 * Accounting Standard: 🇫🇷, 🇪🇸, 🇬🇧, 🇮🇪 * Accounting Start: 🇫🇷, 🇪🇸, 🇬🇧, 🇮🇪 ### Access Control Restrictions Requires the authenticated user to have any of the following roles in the area Settings: Full Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\TaxDeterminationsApi(
    // 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()
);
$usage = 'usage_example'; // string | Tax rates with the intended usage
$artefactId = 'artefactId_example'; // string | The artefact id
$artefactLineAmount = 3.4; // float | The artefact line amount
$artefactLineDescription = 'artefactLineDescription_example'; // string | The artefact line description
$artefactLineGoodsServicesType = 'artefactLineGoodsServicesType_example'; // string | The artefact line goods and service type
$artefactLineId = 'artefactLineId_example'; // string | The artefact line id
$artefactLineTaxIncluded = 'artefactLineTaxIncluded_example'; // string | The artefact line includes tax
$contactId = 'contactId_example'; // string | Use this to filter by contact id
$date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to return results on a specified date.
$includeDestinationVat = True; // bool | Include destination vat
$includeLineDetermination = True; // bool | Include line determination
$retailerRates = True; // bool | Display recargo retailer rates
$itemsPerPage = 20; // int | Returns the given number of Tax Rates per request.
$page = 1; // int | Go to specific page of Tax Rates
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Tax Rates (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

try {
    $result = $apiInstance->getTaxDeterminations($usage, $artefactId, $artefactLineAmount, $artefactLineDescription, $artefactLineGoodsServicesType, $artefactLineId, $artefactLineTaxIncluded, $contactId, $date, $includeDestinationVat, $includeLineDetermination, $retailerRates, $itemsPerPage, $page, $attributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxDeterminationsApi->getTaxDeterminations: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
usage string Tax rates with the intended usage
artefactId string The artefact id [optional]
artefactLineAmount float The artefact line amount [optional]
artefactLineDescription string The artefact line description [optional]
artefactLineGoodsServicesType string The artefact line goods and service type [optional]
artefactLineId string The artefact line id [optional]
artefactLineTaxIncluded string The artefact line includes tax [optional]
contactId string Use this to filter by contact id [optional]
date \DateTime Use this to return results on a specified date. [optional]
includeDestinationVat bool Include destination vat [optional]
includeLineDetermination bool Include line determination [optional]
retailerRates bool Display recargo retailer rates [optional]
itemsPerPage int Returns the given number of Tax Rates per request. [optional] [default to 20]
page int Go to specific page of Tax Rates [optional] [default to 1]
attributes string Specify the attributes that you want to expose for the Tax Rates (expose all attributes with 'all'). These are in addition to the base attributes (name, path) [optional]

Return type

\SynergiTech\Sage\Model\TaxRate[]

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]