API

Finance APIs

GET finance/period-years/{year}

Accounting year

HTTP method GET
URI https://api.rambase.net/finance/period-years/{year}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {year} Year of accounting period
Integer
Successful HTTP status code 200
API resource identifier 4264, version 9

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.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$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.
$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.

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.

Format:
1
<AccountingPeriodYear>
2
     <Year
Year

Year of accounting period

>{Integer}</Year>
3
     <IsClosed
IsClosed

Indicates that all accounting periods for this year are closed.

>{Boolean}</IsClosed>
4
     <StartDate
StartDate

Start date of accounting period

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

>{Date}</StartDate>
5
     <EndDate
EndDate

End date of accounting period

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

>{Date}</EndDate>
6
     <AccountingPeriods
AccountingPeriods

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

>
7
          <AccountingPeriod
AccountingPeriod

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

>
8
               <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

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

>{Integer}</AccountingPeriodId>
9
               <Status
Status

Status of accounting period

Possible domain values can be found here

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

>{Integer}</Status>
10
               <Period
Period

Accounting period

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

>{Integer}</Period>
11
               <Name
Name

Name of accounting period

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

>{String}</Name>
12
               <Type
Type

Type of accounting period

Possible domain values can be found here

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

>{String}</Type>
13
               <Description
Description

Description of accounting period

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

>{String}</Description>
14
               <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

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

>{String}</AccountingPeriodLink>
15
          </AccountingPeriod>
16
     </AccountingPeriods>
17
</AccountingPeriodYear>
1
{
2
     "accountingPeriodYear": {
3
          "year
Year

Year of accounting period

": "{Integer}",
4
          "isClosed
IsClosed

Indicates that all accounting periods for this year are closed.

": "{Boolean}",
5
          "startDate
StartDate

Start date of accounting period

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

": "{Date}",
6
          "endDate
EndDate

End date of accounting period

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

": "{Date}",
7
          "accountingPeriods
AccountingPeriods

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

": [
8
               {
9
                    "accountingPeriodId
AccountingPeriodId

Accounting period identifier

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

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

Status of accounting period

Possible domain values can be found here

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

": "{Integer}",
11
                    "period
Period

Accounting period

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

": "{Integer}",
12
                    "name
Name

Name of accounting period

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

": "{String}",
13
                    "type
Type

Type of accounting period

Possible domain values can be found here

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

": "{String}",
14
                    "description
Description

Description of accounting period

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

": "{String}",
15
                    "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

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

": "{String}"
16
               }
17
          ]
18
     }
19
}

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 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found