v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Update Journal

This API is used to update a Journal created

put/v2/ledger/journal/{journal_urn}

Path parameters

journal_urnstring required

Decentro Journal URN received in creation response

Headers

client_idstring required

Decentro assigned client_id for the company

client_secretstring required

Decentro assigned client_secret for the company

module_secretstring required

Decentro assigned module_secret for the company

Request body

reference_idstring required

Your unique API reference id

purposestring required

Purpose for updating the Journal

consentboolean required

Consent for updating the journal

statusstring required

Status of the journal. Acceptable values: ACTIVE, INACTIVE, HOLD

Response

200

decentroTxnIdstring

statusstring

responseCodestring

messagestring

Example response

{
  "decentroTxnId": "ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEF",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Transaction successful",
  "data": {
    "transactionStatus": "SUCCESS",
    "transactionDescription": "Journal updated successfully",
    "urn": "JOURNAL001",
    "referenceId": "test_journal_1",
    "name": "Test journal 1",
    "purpose": "this is to create a journal",
    "additionalParameters": {
      "parameter1": "value1",
      "parameter2": "value2"
    },
    "status": "INACTIVE",
    "creationTimestamp": "2022-06-06 21:21:210",
    "lastModificationTimestamp": "2022-06-06 22:22:22"
  }
}