API

Finance APIs

GET finance/general-ledger-accounting-lines

List of all accounting liness

HTTP method GET
URI https://api.rambase.net/finance/general-ledger-accounting-lines
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 4130, version 5

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
$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.

AccountingLineId Integer Accounting line identifier of the general ledger posting.
AccountingPeriod Integer Accounting period.
AssetId Integer Asset identifier.
Category String Category of general ledger posting.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
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.
GeneralLedgerAccountType String Type of account.
GeneralLedgerPostingId Integer General ledger posting identifier.
Type String Type of general ledger posting.
UpdatedAt Datetime Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
VATCode String Code that determines VAT rules used for VAT calculations.

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

AccountingLineId Integer Accounting line identifier of the general ledger posting
AccountingPeriod Integer Accounting period
AssetId Integer Asset identifier
Category String Category of general ledger posting
CreatedAt Datetime Date and time of creation
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
GeneralLedgerAccountType String Type of account
GeneralLedgerPostingId Integer General ledger posting identifier
Type String Type of general ledger posting
UpdatedAt Datetime Date and time of update
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
<AccountingLines>
2
     <AccountingLine>
3
          <AccountingLineId
AccountingLineId

Accounting line identifier of the general ledger posting

>{Integer}</AccountingLineId>
4
          <AccountDimensions>
5
               <GeneralLedgerAccount>
6
                    <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
7
                    <AccountNumber
AccountNumber

The account number of the general ledger account

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

Name of general ledger account

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

Type of account

Possible domain values can be found here

>{String}</Type>
10
                    <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
11
               </GeneralLedgerAccount>
12
               <Dimensions>
13
                    <Dimension>
14
                         <Value
Value

Value for this dimension defintion.

>{String}</Value>
15
                         <Description
Description

Description of the dimension value.

>{String}</Description>
16
                         <DimensionDefinition>
17
                              <DimensionDefinitionId
DimensionDefinitionId

Dimension identifier

>{Integer}</DimensionDefinitionId>
18
                              <Name
Name

Name of dimension

>{String}</Name>
19
                              <DimensionDefinitionLink
DimensionDefinitionLink

Dimension reference

>{String}</DimensionDefinitionLink>
20
                         </DimensionDefinition>
21
                    </Dimension>
22
               </Dimensions>
23
          </AccountDimensions>
24
          <VATCodeDefinition>
25
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>{String}</VATCode>
26
               <VATPercent
VATPercent

Value added tax percent

>{Decimal}</VATPercent>
27
               <Description
Description

Description of VAT Code definition

>{String}</Description>
28
          </VATCodeDefinition>
29
          <Totals>
30
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
31
               <Amount
Amount

Total amount.

>{Decimal}</Amount>
32
               <DebitAmount
DebitAmount

Total debit amount.

>{Decimal}</DebitAmount>
33
               <CreditAmount
CreditAmount

Total credit amount.

>{Decimal}</CreditAmount>
34
          </Totals>
35
          <TotalsConverted
TotalsConverted

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

>
36
               <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=AccountingLine.TotalsConverted in your request URI to get this field

>{String}</Currency>
37
               <ExchangeRate
ExchangeRate

The exchange rate used in convertion

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

>{Decimal}</ExchangeRate>
38
               <Amount
Amount

Total amount in company currency.

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

>{Decimal}</Amount>
39
               <DebitAmount
DebitAmount

Total debit amount in company currency.

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

>{Decimal}</DebitAmount>
40
               <CreditAmount
CreditAmount

Total credit amount in company currency.

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

>{Decimal}</CreditAmount>
41
          </TotalsConverted>
42
          <GeneralLedgerPosting>
43
               <Status
Status

Status of general ledger posting

Possible domain values can be found here

>{Integer}</Status>
44
               <GeneralLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

>{Integer}</GeneralLedgerPostingId>
45
               <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
46
               <Category
Category

Category of general ledger posting

Possible domain values can be found here

>{String}</Category>
47
               <Type
Type

Type of general ledger posting

Possible domain values can be found here

>{String}</Type>
48
               <TransactionDate
TransactionDate

Transaction date of general ledger posting

>{Date}</TransactionDate>
49
               <AccountingPeriod>
50
                    <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
51
                    <Period
Period

Accounting period

>{Integer}</Period>
52
                    <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
53
               </AccountingPeriod>
54
               <GeneralLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

>{String}</GeneralLedgerPostingLink>
55
          </GeneralLedgerPosting>
56
          <AccountingLineLink
AccountingLineLink

Accounting line reference

>{String}</AccountingLineLink>
57
     </AccountingLine>
58
     <Paging
Paging

Detailed paging information for this list.

>
59
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
62
          <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>
63
          <FirstPage
FirstPage

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

>{String}</FirstPage>
64
          <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>
65
          <PreviousPage
PreviousPage

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

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

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

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

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

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

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

>{Integer}</Size>
71
     </Paging>
72
</AccountingLines>
1
{
2
     "accountingLines": [
3
          {
4
               "accountingLineId
AccountingLineId

Accounting line identifier of the general ledger posting

": "{Integer}",
5
               "accountDimensions": {
6
                    "generalLedgerAccount": {
7
                         "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
8
                         "accountNumber
AccountNumber

The account number of the general ledger account

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

Name of general ledger account

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

Type of account

Possible domain values can be found here

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

General ledger account reference

": "{String}"
12
                    },
13
                    "dimensions": [
14
                         {
15
                              "value
Value

Value for this dimension defintion.

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

Description of the dimension value.

": "{String}",
17
                              "dimensionDefinition": {
18
                                   "dimensionDefinitionId
DimensionDefinitionId

Dimension identifier

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

Name of dimension

": "{String}",
20
                                   "dimensionDefinitionLink
DimensionDefinitionLink

Dimension reference

": "{String}"
21
                              }
22
                         }
23
                    ]
24
               },
25
               "vATCodeDefinition": {
26
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

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

Value added tax percent

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

Description of VAT Code definition

": "{String}"
29
               },
30
               "totals": {
31
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Total amount.

": "{Decimal}",
33
                    "debitAmount
DebitAmount

Total debit amount.

": "{Decimal}",
34
                    "creditAmount
CreditAmount

Total credit amount.

": "{Decimal}"
35
               },
36
               "totalsConverted
TotalsConverted

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

": {
37
                    "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=AccountingLine.TotalsConverted in your request URI to get this field

": "{String}",
38
                    "exchangeRate
ExchangeRate

The exchange rate used in convertion

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

": "{Decimal}",
39
                    "amount
Amount

Total amount in company currency.

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

": "{Decimal}",
40
                    "debitAmount
DebitAmount

Total debit amount in company currency.

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

": "{Decimal}",
41
                    "creditAmount
CreditAmount

Total credit amount in company currency.

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

": "{Decimal}"
42
               },
43
               "generalLedgerPosting": {
44
                    "status
Status

Status of general ledger posting

Possible domain values can be found here

": "{Integer}",
45
                    "generalLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

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

Date and time of creation

": "{Datetime}",
47
                    "category
Category

Category of general ledger posting

Possible domain values can be found here

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

Type of general ledger posting

Possible domain values can be found here

": "{String}",
49
                    "transactionDate
TransactionDate

Transaction date of general ledger posting

": "{Date}",
50
                    "accountingPeriod": {
51
                         "accountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

": "{Integer}",
53
                         "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
54
                    },
55
                    "generalLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

": "{String}"
56
               },
57
               "accountingLineLink
AccountingLineLink

Accounting line reference

": "{String}"
58
          }
59
     ],
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}",
62
          "position
Position

Position of the first element in the list

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

Page index

": "{Integer}",
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}",
65
          "firstPage
FirstPage

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

": "{String}",
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}",
67
          "previousPage
PreviousPage

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

": "{String}",
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}",
69
          "nextPage
NextPage

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

": "{String}",
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}",
71
          "lastPage
LastPage

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

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

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

": "{Integer}"
73
     }
74
}

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