API

Finance APIs

PUT finance/general-ledger-accounts/{generalLedgerAccountId}

Saves information about the general ledger account

HTTP method PUT
URI https://api.rambase.net/finance/general-ledger-accounts/{generalLedgerAccountId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {generalLedgerAccountId} General ledger account identifier
Integer, minimum 1000
Successful HTTP status code 200
API resource identifier 3408, version 14

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
GeneralLedgerAccount

This field is optional.

>
2
     <Name
Name

Name of general ledger account

This field is optional.

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

Type of account

Applicable domain values can be found here

This field is optional.

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

Category of account

Applicable domain values can be found here

This field is optional.

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

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

Applicable domain values can be found here

This field is optional.

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

Description of account

This field is optional.

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

The account number of the general ledger account

Maximum value: 50

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

This field is optional.

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

True if general ledger account is agio calculated

This field is optional.

>{Boolean}</IsAgioCalculated>
9
     <IsControlAccount
IsControlAccount

True if general ledger account is a control account

This field is optional.

>{Boolean}</IsControlAccount>
10
     <LocationRequirement
LocationRequirement

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

Applicable domain values can be found here

This field is optional.

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

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

Applicable domain values can be found here

This field is optional.

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

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

Applicable domain values can be found here

This field is optional.

>{String}</TransferToFixedAsset>
13
     <Validity
Validity

This field is optional.

>
14
          <EffectivePeriod
EffectivePeriod

Period the account is effective/valid from

Minimum value: 199000

Maximum value: 299912

This field is optional.

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

Period the account expires (is valid to)

Minimum value: 199000

Maximum value: 299912

This field is optional.

>{Integer}</ExpirationPeriod>
16
     </Validity>
17
     <BudgetAccount
BudgetAccount

This field is optional.

>
18
          <BudgetAccountId
BudgetAccountId

Budget account identifier

Minimum value: 100

This field is optional.

>{Integer}</BudgetAccountId>
19
     </BudgetAccount>
20
     <DefaultDepartment
DefaultDepartment

This field is optional.

>
21
          <DepartmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

>{Integer}</DepartmentId>
22
     </DefaultDepartment>
23
     <DefaultVATCodeDefinition
DefaultVATCodeDefinition

This field is optional.

>
24
          <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
25
     </DefaultVATCodeDefinition>
26
     <GeneralLedgerAccountGroup
GeneralLedgerAccountGroup

This field is optional.

>
27
          <GeneralLedgerAccountGroupId
GeneralLedgerAccountGroupId

General ledger account group identifier

Minimum value: 100000

This field is optional.

>{Integer}</GeneralLedgerAccountGroupId>
28
     </GeneralLedgerAccountGroup>
29
     <DimensionRequirements
DimensionRequirements

This field is optional.

>
30
          <DimensionRequirement
DimensionRequirement

This field is optional.

>
31
               <Requirement
Requirement

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

Applicable domain values can be found here

This field is optional.

>{String}</Requirement>
32
               <DimensionDefinition
DimensionDefinition

This field is optional.

>
33
                    <DimensionDefinitionId
DimensionDefinitionId

Dimension identifier

Minimum value: 1

This field is optional.

>{Integer}</DimensionDefinitionId>
34
               </DimensionDefinition>
35
          </DimensionRequirement>
36
     </DimensionRequirements>
37
     <DepreciationRule
DepreciationRule

This field is optional.

>
38
          <DepreciationRuleId
DepreciationRuleId

Depreciation rule identifier

Minimum value: 100000

This field is optional.

>{Integer}</DepreciationRuleId>
39
     </DepreciationRule>
40
     <BlockPostingsFor
BlockPostingsFor

This field is optional.

>
41
          <SalesInvoices
SalesInvoices

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

GL postings from Payments are blocked for this general ledger account

This field is optional.

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

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

This field is optional.

>{Boolean}</ManualGLPostings>
49
     </BlockPostingsFor>
50
     <SAFTStandardCode
SAFTStandardCode

This field is optional.

>
51
          <Code
Code

SAF-T standard code

This field is optional.

>{String}</Code>
52
     </SAFTStandardCode>
53
</GeneralLedgerAccount>
1
{
2
     "generalLedgerAccount
GeneralLedgerAccount

This field is optional.

": {
3
          "name
Name

Name of general ledger account

This field is optional.

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

Type of account

Applicable domain values can be found here

This field is optional.

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

Category of account

Applicable domain values can be found here

This field is optional.

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

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

Applicable domain values can be found here

This field is optional.

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

Description of account

This field is optional.

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

The account number of the general ledger account

Maximum value: 50

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

This field is optional.

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

True if general ledger account is agio calculated

This field is optional.

": "{Boolean}",
10
          "isControlAccount
IsControlAccount

True if general ledger account is a control account

This field is optional.

": "{Boolean}",
11
          "locationRequirement
LocationRequirement

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

Applicable domain values can be found here

This field is optional.

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

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

Applicable domain values can be found here

This field is optional.

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

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

Applicable domain values can be found here

This field is optional.

": "{String}",
14
          "validity
Validity

This field is optional.

": {
15
               "effectivePeriod
EffectivePeriod

Period the account is effective/valid from

Minimum value: 199000

Maximum value: 299912

This field is optional.

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

Period the account expires (is valid to)

Minimum value: 199000

Maximum value: 299912

This field is optional.

": "{Integer}"
17
          },
18
          "budgetAccount
BudgetAccount

This field is optional.

": {
19
               "budgetAccountId
BudgetAccountId

Budget account identifier

Minimum value: 100

This field is optional.

": "{Integer}"
20
          },
21
          "defaultDepartment
DefaultDepartment

This field is optional.

": {
22
               "departmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

": "{Integer}"
23
          },
24
          "defaultVATCodeDefinition
DefaultVATCodeDefinition

This field is optional.

": {
25
               "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

": "{String}"
26
          },
27
          "generalLedgerAccountGroup
GeneralLedgerAccountGroup

This field is optional.

": {
28
               "generalLedgerAccountGroupId
GeneralLedgerAccountGroupId

General ledger account group identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
29
          },
30
          "dimensionRequirements
DimensionRequirements

This field is optional.

": [
31
               {
32
                    "requirement
Requirement

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

Applicable domain values can be found here

This field is optional.

": "{String}",
33
                    "dimensionDefinition
DimensionDefinition

This field is optional.

": {
34
                         "dimensionDefinitionId
DimensionDefinitionId

Dimension identifier

Minimum value: 1

This field is optional.

": "{Integer}"
35
                    }
36
               }
37
          ],
38
          "depreciationRule
DepreciationRule

This field is optional.

": {
39
               "depreciationRuleId
DepreciationRuleId

Depreciation rule identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
40
          },
41
          "blockPostingsFor
BlockPostingsFor

This field is optional.

": {
42
               "salesInvoices
SalesInvoices

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

GL postings from Payments are blocked for this general ledger account

This field is optional.

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

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

This field is optional.

": "{Boolean}"
50
          },
51
          "sAFTStandardCode
SAFTStandardCode

This field is optional.

": {
52
               "code
Code

SAF-T standard code

This field is optional.

": "{String}"
53
          }
54
     }
55
}

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.

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:
1
1

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 101015 HTTP 404 Permission not found
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.