#ResponseWrapperDiscountDto

Wrapper DTO for responses related to discount information, including status, response code, message, and discount details.

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

DTO representing a discount with associated details.

effects object[]

List of effects (EscompteDto) associated with the discount.

Array [

accountNumberstring

Account number associated with the effect.

Example: 12345678

effectTypestring

Type of the effect (e.g., Bill, Invoice).

Example: Bill

submissionDatestring<date-time>

Date when the effect was submitted.

dueDatestring<date-time>

Due date for the effect.

bordereauNumberstring

Bordereau number associated with the effect.

Example: BD12345

effectNumberstring

Effect number (e.g., Invoice number).

Example: EF12345

thirdPartystring

Third-party identifier associated with the effect.

Example: Company XYZ

amountPerSubmissionnumber<double>

Amount per submission for the effect.

Example: 5000

formattedAmountPerSubmissionstring

Formatted amount per submission.

Example: 5,000.00

currencystring

Currency type for the effect amount.

Example: USD

branchCodestring

Branch code associated with the effect.

Example: 001

accountRadicalstring

Account radical associated with the effect.

Example: 78654382

]

currencystring

Currency for the discount.

Example: USD

totalAmountnumber<double>

Total amount of the discount.

Example: 15000

totalElementinteger<int32>

Total number of elements in the discount.

Example: 5

formattedTotalAmountstring

Formatted total amount of the discount.

Example: 15,000.00

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"}

timestampstring<date-time>

Timestamp of when the response was generated

ResponseWrapperDiscountDto

{
  "status": "ERROR/SUCCESS",
  "message": "Request failed/Request successful",
  "codeMessage": "ERR-001/SUC-001",
  "data": {
    "effects": [
      {
        "accountNumber": "12345678",
        "effectType": "Bill",
        "submissionDate": "2024-07-29T15:51:28.071Z",
        "dueDate": "2024-07-29T15:51:28.071Z",
        "bordereauNumber": "BD12345",
        "effectNumber": "EF12345",
        "thirdParty": "Company XYZ",
        "amountPerSubmission": 5000,
        "formattedAmountPerSubmission": "5,000.00",
        "currency": "USD",
        "branchCode": "001",
        "accountRadical": "78654382"
      }
    ],
    "currency": "USD",
    "totalAmount": 15000,
    "totalElement": 5,
    "formattedTotalAmount": "15,000.00"
  },
  "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"
}