API

Finance APIs

GET finance/periods/{periodId}

Accounting period details for provided identifier

HTTP method GET
URI https://api.rambase.net/finance/periods/{periodId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {periodId} Accounting period identifier
Integer, minimum 100000, maximum 299999
Successful HTTP status code 200
API resource identifier 514, 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.

$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
<AccountingPeriod>
2
     <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Status of accounting period

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Period
Period

Accounting period

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

Name of accounting period

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

Type of accounting period

Possible domain values can be found here

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

Description of accounting period

>{String}</Description>
9
     <AgioStatus
AgioStatus

Agio status of accounting period

Possible domain values can be found here

>{Integer}</AgioStatus>
10
     <IsReconciled
IsReconciled

Indicates if all general ledger postings are registered and reconciled to transation documents.

>{Boolean}</IsReconciled>
11
     <VATPeriod
VATPeriod

Accounting period this VAT posting belongs to

>{Integer}</VATPeriod>
12
     <StartDate
StartDate

Start date of accounting period

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

End date of accounting period

>{Date}</EndDate>
14
     <ClosedDate
ClosedDate

Closed date of accounting period

>{Date}</ClosedDate>
15
     <CreatedBy>
16
          <UserId
UserId

User identifier

>{Integer}</UserId>
17
          <Name
Name

Name of the user

>{String}</Name>
18
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
19
          <UserLink
UserLink

User reference

>{String}</UserLink>
20
     </CreatedBy>
21
     <ClosedBy>
22
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
23
          <LastName
LastName

Last name of employee

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

First name of employee

>{String}</FirstName>
25
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
26
     </ClosedBy>
27
     <Balances
Balances

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

>
28
          <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=Balances in your request URI to get this field

>{String}</Currency>
29
          <CustomerAmount
CustomerAmount

Customer balance amount

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

>{Decimal}</CustomerAmount>
30
          <SupplierAmount
SupplierAmount

Supplier balance amount

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

>{Decimal}</SupplierAmount>
31
          <Stock
Stock

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

>
32
               <Amount
Amount

Inventory balance amount

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

>{Decimal}</Amount>
33
               <ImportDate
ImportDate

Inventory balance imported date

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

>{Date}</ImportDate>
34
          </Stock>
35
          <WorkInProgress
WorkInProgress

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

>
36
               <Amount
Amount

Work in progress balance amount

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

>{Decimal}</Amount>
37
               <ImportDate
ImportDate

Work in progress balance imported date

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

>{Date}</ImportDate>
38
          </WorkInProgress>
39
          <StockAccrual
StockAccrual

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

>
40
               <Amount
Amount

Product balance amount

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

>{Decimal}</Amount>
41
               <ImportDate
ImportDate

Product balance imported date

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

>{Date}</ImportDate>
42
          </StockAccrual>
43
     </Balances>
44
     <FixedAssetsDepreciation
FixedAssetsDepreciation

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

>
45
          <Status
Status

Depreciation status

Possible domain values can be found here

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

>{String}</Status>
46
          <Amount
Amount

Depreciation amount

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

>{Decimal}</Amount>
47
     </FixedAssetsDepreciation>
48
</AccountingPeriod>
1
{
2
     "accountingPeriod": {
3
          "accountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Status of accounting period

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
6
          "period
Period

Accounting period

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

Name of accounting period

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

Type of accounting period

Possible domain values can be found here

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

Description of accounting period

": "{String}",
10
          "agioStatus
AgioStatus

Agio status of accounting period

Possible domain values can be found here

": "{Integer}",
11
          "isReconciled
IsReconciled

Indicates if all general ledger postings are registered and reconciled to transation documents.

": "{Boolean}",
12
          "vATPeriod
VATPeriod

Accounting period this VAT posting belongs to

": "{Integer}",
13
          "startDate
StartDate

Start date of accounting period

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

End date of accounting period

": "{Date}",
15
          "closedDate
ClosedDate

Closed date of accounting period

": "{Date}",
16
          "createdBy": {
17
               "userId
UserId

User identifier

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

Name of the user

": "{String}",
19
               "firstName
FirstName

First name of the user

": "{String}",
20
               "userLink
UserLink

User reference

": "{String}"
21
          },
22
          "closedBy": {
23
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
24
               "lastName
LastName

Last name of employee

": "{String}",
25
               "firstName
FirstName

First name of employee

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

Employee reference

": "{String}"
27
          },
28
          "balances
Balances

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

": {
29
               "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=Balances in your request URI to get this field

": "{String}",
30
               "customerAmount
CustomerAmount

Customer balance amount

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

": "{Decimal}",
31
               "supplierAmount
SupplierAmount

Supplier balance amount

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

": "{Decimal}",
32
               "stock
Stock

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

": {
33
                    "amount
Amount

Inventory balance amount

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

": "{Decimal}",
34
                    "importDate
ImportDate

Inventory balance imported date

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

": "{Date}"
35
               },
36
               "workInProgress
WorkInProgress

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

": {
37
                    "amount
Amount

Work in progress balance amount

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

": "{Decimal}",
38
                    "importDate
ImportDate

Work in progress balance imported date

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

": "{Date}"
39
               },
40
               "stockAccrual
StockAccrual

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

": {
41
                    "amount
Amount

Product balance amount

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

": "{Decimal}",
42
                    "importDate
ImportDate

Product balance imported date

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

": "{Date}"
43
               }
44
          },
45
          "fixedAssetsDepreciation
FixedAssetsDepreciation

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

": {
46
               "status
Status

Depreciation status

Possible domain values can be found here

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

": "{String}",
47
               "amount
Amount

Depreciation amount

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

": "{Decimal}"
48
          }
49
     }
50
}

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