Get transaction type

GET 
/TransactionTypes/:transactionTypeCode/:transactionTypeId

Get transaction type

Request

Path Parameters

transactionTypeCode stringrequired

The transaction type code.

transactionTypeId int32required

The unique identifier of the transaction type.

Responses

200

The transaction type with the specified transaction type code.

application/json

Schema

Schema

transactionTypeTitle stringnullablerequired

The display title of the transaction type.

transactionMode int32nullablerequired

The mode of the transaction (e.g., credit, debit).

transactionTypeCode stringnullablerequired

The unique code identifying the transaction type.

transactionTypeId int32nullablerequired

The numeric identifier of the transaction type.

createInfo object

Audit metadata capturing who created this record and when.

actionBy stringnullablerequired

The username or identifier of the user who performed the action.

actionAt date-timerequired

The date and time when the action was performed.

updateInfo object

Audit metadata capturing who last updated this record and when.

actionBy stringnullablerequired

The username or identifier of the user who performed the action.

actionAt date-timerequired

The date and time when the action was performed.

Example (from schema)

{
  "transactionTypeTitle": "string",
  "transactionMode": 0,
  "transactionTypeCode": "string",
  "transactionTypeId": 0,
  "createInfo": {
    "actionBy": "string",
    "actionAt": "2024-07-29T15:51:28.071Z"
  },
  "updateInfo": {
    "actionBy": "string",
    "actionAt": "2024-07-29T15:51:28.071Z"
  }
}

404

A transaction type with the specified transaction type code could not be found.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...