Finance APIs
Resource for creating new general ledger posting
| HTTP method | POST |
| URI | https://api.rambase.net/finance/general-ledger |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 5288, version 3 |
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.
TransactionDate
Required/mandatory field
Transaction date of general ledger posting
>{Date}</TransactionDate>Period
Required/mandatory field
Accounting period
Minimum value: 190000
Maximum value: 290000
>{Integer}</Period>Category
Required/mandatory field
Category of general ledger posting
Applicable domain values can be found here
>{String}</Category>Note
Remark of the general ledger posting
This field is optional.
>{String}</Note>TransactionDate
Required/mandatory field
Transaction date of general ledger posting
": "{Date}",Period
Required/mandatory field
Accounting period
Minimum value: 190000
Maximum value: 290000
": "{Integer}"Category
Required/mandatory field
Category of general ledger posting
Applicable domain values can be found here
": "{String}",Note
Remark of the general ledger posting
This field is optional.
": "{String}"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.
| $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 |
| $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. |
| $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] |
| $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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
GeneralLedgerPostingId
General ledger posting identifier
>{Integer}</GeneralLedgerPostingId>Status
Status of general ledger posting
Possible domain values can be found here
>{String}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>RegisteredAt
Date and time of registration
>{Datetime}</RegisteredAt>Category
Category of general ledger posting
Possible domain values can be found here
>{String}</Category>TransactionDate
Transaction date of general ledger posting
>{Date}</TransactionDate>LastUpdateDate
Last update date of general ledger posting
>{Date}</LastUpdateDate>Note
Remark of the general ledger posting
>{String}</Note>CountOfJournalEntries
Count of journal entries which are linked to general ledger posting
>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Amount
Total balance for general ledger posting.
>{Decimal}</Amount>VATPostingId
VAT Posting identifier
>{Integer}</VATPostingId>VATPostingLink
VAT Posting reference
>{String}</VATPostingLink>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Identifier of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>AccountingPeriodId
Accounting period identifier
>{Integer}</AccountingPeriodId>Period
Accounting period
>{Integer}</Period>AccountingPeriodLink
Accounting period reference
>{String}</AccountingPeriodLink>Error
Error message of the general ledger posting
>Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
>{String}</Message>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>ErrorMessageId
Error message identifier
>{Integer}</ErrorMessageId>ErrorMessageLink
Error message reference
>{String}</ErrorMessageLink>Index
Error Key
>{Integer}</Index>Value
Value of the error parameter
>{String}</Value>GeneralLedgerPostingId
General ledger posting identifier
": "{Integer}",Status
Status of general ledger posting
Possible domain values can be found here
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",RegisteredAt
Date and time of registration
": "{Datetime}",Category
Category of general ledger posting
Possible domain values can be found here
": "{String}",Type
Type of general ledger posting
Possible domain values can be found here
": "{String}",TransactionDate
Transaction date of general ledger posting
": "{Date}",LastUpdateDate
Last update date of general ledger posting
": "{Date}",Note
Remark of the general ledger posting
": "{String}",CountOfJournalEntries
Count of journal entries which are linked to general ledger posting
": {Currency
Three character code following the ISO 4217 standard
": "{String}",Amount
Total balance for general ledger posting.
": "{Decimal}"VATPostingId
VAT Posting identifier
": "{Integer}",VATPostingLink
VAT Posting reference
": "{String}"ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Identifier of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"AccountingPeriodId
Accounting period identifier
": "{Integer}",Period
Accounting period
": "{Integer}",AccountingPeriodLink
Accounting period reference
": "{String}"Error
Error message of the general ledger posting
": {Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
": "{String}",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}",ErrorMessageId
Error message identifier
": "{Integer}",ErrorMessageLink
Error message reference
": "{String}"Index
Error Key
": "{Integer}",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.
Possible error codes the response might return:
| Error 101420 HTTP 404 | Setting definition not found |