Finance APIs

GET finance/general-ledger/{generalLedgerPostingId}

General ledger posting details for provided identifier

HTTP method	GET
URI	https://api.rambase.net/finance/general-ledger/{generalLedgerPostingId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {generalLedgerPostingId}	General ledger posting identifier Integer, minimum 100000
Custom fields	Custom fields supported
Successful HTTP status code	200
API resource identifier	506, version 27

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:

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.
$showCustomFields Boolean, optional	Set to "true" to include custom fields. Default value is false.

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:

                                        <GeneralLedgerPosting>
                                    

<GeneralLedgerPostingId

GeneralLedgerPostingId

General ledger posting identifier

>{Integer}</GeneralLedgerPostingId>

<Status

Status

Status of general ledger posting

Possible domain values can be found here

>{String}</Status>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<RegisteredAt

RegisteredAt

Date and time of registration

>{Datetime}</RegisteredAt>

<Category

Type

Type of general ledger posting

Possible domain values can be found here

>{String}</Type>

<TransactionDate

TransactionDate

Transaction date of general ledger posting

>{Date}</TransactionDate>

<LastUpdateDate

LastUpdateDate

Last update date of general ledger posting

>{Date}</LastUpdateDate>

<Note

Note

Remark of the general ledger posting

>{String}</Note>

<CountOfJournalEntries

CountOfJournalEntries

Count of journal entries which are linked to general ledger posting

>{Integer}</CountOfJournalEntries>

<Balance

Balance

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

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

>{String}</Currency>

<Amount

Amount

Total balance for general ledger posting.

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

>{Decimal}</Amount>

                                             </Balance>
                                    

                                             <VATPosting>
                                    

<VATPostingId

VATPostingId

VAT Posting identifier

>{Integer}</VATPostingId>

<VATPostingLink

VATPostingLink

VAT Posting reference

>{String}</VATPostingLink>

                                             </VATPosting>
                                    

                                             <Source>
                                    

<ObjectId

ObjectId

Identifier of the object

>{Integer}</ObjectId>

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<ObjectLink

ObjectLink

API reference to the object

>{String}</ObjectLink>

<ItemId

ItemId

Identifier of the object

>{Integer}</ItemId>

<ItemType

ItemType

Type of item

>{String}</ItemType>

<ItemLink

ItemLink

API reference to the item

>{String}</ItemLink>

<RamBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>

                                             </Source>
                                    

                                             <CreatedBy>
                                    

<UserId

UserId

User identifier

>{Integer}</UserId>

<Name

Name

Name of the user

>{String}</Name>

<FirstName

FirstName

First name of the user

>{String}</FirstName>

<UserLink

UserLink

User reference

>{String}</UserLink>

                                             </CreatedBy>
                                    

                                             <RegisteredBy>
                                    

<UserId

UserId

User identifier

>{Integer}</UserId>

<Name

Name

Name of the user

>{String}</Name>

<FirstName

FirstName

First name of the user

>{String}</FirstName>

<UserLink

UserLink

User reference

>{String}</UserLink>

                                             </RegisteredBy>
                                    

                                             <AccountingPeriod>
                                    

<AccountingPeriodId

AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>

<Period

Period

Accounting period

>{Integer}</Period>

<AccountingPeriodLink

AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>

                                             </AccountingPeriod>
                                    

<Error

Error

Error message of the general ledger posting

<Message

Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

>{String}</Message>

<TranslatedMessage

TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

>{String}</TranslatedMessage>

                                                  <ErrorMessage>
                                    

<ErrorMessageId

ErrorMessageId

Error message identifier

>{Integer}</ErrorMessageId>

<ErrorMessageLink

ErrorMessageLink

Error message reference

>{String}</ErrorMessageLink>

                                                  </ErrorMessage>
                                    

                                                  <Parameters>
                                    

                                                       <Parameter>
                                    

<Index

Index

Error Key

>{Integer}</Index>

<Value

Value

Value of the error parameter

>{String}</Value>

                                                       </Parameter>
                                    

                                                  </Parameters>
                                    

                                             </Error>
                                    

                                        </GeneralLedgerPosting>
                                    

{

                                             "generalLedgerPosting": {
                                    

"generalLedgerPostingId

GeneralLedgerPostingId

General ledger posting identifier

": "{Integer}",

"status

Status

Status of general ledger posting

Possible domain values can be found here

": "{String}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"registeredAt

RegisteredAt

Date and time of registration

": "{Datetime}",

"category

Type

Type of general ledger posting

Possible domain values can be found here

": "{String}",

"transactionDate

TransactionDate

Transaction date of general ledger posting

": "{Date}",

"lastUpdateDate

LastUpdateDate

Last update date of general ledger posting

": "{Date}",

"note

Note

Remark of the general ledger posting

": "{String}",

"countOfJournalEntries

CountOfJournalEntries

Count of journal entries which are linked to general ledger posting

": "{Integer}",

"balance

Balance

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

": {

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

": "{String}",

"amount

Amount

Total balance for general ledger posting.

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

": "{Decimal}"

},

                                                  "vATPosting": {
                                    

"vATPostingId

VATPostingId

VAT Posting identifier

": "{Integer}",

"vATPostingLink

VATPostingLink

VAT Posting reference

": "{String}"

},

                                                  "source": {
                                    

"objectId

ObjectId

Identifier of the object

": "{Integer}",

"objectType

ObjectType

Type of object

": "{String}",

"objectLink

ObjectLink

API reference to the object

": "{String}",

"itemId

ItemId

Identifier of the object

": "{Integer}",

"itemType

ItemType

Type of item

": "{String}",

"itemLink

ItemLink

API reference to the item

": "{String}",

"ramBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"

},

                                                  "createdBy": {
                                    

"userId

UserId

User identifier

": "{Integer}",

"name

Name

Name of the user

": "{String}",

"firstName

FirstName

First name of the user

": "{String}",

"userLink

UserLink

User reference

": "{String}"

},

                                                  "registeredBy": {
                                    

"userId

UserId

User identifier

": "{Integer}",

"name

Name

Name of the user

": "{String}",

"firstName

FirstName

First name of the user

": "{String}",

"userLink

UserLink

User reference

": "{String}"

},

                                                  "accountingPeriod": {
                                    

"accountingPeriodId

AccountingPeriodId

Accounting period identifier

": "{Integer}",

"period

Period

Accounting period

": "{Integer}",

"accountingPeriodLink

AccountingPeriodLink

Accounting period reference

": "{String}"

},

"error

Error

Error message of the general ledger posting

": {

"message

Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

": "{String}",

"translatedMessage

TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

": "{String}",

                                                       "errorMessage": {
                                    

"errorMessageId

ErrorMessageId

Error message identifier

": "{Integer}",

"errorMessageLink

ErrorMessageLink

Error message reference

": "{String}"

},

                                                       "parameters": {
                                    

                                                            "parameter": {
                                    

"index

Index

Error Key

": "{Integer}",

"value

Value

Value of the error parameter

": "{String}"

}

}

}

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

POST

AOP/100776

POST

Discard general ledger posting

AOP/100789

POST

Reopen general ledger posting

AOP/100790

POST

Reload general ledger posting

AOP/100792

POST

Create VAT posting from general ledger posting

AOP/100793

POST

Reverse general ledger posting

AOP/101468

POST

Change period on general ledger posting

AOP/101474

POST

Delete all general ledger posting items

AOP/101487

POST

Delete all items and discard general ledger posting

AOP/101489

POST

Reopen general ledger posting also including journal entries

AOP/101490

POST

Copy general ledger posting to new posting

Delete VAT posting from general ledger posting

AOP/101751

Possible error codes the response might return:

Error 100619 HTTP 404

Error message not found