ApiResponseDTOTransactionStatisticWrapperDTO

Standard API response wrapper for all endpoints.

successboolean

Indicates whether the operation was successful

Example: true

data object

Payload returned by the API. The content varies depending on the endpoint.

categoryTransactionStatsDTOList object[]

Array [

categorystring

transactionCountinteger<int64>

totalAmountnumber

totalPercentagenumber

objectivenumber

restnumber

]

transactions object[]

Array [

idinteger<int64>

Unique identifier of the transaction

Example: 1001

amountnumber

Amount of the transaction

Example: 250.75

transactionDatestring<date-time>

Date and time when the transaction occurred

transactionTypestring

Type of transaction (e.g., DEBIT, CREDIT)

Example: DEBIT

descriptionstring

Description or label of the transaction

Example: Grocery shopping

referencestring

Reference number for the transaction

Example: TXN123456789

clientNumberstring

Client number associated with the transaction

Example: CL123456

category object

DTO representing a budget or transaction category assigned to a user.

idinteger<int64>

Unique identifier of the category

Example: 1

userIDstringrequired

ID of the user who owns this category

Example: USR123

codestringrequired

Code identifying the category (e.g., internal or functional code)

Example: FOOD

namestringrequired

Display name of the category

Example: Food & Dining

accountNumberstring

Account number linked to the transaction

Example: FR7612345987650123456789014

]

totalAmountnumber

totalAmountCreditnumber

totalAmountDebitnumber

balancenumber

messagestring

Human-readable message describing the result

Example: Operation completed successfully

ApiResponseDTOTransactionStatisticWrapperDTO
{
  "success": true,
  "data": {
    "categoryTransactionStatsDTOList": [
      {
        "category": "string",
        "transactionCount": 0,
        "totalAmount": 0,
        "totalPercentage": 0,
        "objective": 0,
        "rest": 0
      }
    ],
    "transactions": [
      {
        "id": 1001,
        "amount": 250.75,
        "transactionDate": "2024-07-29T15:51:28.071Z",
        "transactionType": "DEBIT",
        "description": "Grocery shopping",
        "reference": "TXN123456789",
        "clientNumber": "CL123456",
        "category": {
          "id": 1,
          "userID": "USR123",
          "code": "FOOD",
          "name": "Food & Dining"
        },
        "accountNumber": "FR7612345987650123456789014"
      }
    ],
    "totalAmount": 0,
    "totalAmountCredit": 0,
    "totalAmountDebit": 0,
    "balance": 0
  },
  "message": "Operation completed successfully"
}

#ApiResponseDTOTransactionStatisticWrapperDTO

ApiResponseDTOTransactionStatisticWrapperDTO