Finance APIs
Shows the VAT specification for a specific country and VAT period.
| HTTP method | GET |
| URI | https://api.rambase.net/base/companies/current/operating-countries/{countryId}/vat-specification?vatPeriod={vatPeriodId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {countryId} |
Country identifier
Integer, minimum 10000 |
| Successful HTTP status code | 200 |
| API resource identifier | 4062, version 10 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| vatPeriod Integer, optional |
Accounting period this VAT posting belongs to
Minimum: 190000, Maximum: 299999 |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
VATPeriod
Accounting period this VAT posting belongs to
>{Integer}</VATPeriod>VATPeriodType
how many vatPeriods there are in a year. 6 for example would mean two monthly vat reporting.
>{Integer}</VATPeriodType>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)
>{String}</VATRegistrationNumber>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>BankAccountId
Bank account identifier
>{Integer}</BankAccountId>BankAccountLink
Bank account identifier
>{String}</BankAccountLink>Name
Name of bank account
>{String}</Name>AccountNumber
Account number used to identify the bank account
>{String}</AccountNumber>LineId
Id of a line in Vat specification
>{String}</LineId>Title
Title of Vat specification line
>{String}</Title>NetAmount
Total net amount for this VAT code in this VAT posting
>{Decimal}</NetAmount>VATAmount
Total VAT amount for this VAT code in this VAT posting
>{Decimal}</VATAmount>VATCode
VAT code for this line, if there is one.
>{String}</VATCode>Rate
Rate used when calculating VAT amount
>{Decimal}</Rate>VATPeriod
Accounting period this VAT posting belongs to
": "{Integer}",VATPeriodType
how many vatPeriods there are in a year. 6 for example would mean two monthly vat reporting.
": "{Integer}",VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}"BankAccountId
Bank account identifier
": "{Integer}",BankAccountLink
Bank account identifier
": "{String}",Name
Name of bank account
": "{String}",AccountNumber
Account number used to identify the bank account
": "{String}"LineId
Id of a line in Vat specification
": "{String}",Title
Title of Vat specification line
": "{String}",NetAmount
Total net amount for this VAT code in this VAT posting
": "{Decimal}",VATAmount
Total VAT amount for this VAT code in this VAT posting
": "{Decimal}",VATCode
VAT code for this line, if there is one.
": "{String}",Rate
Rate used when calculating VAT amount
": "{Decimal}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 100169 HTTP 404 | General ledger account not found : {0} |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 107089 HTTP 400 | Vatspecification can't be different between the grouped companies |