ResponseWrapperCashVoucherListDto

Wrapper for the response containing the list of cash vouchers.

statusstring

Status of the response

Possible values: [SUCCESS, ERROR]

Example: ERROR/SUCCESS

messagestring

Message describing the response

Example: Request failed/Request successful

codeMessagestring

Code message describing the response

Example: ERR-001/SUC-001

data object

Represents paginated results.

content object[]

The list of items in the current page.

Array [

agencyNamestring

Name of the agency that issued the cash voucher.

Example: Main Agency

cashVoucherFormstring

Form type of the cash voucher.

Example: Form A

formDescriptionstring

Description of the cash voucher form.

Example: Standard cash voucher form

transactionTypeCodestring

Code representing the transaction type associated with the cash voucher.

Example: TX123

transactionTypeDescriptionstring

Description of the transaction type associated with the cash voucher.

Example: Deposit transaction

subscriberAccountNumberstring

Subscriber's account number associated with the cash voucher.

Example: 987654321

subscriberNamestring

Name of the subscriber who owns the cash voucher.

Example: John Doe

subscriberCINstring

Subscriber's CIN (National ID) number.

Example: CIN12345678

cashVoucherNumberstring

Cash voucher number.

Example: BDC123456

effectiveDatestring

Effective date of the cash voucher.

Example: 01-01-2023

durationInMonthsstring

Duration in months of the cash voucher.

Example: 12

amountnumber

Amount associated with the cash voucher.

Example: 1500

formattedAmountstring

Formatted amount of the cash voucher (with currency).

Example: 1,500.00

endDatestring

End date of the cash voucher.

Example: 01-01-2024

interestTypestring

Type of interest associated with the cash voucher.

Example: Fixed

interestTypeDescriptionstring

Description of the interest type.

Example: Fixed rate interest

creditorRatestring

Creditor rate associated with the cash voucher.

Example: 5.0

interestAmountstring

Amount of interest accrued on the cash voucher.

Example: 50.0

interestRatestring

Rate of interest applied to the cash voucher.

Example: 5.0

vatOnIntereststring

VAT applied to the interest amount.

Example: 5.0

statusstring

Current status of the cash voucher.

Example: Active

statusDescriptionstring

Description of the cash voucher status.

Example: Voucher is currently active

reimbursementAccountNumberstring

Reimbursement account number associated with the cash voucher.

Example: 1234567890

reimbursementAccountTitlestring

Reimbursement account title associated with the cash voucher.

Example: Reimbursement Account

reimbursementNamestring

Reimbursement name associated with the cash voucher.

Example: Jane Doe

reimbursementCINstring

CIN of the person responsible for reimbursement.

Example: CIN98765432

reimbursementTransactionTypestring

Transaction type for reimbursement.

Example: Refund

reimbursementTransactionTypeDescriptionstring

Description of the reimbursement transaction type.

Example: Refund transaction

radicalstring

Radical of the cash voucher.

Example: RA123

accountNumberstring

Account number associated with the cash voucher.

Example: 9876543210

maxAmountnumber

Maximum amount for filtering cash vouchers.

Example: 2000

minAmountnumber

Minimum amount for filtering cash vouchers.

Example: 500

startDatestring

Start date for the cash voucher.

Example: 01-01-2023

]

totalElementsint64

The total number of elements across all pages.

Example: 100

totalPagesint32

The total number of pages available.

Example: 10

numberint32

The current page number (zero-based).

Example: 0

sizeint32

The number of items per page.

Example: 10

error object

Detailed information about the error response

codestring

Error code

Example: ERR-142

messagestring

Error message

Example: Resource not found / Internal server error

details object[]

List of error details

Array [

codestring

Error code

Example: ER4001

messagestring

Detailed error message

Example: Invalid input

targetstring

Target of the error

Example: username

]

suggestionsstring[]

List of suggestions for resolving the error

Example: ["Check the resource ID","Ensure the resource exists"]

metaData object

Additional metadata about the error, that could help in debugging

property name*string

Additional metadata about the error, that could help in debugging

Example: {"requestId":"3c5e4cebf39cbc5b","operationId":"66fd4d2ae6b6"}

timestampdate-time

Timestamp of when the response was generated

ResponseWrapperCashVoucherListDto

{
  "status": "ERROR/SUCCESS",
  "message": "Request failed/Request successful",
  "codeMessage": "ERR-001/SUC-001",
  "data": {
    "content": [
      {
        "agencyName": "Main Agency",
        "cashVoucherForm": "Form A",
        "formDescription": "Standard cash voucher form",
        "transactionTypeCode": "TX123",
        "transactionTypeDescription": "Deposit transaction",
        "subscriberAccountNumber": "987654321",
        "subscriberName": "John Doe",
        "subscriberCIN": "CIN12345678",
        "cashVoucherNumber": "BDC123456",
        "effectiveDate": "01-01-2023",
        "durationInMonths": "12",
        "amount": 1500,
        "formattedAmount": "1,500.00",
        "endDate": "01-01-2024",
        "interestType": "Fixed",
        "interestTypeDescription": "Fixed rate interest",
        "creditorRate": "5.0",
        "interestAmount": "50.0",
        "interestRate": "5.0",
        "vatOnInterest": "5.0",
        "status": "Active",
        "statusDescription": "Voucher is currently active",
        "reimbursementAccountNumber": "1234567890",
        "reimbursementAccountTitle": "Reimbursement Account",
        "reimbursementName": "Jane Doe",
        "reimbursementCIN": "CIN98765432",
        "reimbursementTransactionType": "Refund",
        "reimbursementTransactionTypeDescription": "Refund transaction",
        "radical": "RA123",
        "accountNumber": "9876543210",
        "maxAmount": 2000,
        "minAmount": 500,
        "startDate": "01-01-2023"
      }
    ],
    "totalElements": 100,
    "totalPages": 10,
    "number": 0,
    "size": 10
  },
  "error": {
    "code": "ERR-142",
    "message": "Resource not found / Internal server error",
    "details": [
      {
        "code": "ER4001",
        "message": "Invalid input",
        "target": "username"
      }
    ],
    "suggestions": [
      "Check the resource ID",
      "Ensure the resource exists"
    ],
    "metaData": {
      "requestId": "3c5e4cebf39cbc5b",
      "operationId": "66fd4d2ae6b6"
    }
  },
  "timestamp": "2024-07-29T15:51:28.071Z"
}