Enrichment

Send Enrichment Request For Ledger Transaction

HTTP Request

POST /api/v1/general-ledger/ledger-transactions/enrich/{ledgerTransactionId}

📋 Description: This API will send the enrichment request for the requested Ledger Transaction to all integrated applications

Parameters

Name

In

Type

Required

Description

ledgerTransactionId

path

integer(int64)

true

Unique identifier for the ledger transaction

Responses

Status

Meaning

Description

Schema

200

OK

OK

LedgerTransactionEnrichmentRequestResult

Example Responses

 1{
 2  "applicationEnrichmentResult": [
 3    {
 4      "application": "NLA",
 5      "requestStatus": "SENT",
 6      "message": "string"
 7    }
 8  ],
 9  "ledgerTransactionId": 0
10}

Ledger Transaction Enrichment For Nlm Application References

HTTP Request

POST /api/v1/general-ledger/ledger-transactions/enrich/nre

📋 Description: This API will enrich the ledger Ledger Transactions with NLM Specific References

Parameters

Name

In

Type

Required

Description

body

body

LedgerTransactionEnrichmentRequestNre

true

Request body containing the financial record data for ledger transactions, including account details and transaction attributes for enrichment purposes.

Body Parameters

 1[
 2  {
 3    "customReferences": [
 4      {
 5        "key": "string",
 6        "dataType": "STRING",
 7        "value": 0
 8      }
 9    ],
10    "ledgerEntryEnrichments": [
11      {
12        "customReferences": [
13          {
14            "key": "string",
15            "dataType": "STRING",
16            "value": 0
17          }
18        ],
19        "ledgerEntryId": 0
20      }
21    ],
22    "status": "PENDING",
23    "message": "string",
24    "ledgerTransactionId": 0,
25    "enrichmentRequestId": 0,
26    "nreReferences": {
27      "id": 0,
28      "premise": {
29        "id": 0,
30        "displayId": "string"
31      },
32      "location": {
33        "id": 0,
34        "displayId": "string"
35      },
36      "lease": {
37        "id": 0,
38        "displayId": "string"
39      },
40      "ledgerTransactionId": 0
41    }
42  }
43]

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  {
3    "ledgerTransactionId": 0,
4    "status": "PENDING",
5    "message": "string"
6  }
7]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[LedgerTransactionApplicationEnrichmentResult]

false

none

[Data transfer object representing the enriched results of a ledger transaction application, capturing essential details related to ledger entries, transactions, accounts, and financial records for enhanced financial analysis and reporting.]

» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

» status

string

false

none

Status of the resource

» message

string

false

none

Detailed message providing contextual information related to the ledger entry, transaction, or financial record.

Enumerated Values

Attribute

Value

status

ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED

Ledger Transaction Enrichment For Nla Application References

HTTP Request

POST /api/v1/general-ledger/ledger-transactions/enrich/nla

📋 Description: This API will enrich the Ledger Transactions with NLA Specific References

Parameters

Name

In

Type

Required

Description

body

body

LedgerTransactionEnrichmentRequestNla

true

Request body containing the financial record data for ledger transactions, including account details and transaction attributes for enrichment purposes.

Body Parameters

 1[
 2  {
 3    "customReferences": [
 4      {
 5        "key": "string",
 6        "dataType": "STRING",
 7        "value": 0
 8      }
 9    ],
10    "ledgerEntryEnrichments": [
11      {
12        "customReferences": [
13          {
14            "key": "string",
15            "dataType": "STRING",
16            "value": 0
17          }
18        ],
19        "ledgerEntryId": 0
20      }
21    ],
22    "status": "PENDING",
23    "message": "string",
24    "ledgerTransactionId": 0,
25    "enrichmentRequestId": 0,
26    "nlaReferences": {
27      "id": 0,
28      "contract": {
29        "id": 0,
30        "displayId": "string"
31      },
32      "leaseComponent": {
33        "id": 0,
34        "displayId": "string"
35      },
36      "activationGroup": {
37        "id": 0,
38        "displayId": "string"
39      },
40      "unit": {
41        "id": 0,
42        "displayId": "string"
43      },
44      "contractExternalId": "string",
45      "journalId": 0,
46      "activationGroupRevisionId": 0,
47      "ledgerTransactionId": 0
48    }
49  }
50]

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  {
3    "ledgerTransactionId": 0,
4    "status": "PENDING",
5    "message": "string"
6  }
7]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[LedgerTransactionApplicationEnrichmentResult]

false

none

[Data transfer object representing the enriched results of a ledger transaction application, capturing essential details related to ledger entries, transactions, accounts, and financial records for enhanced financial analysis and reporting.]

» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

» status

string

false

none

Status of the resource

» message

string

false

none

Detailed message providing contextual information related to the ledger entry, transaction, or financial record.

Enumerated Values

Attribute

Value

status

ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED

Enrichment job

HTTP Request

POST /api/v1/general-ledger/ledger-transactions/enrich/job

📋 Description: This API will enrich all the failed or stuck ledger transactions

Parameters

Name

In

Type

Required

Description

message

query

string

true

Textual content of the message that provides additional context or details related to the ledger transaction being enriched in the General Ledger.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Send Enrichment Request For Ledger Transactions In Bulk

HTTP Request

POST /api/v1/general-ledger/ledger-transactions/enrich/bulk

📋 Description: This API will send the enrichment request for the requested Ledger Transactions in Bulk to all integrated applications

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing bulk ledger transaction enrichment data, including details of ledger entries, associated accounts, and relevant financial records.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "applicationEnrichmentResult": [
 4      {
 5        "application": "NLA",
 6        "requestStatus": "SENT",
 7        "message": "string"
 8      }
 9    ],
10    "ledgerTransactionId": 0
11  }
12]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[LedgerTransactionEnrichmentRequestResult]

false

none

[Data transfer object representing the results of an enriched ledger transaction request, including details pertinent to ledger entries, associated accounts, and overall financial records.]

» applicationEnrichmentResult

[ApplicationEnrichmentRequestResult]

false

none

List of applicationEnrichmentResult items

»» application

string

false

none

Represents the specific application associated with a ledger entry, facilitating accurate tracking of transactions and financial records within the General Ledger.

»» requestStatus

string

false

none

Status of the request

»» message

string

false

none

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

» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

Enumerated Values

Attribute

Value

application

ACCOUNT_PAYABLE, ACCOUNT_RECEIVABLE, GENERAL_LEDGER, NLA, NRE, REPAIR_MAINTENANCE

requestStatus

FAILED, SENT

Ledger Transaction Enrichment For Ap Application References

HTTP Request

POST /api/v1/general-ledger/ledger-transactions/enrich/ap

📋 Description: This API will enrich the ledger Ledger Transactions with AP Specific References

Parameters

Name

In

Type

Required

Description

body

body

LedgerTransactionEnrichmentRequestAp

true

Request body containing the ledger transaction enrichment data, including details on ledger entries, associated accounts, and relevant financial records.

Body Parameters

 1[
 2  {
 3    "customReferences": [
 4      {
 5        "key": "string",
 6        "dataType": "STRING",
 7        "value": 0
 8      }
 9    ],
10    "ledgerEntryEnrichments": [
11      {
12        "customReferences": [
13          {
14            "key": "string",
15            "dataType": "STRING",
16            "value": 0
17          }
18        ],
19        "ledgerEntryId": 0
20      }
21    ],
22    "status": "PENDING",
23    "message": "string",
24    "ledgerTransactionId": 0,
25    "enrichmentRequestId": 0,
26    "apReferences": {
27      "id": 0,
28      "invoice": {
29        "id": 0,
30        "displayId": "string",
31        "name": "string"
32      },
33      "vendor": {
34        "id": 0,
35        "displayId": "string",
36        "name": "string"
37      },
38      "ledgerTransactionId": 0
39    }
40  }
41]

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  {
3    "ledgerTransactionId": 0,
4    "status": "PENDING",
5    "message": "string"
6  }
7]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[LedgerTransactionApplicationEnrichmentResult]

false

none

[Data transfer object representing the enriched results of a ledger transaction application, capturing essential details related to ledger entries, transactions, accounts, and financial records for enhanced financial analysis and reporting.]

» ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

» status

string

false

none

Status of the resource

» message

string

false

none

Detailed message providing contextual information related to the ledger entry, transaction, or financial record.

Enumerated Values

Attribute

Value

status

ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED