Ledger Transaction External Info

Update External Posting Info

HTTP Request

PUT /api/v1/general-ledger/ledger-transactions/external-info

📋 Description: This API will update external posting info based on provided ledgerTransactionId or internalDocumentNumber. You need to provide one along with ExternalPostingStatus information.

Parameters

Name

In

Type

Required

Description

body

body

ExternalPostingStatusChangeRequest

true

Request body containing the external information for ledger transactions, including relevant account details and financial record identifiers.

Body Parameters

 1{
 2  "externalPostingStatus": {
 3    "documentNumber": "string",
 4    "objType": "string",
 5    "objKey": "string",
 6    "objSys": "string",
 7    "username": "string",
 8    "status": "NA",
 9    "postingMessage": "string",
10    "taskId": 0
11  },
12  "ledgerTransactionId": 0,
13  "internalDocumentNumber": "string"
14}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ExternalPostingStatusChangeResult

Example Responses

 1{
 2  "changeRequest": {
 3    "externalPostingStatus": {
 4      "documentNumber": "string",
 5      "objType": "string",
 6      "objKey": "string",
 7      "objSys": "string",
 8      "username": "string",
 9      "status": "NA",
10      "postingMessage": "string",
11      "taskId": 0
12    },
13    "ledgerTransactionId": 0,
14    "internalDocumentNumber": "string"
15  },
16  "success": true,
17  "message": "string"
18}

Bulk Update External Posting Status

HTTP Request

PUT /api/v1/general-ledger/ledger-transactions/external-info/bulk

📋 Description: This API will update bulk external posting info based on provided list of ledgerTransactionId or internalDocumentNumber. You need to provide one along with list of ExternalPostingStatus information.

Parameters

Name

In

Type

Required

Description

body

body

ExternalPostingStatusChangeRequest

true

Request body containing a collection of external information related to ledger transactions, including account details and financial records for bulk updates in the General Ledger.

Body Parameters

 1[
 2  {
 3    "externalPostingStatus": {
 4      "documentNumber": "string",
 5      "objType": "string",
 6      "objKey": "string",
 7      "objSys": "string",
 8      "username": "string",
 9      "status": "NA",
10      "postingMessage": "string",
11      "taskId": 0
12    },
13    "ledgerTransactionId": 0,
14    "internalDocumentNumber": "string"
15  }
16]

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "changeRequest": {
 4      "externalPostingStatus": {
 5        "documentNumber": "string",
 6        "objType": "string",
 7        "objKey": "string",
 8        "objSys": "string",
 9        "username": "string",
10        "status": "NA",
11        "postingMessage": "string",
12        "taskId": 0
13      },
14      "ledgerTransactionId": 0,
15      "internalDocumentNumber": "string"
16    },
17    "success": true,
18    "message": "string"
19  }
20]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[ExternalPostingStatusChangeResult]

false

none

[Data transfer object representing the result of a status change for an external posting within the General Ledger, encompassing relevant ledger entries, transactions, accounts, and financial records.]

» changeRequest

ExternalPostingStatusChangeRequest

false

none

Data transfer object representing a request to change the posting status of a ledger entry, facilitating updates to transaction and account records within the General Ledger for accurate financial reporting.

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

»» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

»» internalDocumentNumber

string

false

none

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

» success

boolean

false

none

Boolean flag indicating success status

» message

string

false

none

Descriptive text providing details about the status change of a ledger entry transaction within the financial record.

Enumerated Values

Attribute

Value

status

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