Accounting Document

Update Internally Posted Document

HTTP Request

PUT /api/v1/general-ledger/accounting-documents/internally-posted-document

Parameters

Name

In

Type

Required

Description

body

body

UpdatePostingDataRequestDto

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[LedgerTransactionInfo]

false

none

[Data structure representing detailed information about a ledger transaction, including associated accounts and financial records, essential for accurate ledger entry management and reporting.]

» id

integer(int64)

false

none

Unique identifier for the resource

» requestUniqueId

string

false

none

Unique identifier for the request unique

» createdByApplication

string

false

none

Text value for createdByApplication in LedgerTransactionInfo

» applicationReferenceId

string

true

none

Any application MUST send a unique reference in order to ignore duplicate postings.

» documentComments

string

false

none

Text value for documentComments in LedgerTransactionInfo

» name

string

false

none

Name of the resource

» principalPositionType

string

false

none

Type of the principal position

» postingTransactionType

string

false

none

Type of the posting transaction

» postingType

string

false

none

Type of the posting

» ledgerType

string

false

none

Type of the ledger

» paymentType

string

false

none

none

» parallelCurrencyEnabled

boolean

false

none

Indicates whether this feature is enabled

» generateInvoiceInAp

boolean

false

none

Boolean flag indicating generateInvoiceInAp status

» generateVendorInvoice

boolean

false

none

Boolean flag indicating generateVendorInvoice status

» calculateTax

boolean

false

none

Boolean flag indicating calculateTax status

» taxCalculationType

string

false

none

Type of the tax calculation

» currencyDetail

CurrencyDetail

false

none

Data transfer object representing detailed information about currency used in ledger entries, transactions, and accounts within the General Ledger, facilitating accurate financial record management.

»» currencyId

integer(int64)

false

none

Unique identifier for the currency

»» currencyDisplayId

string

false

none

Unique identifier for the currency display

»» currencyDefinitionType

string

false

none

Type of the currency definition

»» currencyType

string

false

none

Type of the currency

» classificationInfo

ClassificationInfo

false

none

Data structure representing classification details for ledger entries, encompassing transaction types, associated accounts, and relevant financial records to facilitate accurate financial reporting and analysis.

»» accountingStandard

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»» leaseClassificationType

string

false

none

Type of the lease classification

» date

LedgerTransactionDate

false

none

Data structure representing the date associated with a ledger transaction, crucial for maintaining accurate financial records and facilitating effective account management within the General Ledger.

»» documentDate

string(date-time)

false

none

Date of the document

»» userDocumentDate

string(date)

false

none

Date of the user document

»» postingDate

string(date)

false

none

Date of the posting

»» transactionDate

string(date)

false

none

Date of the transaction

»» translationDate

string(date)

false

none

Date of the translation

»» fiscalVariantId

integer(int64)

false

none

Unique identifier for the fiscal variant

»» fiscalVariantDisplayId

string

false

none

Unique identifier for the fiscal variant display

»» calendarType

string

false

none

Type of the calendar

»» fiscalYear

integer(int32)

false

none

Numeric value representing fiscalYear

»» fiscalPeriod

integer(int32)

false

none

Numeric value representing fiscalPeriod

» automaticReversal

JournalVoucherAutomaticReversalDto

false

none

Data transfer object representing an automatic reversal of journal vouchers within the General Ledger, facilitating accurate financial record management and ensuring the integrity of ledger entries and transactions.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» postingDate

string(date)

false

none

Date of the posting

»» documentDate

string(date)

false

none

Date of the document

»» reversalReason

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

» trace

LedgerTransactionTrace

false

none

Data transfer object representing a detailed trace of ledger transactions, capturing essential information related to each financial record, including associated accounts and ledger entries.

»» previousLedgerTransactionId

integer(int64)

false

none

Unique identifier for the previous ledger transaction

»» nextLedgerTransactionId

integer(int64)

false

none

Unique identifier for the next ledger transaction

»» postExternalType

string

false

none

Type of the post external

» fosReferences

LedgerTransactionReferencesFosDto

false

none

Data transfer object representing references for ledger transactions, encapsulating essential details related to ledger entries, accounts, and financial records within the General Ledger domain.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» system

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» company

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» leaseArea

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» leaseGroup

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» leaseDepartment

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» businessUnit

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» mainCostCenter

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» internalAssetClass

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» documentType

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» depreciationArea

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» reversalReason

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» tradingPartner

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» allocationNumber

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» responsibleCostCenter

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» workBreakdownStructure

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» businessArea

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» functionalArea

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» plant

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» internalOrder

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» network

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» paymentTerm

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» paymentBlock

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» paymentMethod

PaymentMethodBaseId

false

none

Data transfer object representing the unique identifier for a payment method used in ledger entries and financial transactions, facilitating accurate tracking and management of accounts and financial records.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»»» type

string

true

none

Type of the resource

»» segment

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» purchasingOrganization

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» purchasingOrder

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

» assetRegisterReferences

LedgerTransactionReferencesAssetRegisterDto

false

none

Data transfer object representing the references associated with ledger transactions in the asset register, facilitating accurate tracking and management of financial records within the general ledger.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» asset

AssetInfo

false

none

Data structure representing detailed information about an asset within the General Ledger, including its associated ledger entries, transactions, and account details, essential for accurate financial record management.

»»» assetId

integer(int64)

false

none

Unique identifier for the asset

»»» assetDisplayId

string

false

none

Unique identifier for the asset display

»»» assetNumber

string

false

none

Text value for assetNumber in AssetInfo

»»» subAssetNumber

string

false

none

Text value for subAssetNumber in AssetInfo

»» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

» nlaReferences

LedgerTransactionReferencesNlaDto

false

none

Data transfer object representing references associated with ledger transactions, facilitating the management of financial records and ensuring accurate accounting entries within the General Ledger.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» contract

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» leaseComponent

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» activationGroup

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» unit

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» contractExternalId

string

false

none

Unique identifier for the contract external

»» journalId

integer(int64)

false

none

Unique identifier for the journal

»» activationGroupRevisionId

integer(int64)

false

none

Unique identifier for the activation group revision

»» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

» nlaCustomReferences

[oneOf]

false

none

List of nlaCustomReferences items

oneOf

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceBigDecimalDto

false

none

Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types.

allOf - discriminator: dataType

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDto

false

none

Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

»»»» key

string

false

none

Text value for key in CustomApplicationReferenceDto

»»»» dataType

string

false

none

Type of the data

»»»» value

object

false

none

Object containing value details

and

Name

Type

Required

Restrictions

Description

»»» anonymous

object

false

none

none

»»»» value

number

false

none

none

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceBooleanDto

false

none

Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records.

allOf - discriminator: dataType

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDto

false

none

Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

and

Name

Type

Required

Restrictions

Description

»»» anonymous

object

false

none

none

»»»» value

boolean

false

none

none

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceDateDto

false

none

Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records.

allOf - discriminator: dataType

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDto

false

none

Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

and

Name

Type

Required

Restrictions

Description

»»» anonymous

object

false

none

none

»»»» value

string(date)

false

none

none

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceDoubleDto

false

none

Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records.

allOf - discriminator: dataType

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDto

false

none

Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

and

Name

Type

Required

Restrictions

Description

»»» anonymous

object

false

none

none

»»»» value

number(double)

false

none

none

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceIntegerDto

false

none

Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records.

allOf - discriminator: dataType

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDto

false

none

Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

and

Name

Type

Required

Restrictions

Description

»»» anonymous

object

false

none

none

»»»» value

integer(int32)

false

none

none

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceLongDto

false

none

Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

allOf - discriminator: dataType

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDto

false

none

Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

and

Name

Type

Required

Restrictions

Description

»»» anonymous

object

false

none

none

»»»» value

integer(int64)

false

none

none

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceStringDto

false

none

Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records.

allOf - discriminator: dataType

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDto

false

none

Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

and

Name

Type

Required

Restrictions

Description

»»» anonymous

object

false

none

none

»»»» value

string

false

none

none

continued

Name

Type

Required

Restrictions

Description

» nreReferences

LedgerTransactionReferencesNreDto

false

none

Data transfer object representing references for ledger transactions, encapsulating essential details related to ledger entries, accounts, and financial records within the General Ledger domain.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» premise

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» location

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» lease

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

» nreCustomReferences

[oneOf]

false

none

List of nreCustomReferences items

oneOf

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceBigDecimalDto

false

none

Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types.

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceBooleanDto

false

none

Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records.

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceDateDto

false

none

Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records.

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceDoubleDto

false

none

Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records.

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceIntegerDto

false

none

Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records.

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceLongDto

false

none

Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceStringDto

false

none

Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records.

continued

Name

Type

Required

Restrictions

Description

» apReferences

LedgerTransactionReferencesApDto

false

none

Data transfer object representing references for ledger transactions, encapsulating essential details related to ledger entries, accounts, and financial records for accurate transaction tracking and reporting within the General Ledger domain.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» invoice

LedgerTransactionReferencesApInvoiceData

false

none

none

»»» id

integer(int64)

false

none

none

»»» displayId

string

false

none

none

»»» name

string

false

none

none

»» vendor

LedgerTransactionReferencesApVendorData

false

none

none

»»» id

integer(int64)

false

none

none

»»» displayId

string

false

none

none

»»» name

string

false

none

none

»» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

» apCustomReferences

[oneOf]

false

none

List of apCustomReferences items

oneOf

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceBigDecimalDto

false

none

Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types.

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceBooleanDto

false

none

Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records.

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceDateDto

false

none

Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records.

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceDoubleDto

false

none

Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records.

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceIntegerDto

false

none

Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records.

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceLongDto

false

none

Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

xor

Name

Type

Required

Restrictions

Description

»» anonymous

CustomApplicationReferenceStringDto

false

none

Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records.

continued

Name

Type

Required

Restrictions

Description

» entries

[LedgerEntryDto]

false

none

List of entries items

»» id

integer(int64)

false

none

Unique identifier for the resource

»» entryType

string

true

none

Type of the entry

»» amount

number

true

none

Amount value

»» unroundedAmount

number

false

none

Amount of unrounded

»» deltaAdjustment

number

false

none

Value for deltaAdjustment field

»» itemText

string

false

none

Text value for itemText in LedgerEntryDto

»» itemNoAcc

integer(int32)

false

none

Numeric value representing itemNoAcc

»» generalLedger

GeneralLedgerInfo

true

none

Data transfer object representing detailed information about ledger entries, including associated transactions and accounts, to facilitate accurate financial record management within the General Ledger domain.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»»» generalLedgerAccountName

string

true

none

Name of the general ledger account

»»» generalLedgerAccountCode

string

true

none

Code for the general ledger account

»»» openItemManagement

boolean

true

none

Boolean flag indicating openItemManagement status

»»» accountCategory

string

true

none

Category of the account

»»» shortName

string

false

none

Abbreviated name of the resource

»»» longName

string

false

none

Name of the long

»» additionalCurrencyEntries

[LedgerEntryForAdditionalCurrencyDto]

false

none

List of additionalCurrencyEntries items

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» amount

number

false

none

Amount value

»»» unroundedAmount

number

false

none

Amount of unrounded

»»» deltaAdjustment

number

false

none

Value for deltaAdjustment field

»»» itemNoAcc

integer(int32)

false

none

Numeric value representing itemNoAcc

»»» currencyDetail

CurrencyDetail

false

none

Data transfer object representing detailed information about currency used in ledger entries, transactions, and accounts within the General Ledger, facilitating accurate financial record management.

»»» currencyConversionDetail

CurrencyConversionDetail

false

none

Data transfer object representing the details of currency conversion for ledger entries, facilitating accurate transaction recording and financial reporting within accounts.

»»»» rate

number

false

none

Rate value

»»»» conversionDate

string(date)

false

none

Date of the conversion

»»»» translationDateType

string

false

none

Type of the translation date

»»»» sourceCurrencyType

string

false

none

Type of the source currency

»»»» sourceCurrency

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»»»» depreciationArea

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»»» ledgerEntryId

integer(int64)

false

none

Unique identifier for the ledger entry

»»» ledgerEntryTaxId

integer(int64)

false

none

Unique identifier for the ledger entry tax

»» tag

string

false

none

Text value for tag in LedgerEntryDto

»» costCenter

CostCenterAllocation

false

none

Data structure representing the allocation of costs to specific cost centers within the General Ledger, facilitating accurate tracking and reporting of financial transactions and ledger entries.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»»» mainCostCenter

boolean

false

none

Boolean flag indicating mainCostCenter status

»»» allocationPercentage

number(double)

false

none

Percentage of allocation

»» profitCenter

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» partner

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» transactionType

string

false

none

Type of the transaction

»» nlaCustomReferences

[oneOf]

false

none

List of nlaCustomReferences items

oneOf

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceBigDecimalDto

false

none

Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceBooleanDto

false

none

Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDateDto

false

none

Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDoubleDto

false

none

Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceIntegerDto

false

none

Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceLongDto

false

none

Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceStringDto

false

none

Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records.

continued

Name

Type

Required

Restrictions

Description

»» nreCustomReferences

[oneOf]

false

none

List of nreCustomReferences items

oneOf

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceBigDecimalDto

false

none

Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceBooleanDto

false

none

Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDateDto

false

none

Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDoubleDto

false

none

Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceIntegerDto

false

none

Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceLongDto

false

none

Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceStringDto

false

none

Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records.

continued

Name

Type

Required

Restrictions

Description

»» apCustomReferences

[oneOf]

false

none

List of apCustomReferences items

oneOf

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceBigDecimalDto

false

none

Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceBooleanDto

false

none

Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDateDto

false

none

Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceDoubleDto

false

none

Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceIntegerDto

false

none

Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceLongDto

false

none

Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records.

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

CustomApplicationReferenceStringDto

false

none

Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records.

continued

Name

Type

Required

Restrictions

Description

»» taxEntries

[LedgerEntryTaxDto]

false

none

List of taxEntries items

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» entryType

string

true

none

Type of the entry

»»» amount

number

true

none

Amount value

»»» unroundedAmount

number

false

none

Amount of unrounded

»»» deltaAdjustment

number

false

none

Value for deltaAdjustment field

»»» itemText

string

false

none

Text value for itemText in LedgerEntryTaxDto

»»» itemNoAcc

integer(int32)

false

none

Numeric value representing itemNoAcc

»»» generalLedger

GeneralLedgerInfo

true

none

Data transfer object representing detailed information about ledger entries, including associated transactions and accounts, to facilitate accurate financial record management within the General Ledger domain.

»»» additionalCurrencyEntries

[LedgerEntryForAdditionalCurrencyDto]

false

none

List of additionalCurrencyEntries items

»»» taxRate

number

false

none

Rate of tax

»»» taxBaseAmount

number

false

none

Amount of tax base

»»» totalTaxDocumentAmount

number

false

none

Amount of total tax document

»»» taxExempt

number

false

none

Value for taxExempt field

»»» taxExemptionPercentage

number

false

none

Percentage of tax exemption

»»» taxAffected

number

false

none

Value for taxAffected field

»»» taxAccount

string

false

none

Number of ledger entry items

»»» accountingKey

string

false

none

Text value for accountingKey in LedgerEntryTaxDto

»»» conditionKey

string

false

none

Represents the specific condition associated with a ledger entry, facilitating accurate tracking and categorization of financial transactions within the general ledger.

»»» taxCode

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»»» taxJurisdiction

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»»» taxDetermination

BaseId

false

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»»» financialTermId

integer(int64)

false

none

Unique identifier for the financial term

»»» ledgerEntryId

integer(int64)

false

none

Unique identifier for the ledger entry

»» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

» notes

[LedgerTransactionNoteDto]

false

none

List of notes items

»» id

integer(int64)

false

none

Unique identifier for the resource

»» note

string

false

none

Text value for note in LedgerTransactionNoteDto

» attachments

[LedgerTransactionAttachmentDto]

false

none

List of attachments items

»» id

integer(int64)

false

none

Unique identifier for the resource

»» fileName

string

false

none

Name of the file

»» fileStorageId

string

false

none

Unique identifier for the file storage

»» docStoreId

integer(int64)

false

none

Unique identifier for the doc store

» journalVoucherWorkflowHistory

[JournalVoucherWorkflowHistoryDto]

false

none

List of journalVoucherWorkflowHistory items

»» id

integer(int64)

false

none

Unique identifier for the resource

»» eventType

string

false

none

Type of the event

»» eventDate

string(date-time)

false

none

Date of the event

»» user

string

false

none

User information related to accounting

» ledgerTransactionGroupId

integer(int64)

false

none

Unique identifier for the ledger transaction group

» accountingDocumentId

integer(int64)

false

none

Unique identifier for the accounting document

» internalPostingStatus

InternalPostingStatus

false

none

Data transfer object representing the status of internal postings within the General Ledger, encompassing ledger entries, transactions, and associated financial records to ensure accurate account management.

»» documentNumber

string

false

none

Text value for documentNumber in InternalPostingStatus

»» status

string

false

none

Status of the resource

»» postingMessage

string

false

none

Text value for postingMessage in InternalPostingStatus

» nlaEnrichmentState

ApplicationEnrichmentStateDto

false

none

Data transfer object representing the state of application enrichment for ledger entries, transactions, and accounts, facilitating the management and tracking of financial records within the General Ledger domain.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» status

string

false

none

Status of the resource

»» message

string

false

none

Text value for message in ApplicationEnrichmentStateDto

»» history

[EnrichmentRequestHistoryDto]

false

none

List of history items

»»» requestingUser

string

false

none

User information related to accounting

»»» enrichmentRequestId

integer(int64)

false

none

Unique identifier for the enrichment request

»»» requestedAt

string(date-time)

false

none

Text value for requestedAt in EnrichmentRequestHistoryDto

»»» enrichedAt

string(date-time)

false

none

Text value for enrichedAt in EnrichmentRequestHistoryDto

»»» requestStatus

string

false

none

Status of the request

»»» applicationStatus

string

false

none

Status of the application

»»» message

string

false

none

Text value for message in EnrichmentRequestHistoryDto

» nreEnrichmentState

ApplicationEnrichmentStateDto

false

none

Data transfer object representing the state of application enrichment for ledger entries, transactions, and accounts, facilitating the management and tracking of financial records within the General Ledger domain.

» apEnrichmentState

ApplicationEnrichmentStateDto

false

none

Data transfer object representing the state of application enrichment for ledger entries, transactions, and accounts, facilitating the management and tracking of financial records within the General Ledger domain.

» externalPostingStatus

ExternalPostingStatus

false

none

Data structure representing the status of external postings within the General Ledger, encompassing ledger entries, transactions, accounts, and financial records to ensure accurate tracking and reporting of financial activities.

»» documentNumber

string

false

none

Text value for documentNumber in ExternalPostingStatus

»» objType

string

false

none

Type of the obj

»» objKey

string

false

none

Text value for objKey in ExternalPostingStatus

»» objSys

string

false

none

Text value for objSys in ExternalPostingStatus

»» username

string

false

none

Human-readable name of the ledger entry

»» status

string

false

none

Status of the resource

»» postingMessage

string

false

none

Text value for postingMessage in ExternalPostingStatus

»» taskId

integer(int64)

false

none

Unique identifier for the task

Enumerated Values

Attribute

Value

accountCategory

BALANCESHEET, PROFITANDLOSS

applicationStatus

ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED

calendarType

FISCAL_VARIANT, REGULAR_CALENDAR, _360

createdByApplication

ACCOUNT_PAYABLE, ACCOUNT_RECEIVABLE, GENERAL_LEDGER, NLA, NRE, REPAIR_MAINTENANCE

currencyDefinitionType

COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY

dataType

BIG_DECIMAL, BOOLEAN, DATE, DATETIME, DOUBLE, INTEGER, LONG, STRING

entryType

C, D

eventType

APPROVED, ARCHIVED, REWORK, SEND_TO_APPROVAL

leaseClassificationType

DIRECT_FINANCING, FINANCE, LOW_VALUE, NON_LEASE, OFF_BALANCE_SHEET, OPERATING, PROVISIONING, SALES_TYPE, SERVICE_CONTRACT, SHORT_TERM

ledgerType

ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, GRV, IDC, IMPAIRMENT, INCENTIVE, LIABILITY, LIABILITY_ADJUSTMENT, LIABILITY_ADJUSTMENT_DECREASE, LIABILITY_ADJUSTMENT_INCREASE, LIABILITY_ADJUSTMENT_INDEXATION_DECREASE, LIABILITY_ADJUSTMENT_INDEXATION_INCREASE, MODIFICATION_CAPITALIZATION, MODIFICATION_CAPITALIZATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_ASSET_INCREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_INCREASE, PAYMENT, PREPAID, PROVISIONING, RECLASSIFICATION_ASSET_TRANSFER, RECLASSIFICATION_NON_ASSET_TRANSFER, TERMINATION_ASSET, TERMINATION_CLOSED_LEDGER, TERMINATION_LIABILITY, TERMINATION_ROUNDING, URV, VOUCHER

paymentType

CLEARING, N_A, PAYMENT

postExternalType

POST, SKIP

postingTransactionType

POST, REVERSE

postingType

ACCRUAL, CHARGE, DEPRECIATION, MODIFICATION_RECOGNITION, PAYMENT, PROVISIONING, RECOGNITION, TERMINATION, VOUCHER

principalPositionType

LESSEE, LESSOR

requestStatus

FAILED, SENT

sourceCurrencyType

COMPANY_CURRENCY, CONTRACT_CURRENCY, N_A

status

, ARCHIVED, DONE, ENRICHED, ENRICHING, FAILED, OPEN, PENDING, PROCESSING, SCHEDULED, SKIPPED

taxCalculationType

NET

translationDateType

, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE

Update Internally Reversed Document

HTTP Request

POST /api/v1/general-ledger/accounting-documents/update-internally-reversed-document

📋 Description: Updates an internally reversed accounting document within the general ledger, ensuring accurate ledger entries and maintaining the integrity of financial records associated with transactions and accounts.

Parameters

Name

In

Type

Required

Description

body

body

InternalReversalDocumentUpdateRequest

true

Request body containing the details of the internally reversed accounting document, including ledger entry information, transaction identifiers, and relevant account data for accurate financial record updates.

Responses

Status

Meaning

Description

Schema

200

OK

OK

InternalReversalDocumentUpdateResult

Reverse

HTTP Request

POST /api/v1/general-ledger/accounting-documents/reverse

📋 Description: Reverses a specified ledger entry within the General Ledger by creating a corresponding accounting document, ensuring accurate financial record management for transactions and accounts.

Parameters

Name

In

Type

Required

Description

body

body

InternalReversalRequest

true

Request body containing the details of the ledger entry to be reversed, including transaction identifiers and account information necessary for updating the financial record.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PostingResult

Post

HTTP Request

POST /api/v1/general-ledger/accounting-documents/post

📋 Description: Posts new accounting documents to the general ledger, facilitating the recording of ledger entries and transactions associated with specific accounts to maintain accurate financial records.

Parameters

Name

In

Type

Required

Description

body

body

InternalPostingRequest

true

Request body containing the ledger entry data, including transaction details and account information necessary for creating financial records.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PostingResult

Has Non Posted Documents

HTTP Request

POST /api/v1/general-ledger/accounting-documents/has-non-posted-documents

📋 Description: Checks for the existence of non-posted accounting documents within the general ledger, ensuring accurate tracking of ledger entries and financial records associated with transactions and accounts.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing the account identifiers and transaction details necessary to determine the presence of non-posted ledger entries within the financial records.

Responses

Status

Meaning

Description

Schema

200

OK

OK

boolean

Cleanup Accounting Documents

HTTP Request

POST /api/v1/general-ledger/accounting-documents/cleanup

📋 Description: Initiates the cleanup process for outdated or erroneous accounting documents within the general ledger, ensuring the integrity and accuracy of financial records associated with ledger entries and transactions.

Parameters

Name

In

Type

Required

Description

message

query

string

true

Textual content detailing the reason for the cleanup operation on accounting documents within the general ledger, ensuring clarity in financial record management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Bulk Reverse

HTTP Request

POST /api/v1/general-ledger/accounting-documents/bulk-reverse

📋 Description: Submits a bulk reversal request for multiple accounting documents within the general ledger, allowing users to efficiently correct financial records related to ledger entries and transactions.

Parameters

Name

In

Type

Required

Description

body

body

InternalReversalRequest

true

Request body containing an array of accounting document identifiers and reversal details necessary for bulk reversing ledger entries in the financial records.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[PostingResult]

false

none

[Data transfer object representing the outcome of a ledger entry posting, including details of the transaction, associated accounts, and relevant financial records.]

» errorMessage

string

false

none

Text value for errorMessage in PostingResult

» requestUniqueId

string

false

none

Unique identifier for the request unique

» accountingDocumentId

integer(int64)

false

none

Unique identifier for the accounting document

» entryResults

[PostingEntryResult]

false

none

List of entryResults items

»» type

string

false

none

Type of the resource

»» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

»» requestUniqueId

string

false

none

Unique identifier for the request unique

»» applicationReferenceId

string

false

none

Unique identifier for the application reference

»» internalPostingStatus

InternalPostingStatus

false

none

Data transfer object representing the status of internal postings within the General Ledger, encompassing ledger entries, transactions, and associated financial records to ensure accurate account management.

»»» documentNumber

string

false

none

Text value for documentNumber in InternalPostingStatus

»»» status

string

false

none

Status of the resource

»»» postingMessage

string

false

none

Text value for postingMessage in InternalPostingStatus

»» postingTransactionType

string

false

none

Type of the posting transaction

Enumerated Values

Attribute

Value

postingTransactionType

POST, REVERSE

status

, ARCHIVED, DONE, FAILED, OPEN, PROCESSING, SCHEDULED

type

ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, GRV, IDC, IMPAIRMENT, INCENTIVE, LIABILITY, LIABILITY_ADJUSTMENT, LIABILITY_ADJUSTMENT_DECREASE, LIABILITY_ADJUSTMENT_INCREASE, LIABILITY_ADJUSTMENT_INDEXATION_DECREASE, LIABILITY_ADJUSTMENT_INDEXATION_INCREASE, MODIFICATION_CAPITALIZATION, MODIFICATION_CAPITALIZATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_ASSET_INCREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_INCREASE, PAYMENT, PREPAID, PROVISIONING, RECLASSIFICATION_ASSET_TRANSFER, RECLASSIFICATION_NON_ASSET_TRANSFER, TERMINATION_ASSET, TERMINATION_CLOSED_LEDGER, TERMINATION_LIABILITY, TERMINATION_ROUNDING, URV, VOUCHER

Bulk Post

HTTP Request

POST /api/v1/general-ledger/accounting-documents/bulk-post

📋 Description: Submits multiple accounting documents in bulk to the general ledger, facilitating efficient ledger entry and transaction processing for financial records.

Parameters

Name

In

Type

Required

Description

body

body

InternalPostingRequest

true

Request body containing an array of ledger entry data, including transaction details, account identifiers, and associated financial records for bulk posting to the general ledger.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[PostingResult]

false

none

[Data transfer object representing the outcome of a ledger entry posting, including details of the transaction, associated accounts, and relevant financial records.]

» errorMessage

string

false

none

Text value for errorMessage in PostingResult

» requestUniqueId

string

false

none

Unique identifier for the request unique

» accountingDocumentId

integer(int64)

false

none

Unique identifier for the accounting document

» entryResults

[PostingEntryResult]

false

none

List of entryResults items

»» type

string

false

none

Type of the resource

»» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

»» requestUniqueId

string

false

none

Unique identifier for the request unique

»» applicationReferenceId

string

false

none

Unique identifier for the application reference

»» internalPostingStatus

InternalPostingStatus

false

none

Data transfer object representing the status of internal postings within the General Ledger, encompassing ledger entries, transactions, and associated financial records to ensure accurate account management.

»»» documentNumber

string

false

none

Text value for documentNumber in InternalPostingStatus

»»» status

string

false

none

Status of the resource

»»» postingMessage

string

false

none

Text value for postingMessage in InternalPostingStatus

»» postingTransactionType

string

false

none

Type of the posting transaction

Enumerated Values

Attribute

Value

postingTransactionType

POST, REVERSE

status

, ARCHIVED, DONE, FAILED, OPEN, PROCESSING, SCHEDULED

type

ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, GRV, IDC, IMPAIRMENT, INCENTIVE, LIABILITY, LIABILITY_ADJUSTMENT, LIABILITY_ADJUSTMENT_DECREASE, LIABILITY_ADJUSTMENT_INCREASE, LIABILITY_ADJUSTMENT_INDEXATION_DECREASE, LIABILITY_ADJUSTMENT_INDEXATION_INCREASE, MODIFICATION_CAPITALIZATION, MODIFICATION_CAPITALIZATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_ASSET_INCREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_INCREASE, PAYMENT, PREPAID, PROVISIONING, RECLASSIFICATION_ASSET_TRANSFER, RECLASSIFICATION_NON_ASSET_TRANSFER, TERMINATION_ASSET, TERMINATION_CLOSED_LEDGER, TERMINATION_LIABILITY, TERMINATION_ROUNDING, URV, VOUCHER

Get

HTTP Request

GET /api/v1/general-ledger/accounting-documents/{id}

📋 Description: Retrieves the specified accounting document from the general ledger by its unique identifier, providing essential details related to ledger entries, transactions, and financial records.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

InternalPostingRequest

Get History

HTTP Request

GET /api/v1/general-ledger/accounting-documents/{accountingDocumentId}/history

📋 Description: Retrieves the historical changes and associated details for a specific accounting document identified by the {accountingDocumentId} within the General Ledger, providing insights into ledger entries and financial transactions related to that document.

Parameters

Name

In

Type

Required

Description

accountingDocumentId

path

integer(int64)

true

Unique identifier for the accounting document

doNotIncludeLatestTransaction

query

boolean

true

Indicates whether to exclude the most recent transaction from the retrieved history of the specified accounting document in the general ledger.

ledgerType

query

string

false

Type of the ledger

pageable

query

Pageable

true

Indicates whether the results of the accounting document history retrieval should be paginated, facilitating efficient navigation through extensive financial records related to ledger entries and transactions.

Enumerated Values

Attribute

Value

ledgerType

ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, GRV, IDC, IMPAIRMENT, INCENTIVE, LIABILITY, LIABILITY_ADJUSTMENT, LIABILITY_ADJUSTMENT_DECREASE, LIABILITY_ADJUSTMENT_INCREASE, LIABILITY_ADJUSTMENT_INDEXATION_DECREASE, LIABILITY_ADJUSTMENT_INDEXATION_INCREASE, MODIFICATION_CAPITALIZATION, MODIFICATION_CAPITALIZATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_ASSET_INCREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_INCREASE, PAYMENT, PREPAID, PROVISIONING, RECLASSIFICATION_ASSET_TRANSFER, RECLASSIFICATION_NON_ASSET_TRANSFER, TERMINATION_ASSET, TERMINATION_CLOSED_LEDGER, TERMINATION_LIABILITY, TERMINATION_ROUNDING, URV, VOUCHER

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageLedgerTransactionGroupDto

Find All

HTTP Request

GET /api/v1/general-ledger/accounting-documents/all

📋 Description: Retrieves all accounting documents related to ledger entries, transactions, and accounts within the General Ledger, providing a comprehensive view of financial records.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the accounting documents retrieval should be paginated, facilitating efficient navigation through extensive financial records related to ledger entries and transactions.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageInternalPostingRequest