API

Finance APIs

POST finance/general-ledger-accounts

Resource for creating new general ledger account

HTTP method POST
URI https://api.rambase.net/finance/general-ledger-accounts
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 3614, version 4

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
<GeneralLedgerAccount>
2
     <AccountNumber
AccountNumber

Required/mandatory field

The account number of the general ledger account

Maximum value: 50

Input must match the following regular expression pattern: [A-Za-z0-9-_\.]

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

Required/mandatory field

Name of general ledger account

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

Required/mandatory field

Type of account

Applicable domain values can be found here

>{String}</Type>
5
     <DefaultVATCodeDefinition>
6
          <VATCode
VATCode

Required/mandatory field

Code that determines VAT rules used for VAT calculations.

>{String}</VATCode>
7
     </DefaultVATCodeDefinition>
8
     <Validity>
9
          <EffectivePeriod
EffectivePeriod

Required/mandatory field

Period the account is effective/valid from

Minimum value: 199000

Maximum value: 299912

>{Integer}</EffectivePeriod>
10
     </Validity>
11
</GeneralLedgerAccount>
1
{
2
     "generalLedgerAccount": {
3
          "accountNumber
AccountNumber

Required/mandatory field

The account number of the general ledger account

Maximum value: 50

Input must match the following regular expression pattern: [A-Za-z0-9-_\.]

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

Required/mandatory field

Name of general ledger account

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

Required/mandatory field

Type of account

Applicable domain values can be found here

": "{String}",
6
          "defaultVATCodeDefinition": {
7
               "vATCode
VATCode

Required/mandatory field

Code that determines VAT rules used for VAT calculations.

": "{String}"
8
          },
9
          "validity": {
10
               "effectivePeriod
EffectivePeriod

Required/mandatory field

Period the account is effective/valid from

Minimum value: 199000

Maximum value: 299912

": "{Integer}"
11
          }
12
     }
13
}

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]

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.

Format:
1
<GeneralLedgerAccount>
2
     <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

Status of general ledger account

Possible domain values can be found here

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

Date and time of creation

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

Name of general ledger account

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

Type of account

Possible domain values can be found here

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

Category of account

Possible domain values can be found here

>{String}</Category>
8
     <PostingType
PostingType

Posting type of account. Only debit, only credit or both.

Possible domain values can be found here

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

Description of account

>{String}</Description>
10
     <AccountNumber
AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>
11
     <IsAgioCalculated
IsAgioCalculated

True if general ledger account is agio calculated

>{Boolean}</IsAgioCalculated>
12
     <TreeLevel
TreeLevel

Level in the general ledger account tree. 0 is the root.

>{Integer}</TreeLevel>
13
     <IsControlAccount
IsControlAccount

True if general ledger account is a control account

>
14
          <HasChildren
HasChildren

True if general ledger account has any child accounts

>{Boolean}</HasChildren>
15
          <NumberOfChildren
NumberOfChildren

Number of general ledger account children

>{Integer}</NumberOfChildren>
16
     </IsControlAccount>
17
     <VATPercent
VATPercent

Value added tax percent

>{Decimal}</VATPercent>
18
     <LocationRequirement
LocationRequirement

Specifies how the location should be used for the specific account.

Possible domain values can be found here

>{String}</LocationRequirement>
19
     <IntercompanyCodeRequirement
IntercompanyCodeRequirement

Specifies how the intercompany code should be used for the specific account.

Possible domain values can be found here

>{String}</IntercompanyCodeRequirement>
20
     <TransferToFixedAsset
TransferToFixedAsset

Specifies how investments should be transfered into the fixed assets register.

Possible domain values can be found here

>{String}</TransferToFixedAsset>
21
     <LastGeneralLedgerPostingPeriod
LastGeneralLedgerPostingPeriod

Last general ledger posting period of account

>{Integer}</LastGeneralLedgerPostingPeriod>
22
     <CreatedBy>
23
          <UserId
UserId

User identifier

>{Integer}</UserId>
24
          <UserLink
UserLink

User reference

>{String}</UserLink>
25
     </CreatedBy>
26
     <Validity>
27
          <EffectivePeriod
EffectivePeriod

Period the account is effective/valid from

>{Integer}</EffectivePeriod>
28
          <ExpirationPeriod
ExpirationPeriod

Period the account expires (is valid to)

>{Integer}</ExpirationPeriod>
29
     </Validity>
30
     <BudgetAccount>
31
          <BudgetAccountId
BudgetAccountId

Budget account identifier

>{Integer}</BudgetAccountId>
32
          <AccountNumber
AccountNumber

Code of budget

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

Name of budget

>{String}</Name>
34
          <BudgetAccountLink
BudgetAccountLink

Budget reference

>{String}</BudgetAccountLink>
35
     </BudgetAccount>
36
     <DefaultDepartment>
37
          <DepartmentId
DepartmentId

Department identifier

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

Name of department

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

Finance department reference

>{String}</DepartmentLink>
40
     </DefaultDepartment>
41
     <DefaultVATCodeDefinition>
42
          <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>{String}</VATCode>
43
     </DefaultVATCodeDefinition>
44
     <GeneralLedgerAccountGroup>
45
          <GeneralLedgerAccountGroupId
GeneralLedgerAccountGroupId

General ledger account group identifier

>{Integer}</GeneralLedgerAccountGroupId>
46
          <Code
Code

Code of general ledger account group

>{String}</Code>
47
          <Name
Name

Name of general ledger account group

>{String}</Name>
48
          <GeneralLedgerAccountGroupLink
GeneralLedgerAccountGroupLink

General ledger account group reference

>{String}</GeneralLedgerAccountGroupLink>
49
          <DimensionRequirement>
50
               <Requirement
Requirement

Specifies how the dimension should be used for the specific account.

Possible domain values can be found here

>{String}</Requirement>
51
               <DimensionDefinition>
52
                    <DimensionDefinitionId
DimensionDefinitionId

Dimension identifier

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

Name of dimension

>{String}</Name>
54
                    <Description
Description

Description of dimension

>{String}</Description>
55
                    <ValueSource
ValueSource

Where the value is selected from.

>
56
                         <Type
Type

Type of source

Possible domain values can be found here

>{String}</Type>
57
                         <ArchiveClass>
58
                              <Name
Name

Name of archive class

Possible domain values can be found here

>{String}</Name>
59
                         </ArchiveClass>
60
                         <Field>
61
                              <Name
Name

Name of field

Possible domain values can be found here

>{String}</Name>
62
                         </Field>
63
                    </ValueSource>
64
                    <DimensionDefinitionLink
DimensionDefinitionLink

Dimension reference

>{String}</DimensionDefinitionLink>
65
               </DimensionDefinition>
66
          </DimensionRequirement>
67
     </GeneralLedgerAccountGroup>
68
     <DepreciationRule>
69
          <DepreciationRuleId
DepreciationRuleId

Depreciation rule identifier

>{Integer}</DepreciationRuleId>
70
          <Name
Name

Name of depreciation rule

>{String}</Name>
71
          <DepreciationRuleLink
DepreciationRuleLink

Depreciation rule reference

>{String}</DepreciationRuleLink>
72
     </DepreciationRule>
73
     <ParentGeneralLedgerAccounts>
74
          <ParentGeneralLedgerAccount>
75
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
76
               <Name
Name

Name of general ledger account

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

The account number of the general ledger account

>{String}</AccountNumber>
78
               <TreeLevel
TreeLevel

Level in the general ledger account tree. 0 is the root.

>{Integer}</TreeLevel>
79
               <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
80
          </ParentGeneralLedgerAccount>
81
     </ParentGeneralLedgerAccounts>
82
     <BlockPostingsFor>
83
          <SalesInvoices
SalesInvoices

GL postings from Sales Invoices are blocked for this general ledger account

>{Boolean}</SalesInvoices>
84
          <SalesCreditNotes
SalesCreditNotes

GL postings from Sales Credit Notes are blocked for this general ledger account

>{Boolean}</SalesCreditNotes>
85
          <SalesPostingAdjustments
SalesPostingAdjustments

GL postings from Sales Posting Adjustments are blocked for this general ledger account

>{Boolean}</SalesPostingAdjustments>
86
          <SupplierInvoices
SupplierInvoices

GL postings from Supplier Invoices are blocked for this general ledger account

>{Boolean}</SupplierInvoices>
87
          <SupplierCreditNotes
SupplierCreditNotes

GL postings from Supplier Credit Notes are blocked for this general ledger account

>{Boolean}</SupplierCreditNotes>
88
          <SupplierPostingAdjustments
SupplierPostingAdjustments

GL postings from Supplier Posting Adjustments are blocked for this general ledger account

>{Boolean}</SupplierPostingAdjustments>
89
          <Payments
Payments

GL postings from Payments are blocked for this general ledger account

>{Boolean}</Payments>
90
          <ManualGLPostings
ManualGLPostings

GL postings from Manual GL Postings are blocked for this general ledger account

>{Boolean}</ManualGLPostings>
91
          <SAFTStandardCodeId
SAFTStandardCodeId

SAF-T standard code identifier

>{Integer}</SAFTStandardCodeId>
92
          <Code
Code

SAF-T standard code

>{String}</Code>
93
          <TranslatedName
TranslatedName

Name of SAF-T standard code

>{String}</TranslatedName>
94
          <SAFTStandardCodeLink
SAFTStandardCodeLink

SAF-T standard code reference

>{String}</SAFTStandardCodeLink>
95
          <AccountingPeriod>
96
               <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

>{String}</AccountingPeriodLink>
99
          </AccountingPeriod>
100
          <PeriodAmounts>
101
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Total amount.

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

Total debit amount.

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

Total credit amount.

>{Decimal}</CreditAmount>
105
          </PeriodAmounts>
106
          <YearToDateAmounts>
107
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Total amount.

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

Total debit amount.

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

Total credit amount.

>{Decimal}</CreditAmount>
111
          </YearToDateAmounts>
112
     </BlockPostingsFor>
113
</GeneralLedgerAccount>
1
{
2
     "generalLedgerAccount": {
3
          "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

Status of general ledger account

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
6
          "name
Name

Name of general ledger account

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

Type of account

Possible domain values can be found here

": "{String}",
8
          "category
Category

Category of account

Possible domain values can be found here

": "{String}",
9
          "postingType
PostingType

Posting type of account. Only debit, only credit or both.

Possible domain values can be found here

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

Description of account

": "{String}",
11
          "accountNumber
AccountNumber

The account number of the general ledger account

": "{String}",
12
          "isAgioCalculated
IsAgioCalculated

True if general ledger account is agio calculated

": "{Boolean}",
13
          "treeLevel
TreeLevel

Level in the general ledger account tree. 0 is the root.

": "{Integer}",
14
          "isControlAccount
IsControlAccount

True if general ledger account is a control account

": {
15
               "hasChildren
HasChildren

True if general ledger account has any child accounts

": "{Boolean}",
16
               "numberOfChildren
NumberOfChildren

Number of general ledger account children

": "{Integer}"
17
          },
18
          "vATPercent
VATPercent

Value added tax percent

": "{Decimal}",
19
          "locationRequirement
LocationRequirement

Specifies how the location should be used for the specific account.

Possible domain values can be found here

": "{String}",
20
          "intercompanyCodeRequirement
IntercompanyCodeRequirement

Specifies how the intercompany code should be used for the specific account.

Possible domain values can be found here

": "{String}",
21
          "transferToFixedAsset
TransferToFixedAsset

Specifies how investments should be transfered into the fixed assets register.

Possible domain values can be found here

": "{String}",
22
          "lastGeneralLedgerPostingPeriod
LastGeneralLedgerPostingPeriod

Last general ledger posting period of account

": "{Integer}",
23
          "createdBy": {
24
               "userId
UserId

User identifier

": "{Integer}",
25
               "userLink
UserLink

User reference

": "{String}"
26
          },
27
          "validity": {
28
               "effectivePeriod
EffectivePeriod

Period the account is effective/valid from

": "{Integer}",
29
               "expirationPeriod
ExpirationPeriod

Period the account expires (is valid to)

": "{Integer}"
30
          },
31
          "budgetAccount": {
32
               "budgetAccountId
BudgetAccountId

Budget account identifier

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

Code of budget

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

Name of budget

": "{String}",
35
               "budgetAccountLink
BudgetAccountLink

Budget reference

": "{String}"
36
          },
37
          "defaultDepartment": {
38
               "departmentId
DepartmentId

Department identifier

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

Name of department

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

Finance department reference

": "{String}"
41
          },
42
          "defaultVATCodeDefinition": {
43
               "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

": "{String}"
44
          },
45
          "generalLedgerAccountGroup": {
46
               "generalLedgerAccountGroupId
GeneralLedgerAccountGroupId

General ledger account group identifier

": "{Integer}",
47
               "code
Code

Code of general ledger account group

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

Name of general ledger account group

": "{String}",
49
               "generalLedgerAccountGroupLink
GeneralLedgerAccountGroupLink

General ledger account group reference

": "{String}",
50
               "dimensionRequirement": {
51
                    "requirement
Requirement

Specifies how the dimension should be used for the specific account.

Possible domain values can be found here

": "{String}",
52
                    "dimensionDefinition": {
53
                         "dimensionDefinitionId
DimensionDefinitionId

Dimension identifier

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

Name of dimension

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

Description of dimension

": "{String}",
56
                         "valueSource
ValueSource

Where the value is selected from.

": {
57
                              "type
Type

Type of source

Possible domain values can be found here

": "{String}",
58
                              "archiveClass": {
59
                                   "name
Name

Name of archive class

Possible domain values can be found here

": "{String}"
60
                              },
61
                              "field": {
62
                                   "name
Name

Name of field

Possible domain values can be found here

": "{String}"
63
                              }
64
                         },
65
                         "dimensionDefinitionLink
DimensionDefinitionLink

Dimension reference

": "{String}"
66
                    }
67
               }
68
          },
69
          "depreciationRule": {
70
               "depreciationRuleId
DepreciationRuleId

Depreciation rule identifier

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

Name of depreciation rule

": "{String}",
72
               "depreciationRuleLink
DepreciationRuleLink

Depreciation rule reference

": "{String}"
73
          },
74
          "parentGeneralLedgerAccounts": [
75
               {
76
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

Name of general ledger account

": "{String}",
78
                    "accountNumber
AccountNumber

The account number of the general ledger account

": "{String}",
79
                    "treeLevel
TreeLevel

Level in the general ledger account tree. 0 is the root.

": "{Integer}",
80
                    "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
81
               }
82
          ],
83
          "blockPostingsFor": {
84
               "salesInvoices
SalesInvoices

GL postings from Sales Invoices are blocked for this general ledger account

": "{Boolean}",
85
               "salesCreditNotes
SalesCreditNotes

GL postings from Sales Credit Notes are blocked for this general ledger account

": "{Boolean}",
86
               "salesPostingAdjustments
SalesPostingAdjustments

GL postings from Sales Posting Adjustments are blocked for this general ledger account

": "{Boolean}",
87
               "supplierInvoices
SupplierInvoices

GL postings from Supplier Invoices are blocked for this general ledger account

": "{Boolean}",
88
               "supplierCreditNotes
SupplierCreditNotes

GL postings from Supplier Credit Notes are blocked for this general ledger account

": "{Boolean}",
89
               "supplierPostingAdjustments
SupplierPostingAdjustments

GL postings from Supplier Posting Adjustments are blocked for this general ledger account

": "{Boolean}",
90
               "payments
Payments

GL postings from Payments are blocked for this general ledger account

": "{Boolean}",
91
               "manualGLPostings
ManualGLPostings

GL postings from Manual GL Postings are blocked for this general ledger account

": "{Boolean}",
92
               "sAFTStandardCodeId
SAFTStandardCodeId

SAF-T standard code identifier

": "{Integer}",
93
               "code
Code

SAF-T standard code

": "{String}",
94
               "translatedName
TranslatedName

Name of SAF-T standard code

": "{String}",
95
               "sAFTStandardCodeLink
SAFTStandardCodeLink

SAF-T standard code reference

": "{String}",
96
               "accountingPeriod": {
97
                    "accountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

": "{String}"
100
               },
101
               "periodAmounts": {
102
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Total amount.

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

Total debit amount.

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

Total credit amount.

": "{Decimal}"
106
               },
107
               "yearToDateAmounts": {
108
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Total amount.

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

Total debit amount.

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

Total credit amount.

": "{Decimal}"
112
               }
113
          }
114
     }
115
}

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 101013 HTTP 404 Sub-module not found
Error 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}
Error 101420 HTTP 404 Setting definition not found
Error 104469 HTTP 400 You cannot change the forward option to NO, FAR documents exists!
Error 103702 HTTP 400 From period is not valid. General ledger postings exists.
Error 103703 HTTP 400 To period is not valid. General ledger postings exists.
Error 104702 HTTP 400 You cannot change posting type of a processed (status 9) general ledger account
Error 105056 HTTP 400 You cannot change account type. General ledger postings exists.
Error 105087 HTTP 400 You cannot change the blocking attributes for an off-balance account.
Error 105176 HTTP 400 Child account exists, the account cannot be changed to an non control account.
Error 105177 HTTP 400 You cannot change to a control account. General ledger postings exists.
Error 106939 HTTP 400 Cannot set parent account to the same account
Error 105179 HTTP 400 Only control accounts are allowed as parent account.