API

Finance APIs

GET finance/vat-postings

List of VAT postings

HTTP method GET
URI https://api.rambase.net/finance/vat-postings
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 2231, version 13

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.

Format:
1
1

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.

$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
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

IsPostponed() Named filter VAT postponed (ISPOSTPONED == true)
WasPostponed() Named filter VAT postponed and reposted (ORIGINALPERIOD != PERIOD)
ContainingVATCode String Code that determines VAT rules used for VAT calculations.
CountryCode String Country code of VAT Entity.
Currency String Three character code following the ISO 4217 standard.
Date Date Date of VAT posting. Currency rate calculation use this date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
IsPostponed Boolean Indicates if a VAT posting is postponed.
LatestReportBy Integer Employee identifier. Available macros: currentUser()
LatestReportedDate Date Date of latest VAT reporting. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
OriginalVATPeriod Integer Original accounting period of VAT posting before VAT is postponed. Available macros: currentPeriod(), previousPeriod()
Status Integer Status of VAT posting.
TransactionItemId Integer Item-number of the object.
TransactionObjectId Integer Identifier of the object.
TransactionObjectType String Type of object.
VATPeriod Integer Accounting period this VAT posting belongs to. Available macros: currentPeriod(), previousPeriod()
VATPostingId Integer VAT Posting identifier.
VATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

Read more about filters and sorting on how to use sortable parameters

ContainingVATCode String Code that determines VAT rules used for VAT calculations.
CountryCode String Country code of VAT Entity
Currency String Three character code following the ISO 4217 standard
Date Date Date of VAT posting. Currency rate calculation use this date.
IsPostponed Boolean Indicates if a VAT posting is postponed
LatestReportBy Integer Employee identifier
LatestReportedDate Date Date of latest VAT reporting
OriginalVATPeriod Integer Original accounting period of VAT posting before VAT is postponed
Status Integer Status of VAT posting
TransactionItemId Integer Item-number of the object
TransactionObjectId Integer Identifier of the object
TransactionObjectType String Type of object
VATPeriod Integer Accounting period this VAT posting belongs to
VATPostingId Integer VAT Posting identifier
VATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

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.

Format:
1
<VATPostings>
2
     <VATPosting>
3
          <VATPostingId
VATPostingId

VAT Posting identifier

>{Integer}</VATPostingId>
4
          <Status
Status

Status of VAT posting

>{Integer}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
          <Date
Date

Date of VAT posting. Currency rate calculation use this date.

>{Date}</Date>
7
          <VATPeriod
VATPeriod

Accounting period this VAT posting belongs to

>{Integer}</VATPeriod>
8
          <OriginalVATPeriod
OriginalVATPeriod

Original accounting period of VAT posting before VAT is postponed

>{Integer}</OriginalVATPeriod>
9
          <IsPostponed
IsPostponed

Indicates if a VAT posting is postponed

>{Boolean}</IsPostponed>
10
          <TotalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=VATPosting.TotalsConverted in your request URI to get this field

>
11
               <Currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=VATPosting.TotalsConverted in your request URI to get this field

>{String}</Currency>
12
               <NetAmount
NetAmount

Total net amount for all VAT codes

This field is greyed out because it is an expandable field. You have to add $expand=VATPosting.TotalsConverted in your request URI to get this field

>{Decimal}</NetAmount>
13
               <VATAmount
VATAmount

Total VAT amount for all VAT codes

This field is greyed out because it is an expandable field. You have to add $expand=VATPosting.TotalsConverted in your request URI to get this field

>{Decimal}</VATAmount>
14
               <VATRoundOffAmount
VATRoundOffAmount

Total round off amount for all VAT codes

This field is greyed out because it is an expandable field. You have to add $expand=VATPosting.TotalsConverted in your request URI to get this field

>{Decimal}</VATRoundOffAmount>
15
          </TotalsConverted>
16
          <VATEntity>
17
               <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

>{String}</VATRegistrationNumber>
18
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
19
               <CountryCode
CountryCode

Country code of VAT Entity

>{String}</CountryCode>
20
          </VATEntity>
21
          <Transaction>
22
               <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
23
               <ItemType
ItemType

Type of item

>{String}</ItemType>
24
               <Object>
25
                    <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
26
                    <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
27
                    <Accounting>
28
                         <AccountingPeriod
AccountingPeriod

The accounting period the object belongs to

>{Integer}</AccountingPeriod>
29
                    </Accounting>
30
                    <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
31
               </Object>
32
               <TransactionEntity>
33
                    <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
34
                    <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
35
                    <Name
Name

Name of the customer/supplier, or last name if it is a person.

>{String}</Name>
36
                    <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

>{String}</VATRegistrationNumber>
37
                    <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
38
               </TransactionEntity>
39
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
40
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
41
          </Transaction>
42
          <LatestReport>
43
               <ReportedDate
ReportedDate

Date of latest VAT reporting

>{Date}</ReportedDate>
44
               <ReportedBy
ReportedBy

Employee who stated that latest reporting was completed

>
45
                    <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
46
                    <FirstName
FirstName

First name of employee

>{String}</FirstName>
47
                    <LastName
LastName

Last name of employee

>{String}</LastName>
48
                    <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
49
               </ReportedBy>
50
          </LatestReport>
51
          <VATPostingLink
VATPostingLink

VAT Posting reference

>{String}</VATPostingLink>
52
     </VATPosting>
53
     <Paging
Paging

Detailed paging information for this list.

>
54
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
55
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
56
          <Page
Page

Page index

>{Integer}</Page>
57
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
58
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
59
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
60
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
61
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
62
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
63
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
64
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
65
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
66
     </Paging>
67
</VATPostings>
1
{
2
     "vATPostings": [
3
          {
4
               "vATPostingId
VATPostingId

VAT Posting identifier

": "{Integer}",
5
               "status
Status

Status of VAT posting

": "{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
               "date
Date

Date of VAT posting. Currency rate calculation use this date.

": "{Date}",
8
               "vATPeriod
VATPeriod

Accounting period this VAT posting belongs to

": "{Integer}",
9
               "originalVATPeriod
OriginalVATPeriod

Original accounting period of VAT posting before VAT is postponed

": "{Integer}",
10
               "isPostponed
IsPostponed

Indicates if a VAT posting is postponed

": "{Boolean}",
11
               "totalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=VATPosting.TotalsConverted in your request URI to get this field

": {
12
                    "currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=VATPosting.TotalsConverted in your request URI to get this field

": "{String}",
13
                    "netAmount
NetAmount

Total net amount for all VAT codes

This field is greyed out because it is an expandable field. You have to add $expand=VATPosting.TotalsConverted in your request URI to get this field

": "{Decimal}",
14
                    "vATAmount
VATAmount

Total VAT amount for all VAT codes

This field is greyed out because it is an expandable field. You have to add $expand=VATPosting.TotalsConverted in your request URI to get this field

": "{Decimal}",
15
                    "vATRoundOffAmount
VATRoundOffAmount

Total round off amount for all VAT codes

This field is greyed out because it is an expandable field. You have to add $expand=VATPosting.TotalsConverted in your request URI to get this field

": "{Decimal}"
16
               },
17
               "vATEntity": {
18
                    "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

": "{String}",
19
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
20
                    "countryCode
CountryCode

Country code of VAT Entity

": "{String}"
21
               },
22
               "transaction": {
23
                    "itemId
ItemId

Item-number of the object

": "{Integer}",
24
                    "itemType
ItemType

Type of item

": "{String}",
25
                    "object": {
26
                         "objectId
ObjectId

Identifier of the object

": "{Integer}",
27
                         "objectType
ObjectType

Type of object

": "{String}",
28
                         "accounting": {
29
                              "accountingPeriod
AccountingPeriod

The accounting period the object belongs to

": "{Integer}"
30
                         },
31
                         "objectLink
ObjectLink

API reference to the object

": "{String}"
32
                    },
33
                    "transactionEntity": {
34
                         "objectId
ObjectId

Identifier of the object

": "{Integer}",
35
                         "objectType
ObjectType

Type of object

": "{String}",
36
                         "name
Name

Name of the customer/supplier, or last name if it is a person.

": "{String}",
37
                         "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

": "{String}",
38
                         "objectLink
ObjectLink

API reference to the object

": "{String}"
39
                    },
40
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
41
                    "itemLink
ItemLink

API reference to the item

": "{String}"
42
               },
43
               "latestReport": {
44
                    "reportedDate
ReportedDate

Date of latest VAT reporting

": "{Date}",
45
                    "reportedBy
ReportedBy

Employee who stated that latest reporting was completed

": {
46
                         "employeeId
EmployeeId

Employee identifier

": "{Integer}",
47
                         "firstName
FirstName

First name of employee

": "{String}",
48
                         "lastName
LastName

Last name of employee

": "{String}",
49
                         "employeeLink
EmployeeLink

Employee reference

": "{String}"
50
                    }
51
               },
52
               "vATPostingLink
VATPostingLink

VAT Posting reference

": "{String}"
53
          }
54
     ],
55
     "paging
Paging

Detailed paging information for this list.

": {
56
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
57
          "position
Position

Position of the first element in the list

": "{Integer}",
58
          "page
Page

Page index

": "{Integer}",
59
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
60
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
61
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
62
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
63
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
64
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
65
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
66
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
67
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
68
     }
69
}

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 100050 HTTP 403 No admittance as customer {0}
Error 100053 HTTP 403 You have only admittance to your own suppliers