Ledger Transaction

Ledger Transaction - Fetch Custom References

HTTP Request

POST /api/v1/general-ledger/ledger-transactions/custom-references

Parameters

Name

In

Type

Required

Description

body

body

MappingGlFieldFilter

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[MappingGlTableAndFields]

false

none

[Data structure representing the mapping of general ledger tables and fields, facilitating the alignment of ledger entries, transactions, accounts, and financial records for accurate reporting and analysis.]

» table

string

false

none

Specifies the name of the general ledger table associated with the ledger entry, transaction, account, or financial record.

» fields

[MappingGlFieldOption]

false

none

List of fields items

»» field

string

false

none

Represents a specific attribute related to ledger entries, transactions, accounts, or financial records within the General Ledger API.

»» captionKey

string

false

none

The captionKey is a unique string identifier used to reference specific captions associated with ledger entries, transactions, accounts, and financial records within the General Ledger API.

»» caption

string

false

none

Descriptive text associated with a ledger entry, providing context for transactions within financial records and accounts.

»» customReference

boolean

false

none

Boolean flag indicating customReference status

Enumerated Values

Attribute

Value

table

EMPTY_FIELD, LEDGER_ENTRY, LEDGER_ENTRY_ADDITIONAL_CURRENCIES, LEDGER_ENTRY_APPLICATION_REFERENCE_AP, LEDGER_ENTRY_APPLICATION_REFERENCE_NLA, LEDGER_ENTRY_APPLICATION_REFERENCE_NRE, LEDGER_ENTRY_TAX, LEDGER_TRANSACTION, LEDGER_TRANSACTION_APPLICATION_REFERENCE_AP, LEDGER_TRANSACTION_APPLICATION_REFERENCE_NLA, LEDGER_TRANSACTION_APPLICATION_REFERENCE_NRE, USER_INPUT

Ledger Transaction - Fetch Latest Ledger Transaction By Application Reference IDs

HTTP Request

POST /api/v1/general-ledger/ledger-transactions/application-references

📋 Description: Creates application references for ledger transactions within the General Ledger, enabling the association of specific transactions with relevant financial records and accounts.

Parameters

Name

In

Type

Required

Description

body

body

array[string]

true

Request body containing the application reference data for ledger transactions, including relevant identifiers and metadata to ensure accurate financial recordkeeping.

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

Identifies the application that initiated the ledger entry, ensuring traceability of financial records and transactions within the General Ledger.

» applicationReferenceId

string

true

none

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

» documentComments

string

false

none

Comments associated with the ledger entry, providing additional context or notes related to the transaction within the financial record.

» 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

Unique identifier for the asset associated with ledger entries, transactions, and financial records within the General Ledger.

»»» subAssetNumber

string

false

none

Unique identifier for a sub-asset within the General Ledger, used to track and manage financial records related to ledger entries and transactions.

»» 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

Unique identifier for the ledger entry, facilitating accurate tracking and management of financial records within the General Ledger.

»»»» 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

Descriptive text associated with a ledger entry, providing context for the transaction within the financial record.

»» 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

Tag is a string field used to categorize and identify ledger entries within financial records, facilitating efficient transaction tracking and account management.

»» 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

Descriptive text associated with a ledger entry, providing context for the transaction within the financial record.

»»» 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

Unique identifier for the accounting entry associated with a ledger transaction, facilitating accurate financial record management.

»»» 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

Textual annotation associated with a ledger entry, providing additional context for the transaction within the financial record.

» 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

Unique identifier for the financial record associated with a ledger entry or transaction within the General Ledger.

»» status

string

false

none

Status of the resource

»» postingMessage

string

false

none

Descriptive message associated with the posting status of a ledger entry, providing context for the transaction within the financial record.

» 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

Textual representation of the message associated with a ledger entry, providing context for the transaction or financial record.

»» 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

Timestamp indicating when the enrichment request was initiated, relevant for tracking ledger entries and financial transactions.

»»» enrichedAt

string(date-time)

false

none

Timestamp indicating when the ledger entry was enriched, providing a record of the transaction’s enhancement within the financial context.

»»» requestStatus

string

false

none

Status of the request

»»» applicationStatus

string

false

none

Status of the application

»»» message

string

false

none

Textual representation of the message associated with a ledger entry, providing context for the transaction within the financial record.

» 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

Unique identifier for the financial document associated with a ledger entry, facilitating accurate tracking of transactions and account records.

»» objType

string

false

none

Type of the obj

»» objKey

string

false

none

Unique identifier for the external posting status associated with ledger entries and financial records within the General Ledger.

»» objSys

string

false

none

Represents the system-generated status of an external posting related to ledger entries, transactions, accounts, and financial records.

»» username

string

false

none

Human-readable name of the ledger entry

»» status

string

false

none

Status of the resource

»» postingMessage

string

false

none

Textual representation of the posting message associated with a ledger entry, providing context for the transaction within financial records.

»» 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, FX_REMEASUREMENT, GRV, IDC, IMPAIRMENT, INCENTIVE, INVOICE_POSTING, 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, FX_REMEASUREMENT, INVOICE_POSTING, 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

Ledger Transaction - Delete Ledger Transactions By Application Reference IDs

HTTP Request

POST /api/v1/general-ledger/ledger-transactions/application-references/{transactionType}

📋 Description: Creates new application references for ledger transactions of a specified type, facilitating accurate financial record management within the general ledger.

Parameters

Name

In

Type

Required

Description

transactionType

path

string

true

Type of the transaction

body

body

array[string]

true

Request body containing the financial record details for ledger transactions, including necessary application references and associated account information based on the specified transaction type.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Ledger Transaction - Delete Ledger Transactions By Application Reference ID

HTTP Request

POST /api/v1/general-ledger/ledger-transactions/application-reference/{transactionType}/{applicationReferenceId}

📋 Description: Creates a new ledger transaction entry in the General Ledger by associating it with a specified transaction type and application reference ID, ensuring accurate financial record management.

Parameters

Name

In

Type

Required

Description

transactionType

path

string

true

Type of the transaction

applicationReferenceId

path

string

true

Unique identifier for the application reference

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Ledger Transaction - Delete Ledger Transactions By Activation Group

HTTP Request

POST /api/v1/general-ledger/ledger-transactions/activation-group/{transactionType}/{revisionId}

📋 Description: Activates a group of ledger transactions based on the specified transaction type and revision ID, facilitating the management of financial records within the general ledger. This operation ensures accurate ledger entries and supports effective transaction processing.

Parameters

Name

In

Type

Required

Description

transactionType

path

string

true

Type of the transaction

revisionId

path

integer(int64)

true

Unique identifier for the revision

body

body

BaseId

true

Request body containing the activation group data for ledger transactions, including details on transaction type and associated financial records for the specified revision.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Ledger Transaction - Fetch By ID

HTTP Request

GET /api/v1/general-ledger/ledger-transactions/{id}

📋 Description: Retrieves detailed information about a specific ledger transaction identified by the provided ID, facilitating access to critical financial records within the general ledger. This operation supports effective account management and transaction analysis.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

LedgerTransactionInfo

Ledger Transaction - Fetch Group By ID

HTTP Request

GET /api/v1/general-ledger/ledger-transactions/group/{id}

📋 Description: Retrieves detailed ledger transactions grouped by the specified identifier, providing insights into financial records associated with ledger entries and accounts. This operation supports effective tracking and analysis of financial activities within the General Ledger domain.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

LedgerTransactionGroupDto

Ledger Transaction - Fetch Operational Exchange Rate Types For Company

HTTP Request

GET /api/v1/general-ledger/ledger-transactions/companies/{companyId}/operational-exchange-rate-types

Parameters

Name

In

Type

Required

Description

companyId

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

OperationalExchangeRateTypesResponseDto

Ledger Transaction - Fetch Latest Ledger Transaction By Application Reference ID

HTTP Request

GET /api/v1/general-ledger/ledger-transactions/application-reference/{applicationReferenceId}

📋 Description: Retrieves ledger transactions associated with a specific application reference ID, providing essential financial records for accurate account management and reporting within the General Ledger domain.

Parameters

Name

In

Type

Required

Description

applicationReferenceId

path

string

true

Unique identifier for the application reference

Responses

Status

Meaning

Description

Schema

200

OK

OK

LedgerTransactionInfo

Ledger Transaction - Account Balance Reports

HTTP Request

GET /api/v1/general-ledger/ledger-transactions/account-balance

📋 Description: Retrieves the current account balance for specified ledger transactions within the General Ledger, providing essential financial records for effective account management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[AccountBalanceReport]

false

none

[Data transfer object representing the financial status of an account, detailing ledger entries and transactions to provide a comprehensive overview of account balances within the General Ledger.]

» accountId

integer(int64)

false

none

Unique identifier for the account

» accountDisplayId

string

false

none

Unique identifier for the account display

» accountCode

string

false

none

Code for the account

» debitBalance

number

false

none

Value for debitBalance field

» creditBalance

number

false

none

Value for creditBalance field

» accountCategory

string

false

none

Category of the account

Enumerated Values

Attribute

Value

accountCategory

BALANCESHEET, PROFITANDLOSS

Ledger Transaction - Delete

HTTP Request

DELETE /api/v1/general-ledger/ledger-transactions

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

None