API

Finance APIs

GET system/reports/103160/result-set?fromPeriod={fromPeriod}&toPeriod={toPeriod}&periodView={periodView}&generalLedgerAccountNumber={accountNumber}

General ledger account balances and movements, detailed

Report name General ledger account balances and movements, detailed
Report identifier 103160
HTTP method GET
URI https://api.rambase.net/system/reports/103160/result-set?fromPeriod={fromPeriod}&toPeriod={toPeriod}&periodView={periodView}&generalLedgerAccountNumber={accountNumber}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 4453, version 17

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.

fromPeriod Integer, optional Report will list records from this period. Format: YYYYMM.

Minimum: 190000,
Maximum: 299999
toPeriod Integer, optional Report will list records to this period. Format: YYYYMM.

Minimum: 190000,
Maximum: 299999
periodView String, optional Quick filter on from and to period. This parameter overrides from and to period if they are specified.
generalLedgerAccountNumber String, optional The account number of the general ledger account
$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.

AccountingPeriod Integer Accounting period.
AssetId Integer Asset identifier.
Currency String Three character code following the ISO 4217 standard.
DepartmentId Integer Department identifier.
FinanceProjectId Integer Finance project identifier.
GeneralLedgerAccountId Integer General ledger account identifier.
GeneralLedgerAccountNumber String The account number of the general ledger account.
IntercompanyCode String Abbreviation/code to identify the company.
VATCode String Code that determines VAT rules used for VAT calculations.

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

AccountingPeriod Integer Accounting period
AssetId Integer Asset identifier
Currency String Three character code following the ISO 4217 standard
DepartmentId Integer Department identifier
FinanceProjectId Integer Finance project identifier
GeneralLedgerAccountId Integer General ledger account identifier
GeneralLedgerAccountNumber String The account number of the general ledger account
IntercompanyCode String Abbreviation/code to identify the company
VATCode String Code that determines VAT rules used for VAT calculations.

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
<Report>
2
     <Rows>
3
          <Row>
4
               <GLAccount
GLAccount

General ledger account reference

>
5
                    <AccountNumber
AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>
6
                    <Name
Name

Name of general ledger account

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

General ledger account reference

>{String}</GeneralLedgerAccountLink>
8
               </GLAccount>
9
               <Source
Source

Invoice, credit reference or payment item reference

>
10
                    <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
12
                    <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
13
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
14
                    <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
15
                    <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
16
               </Source>
17
               <GLPostingItem
GLPostingItem

Accounting line reference

>
18
                    <GeneralLedgerPostingItemId
GeneralLedgerPostingItemId

Accounting line identifier of the general ledger posting

>{Integer}</GeneralLedgerPostingItemId>
19
                    <GeneralLedgerPosting
GeneralLedgerPosting

General ledger posting reference

>
20
                         <GeneralLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

>{Integer}</GeneralLedgerPostingId>
21
                         <GeneralLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

>{String}</GeneralLedgerPostingLink>
22
                    </GeneralLedgerPosting>
23
                    <GeneralLedgerPostingItemLink
GeneralLedgerPostingItemLink

Accounting line reference

>{String}</GeneralLedgerPostingItemLink>
24
               </GLPostingItem>
25
               <Period
Period

Accounting period

>{String}</Period>
26
               <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
27
               <Description
Description

Descriptive text of record

>{String}</Description>
28
               <Intercompany
Intercompany

Intercompany reference

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

>
29
                    <Code
Code

Abbreviation/code to identify the company

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

>{String}</Code>
30
               </Intercompany>
31
               <VATCodeDefinition
VATCodeDefinition

VAT code reference

>
32
                    <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>{String}</VATCode>
33
                    <Description
Description

Description of VAT Code definition

>{String}</Description>
34
                    <VATPercent
VATPercent

Value added tax percent

>{Decimal}</VATPercent>
35
                    <VATCodeDefinitionLink
VATCodeDefinitionLink

VAT code reference

>{String}</VATCodeDefinitionLink>
36
               </VATCodeDefinition>
37
               <Department
Department

Department reference. One of the system/fixed account dimensions.

>
38
                    <DepartmentId
DepartmentId

Department identifier

>{Integer}</DepartmentId>
39
                    <Name
Name

Name of department

>{String}</Name>
40
                    <DepartmentLink
DepartmentLink

Finance department reference

>{String}</DepartmentLink>
41
               </Department>
42
               <Project
Project

Finance project reference. One of the system/fixed account dimensions.

>
43
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

>{Integer}</FinanceProjectId>
44
                    <Name
Name

Name of finance project

>{String}</Name>
45
                    <FinanceProjectLink
FinanceProjectLink

Finance project reference

>{String}</FinanceProjectLink>
46
               </Project>
47
               <Asset
Asset

Asset reference. One of the system/fixed account dimensions.

>
48
                    <AssetId
AssetId

Asset identifier

>{Integer}</AssetId>
49
                    <Name
Name

Name of asset

>{String}</Name>
50
                    <AssetLink
AssetLink

Asset reference

>{String}</AssetLink>
51
               </Asset>
52
               <ConvertedDebitAmount
ConvertedDebitAmount

Total debit amount in company currency.

>{Decimal}</ConvertedDebitAmount>
53
               <ConvertedCreditAmount
ConvertedCreditAmount

Total credit amount in company currency.

>{Decimal}</ConvertedCreditAmount>
54
               <ConvertedAmount
ConvertedAmount

Total amount in company currency.

>{Decimal}</ConvertedAmount>
55
               <Inspect>
56
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
57
               </Inspect>
58
          </Row>
59
     </Rows>
60
     <Paging
Paging

Detailed paging information for this list.

>
61
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
64
          <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>
65
          <FirstPage
FirstPage

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

>{String}</FirstPage>
66
          <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>
67
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
68
          <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>
69
          <NextPage
NextPage

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

>{String}</NextPage>
70
          <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>
71
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
73
     </Paging>
74
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "gLAccount
GLAccount

General ledger account reference

": {
6
                         "accountNumber
AccountNumber

The account number of the general ledger account

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

Name of general ledger account

": "{String}",
8
                         "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
9
                    },
10
                    "source
Source

Invoice, credit reference or payment item reference

": {
11
                         "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
13
                         "itemId
ItemId

Item-number of the object

": "{Integer}",
14
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the object

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

API reference to the item

": "{String}"
17
                    },
18
                    "gLPostingItem
GLPostingItem

Accounting line reference

": {
19
                         "generalLedgerPostingItemId
GeneralLedgerPostingItemId

Accounting line identifier of the general ledger posting

": "{Integer}",
20
                         "generalLedgerPosting
GeneralLedgerPosting

General ledger posting reference

": {
21
                              "generalLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

": "{Integer}",
22
                              "generalLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

": "{String}"
23
                         },
24
                         "generalLedgerPostingItemLink
GeneralLedgerPostingItemLink

Accounting line reference

": "{String}"
25
                    },
26
                    "period
Period

Accounting period

": "{String}",
27
                    "issueDate
IssueDate

Date when the document was issued.

": "{Date}",
28
                    "description
Description

Descriptive text of record

": "{String}",
29
                    "intercompany
Intercompany

Intercompany reference

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

": {
30
                         "code
Code

Abbreviation/code to identify the company

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

": "{String}"
31
                    },
32
                    "vATCodeDefinition
VATCodeDefinition

VAT code reference

": {
33
                         "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

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

Description of VAT Code definition

": "{String}",
35
                         "vATPercent
VATPercent

Value added tax percent

": "{Decimal}",
36
                         "vATCodeDefinitionLink
VATCodeDefinitionLink

VAT code reference

": "{String}"
37
                    },
38
                    "department
Department

Department reference. One of the system/fixed account dimensions.

": {
39
                         "departmentId
DepartmentId

Department identifier

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

Name of department

": "{String}",
41
                         "departmentLink
DepartmentLink

Finance department reference

": "{String}"
42
                    },
43
                    "project
Project

Finance project reference. One of the system/fixed account dimensions.

": {
44
                         "financeProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

": "{String}",
46
                         "financeProjectLink
FinanceProjectLink

Finance project reference

": "{String}"
47
                    },
48
                    "asset
Asset

Asset reference. One of the system/fixed account dimensions.

": {
49
                         "assetId
AssetId

Asset identifier

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

Name of asset

": "{String}",
51
                         "assetLink
AssetLink

Asset reference

": "{String}"
52
                    },
53
                    "convertedDebitAmount
ConvertedDebitAmount

Total debit amount in company currency.

": "{Decimal}",
54
                    "convertedCreditAmount
ConvertedCreditAmount

Total credit amount in company currency.

": "{Decimal}",
55
                    "convertedAmount
ConvertedAmount

Total amount in company currency.

": "{Decimal}",
56
                    "inspect": {
57
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
58
                    }
59
               }
60
          ]
61
     }
62
}

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 104920 HTTP 400 Log text is required
Error 104921 HTTP 400 Invalid log category
Error 101281 HTTP 400 Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type