ApiResponseEntityStatement

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wordline/main/json-schema/wordline-api-response-entity-statement-schema.json",
  "title": "ApiResponseEntityStatement",
  "description": "Issuer response entity",
  "x-generated": "2026-10-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wordline-account-statement-api-openapi.yml#/components/schemas/ApiResponseEntityStatement",
  "x-wl-api-response": true,
  "type": "object",
  "required": [
    "responseMetadata"
  ],
  "properties": {
    "responseMetadata": {
      "description": "Response metadata",
      "allOf": [
        {
          "$ref": "#/$defs/ResponseMetadata"
        }
      ]
    },
    "data": {
      "description": "Response data",
      "allOf": [
        {
          "$ref": "#/$defs/Statement"
        }
      ]
    }
  },
  "$defs": {
    "AccountIdentifier": {
      "type": "object",
      "properties": {
        "accountReference": {
          "type": "string",
          "description": "Account reference is to identify the Account calculated by the system (algorithm is configurable per issuer). Either the account number or the issuerAccountExternalReference is provided, or, if both are provided then only the account number is used."
        },
        "issuerAccountExternalReference": {
          "type": "string",
          "description": "Issuer account external reference is to identify the Account. Either the account number or the issuerAccountExternalReference is provided, or, if both are provided then only the account number is used. Algorithm configurable by issuer, can be generated by the system if there is an externalReferenceGeneratorAlgorithm."
        }
      },
      "title": "AccountIdentifier"
    },
    "Amount": {
      "type": "object",
      "required": [
        "value",
        "exponent",
        "isoCode"
      ],
      "properties": {
        "value": {
          "type": "integer",
          "format": "int64",
          "description": "Integer amount value. Ex. if it is two hundred euros and 17 cents, then amount value is 20017 (exponent = 2 digits for currency=EUR)"
        },
        "exponent": {
          "type": "integer",
          "format": "int32",
          "description": "Exponent of Amount. Number of decimal digits."
        },
        "isoCode": {
          "type": "string",
          "description": "Currency code of amount\nThe currency in ISO4217 alphabetic format.\nExample: EUR for Euro"
        }
      },
      "title": "Amount"
    },
    "CycleInformation": {
      "type": "object",
      "description": "Dates related to the closure calendar for the open closure cycle",
      "properties": {
        "cycleStartDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date when the cycle is opened"
        },
        "cycleClosureDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date when the open cycle is closed"
        },
        "statementGenerationDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date when the statement is produced for the cycle"
        },
        "directDebitIssuingDate": {
          "type": "string",
          "format": "date-time",
          "description": "Direct debit issuing date of the cycle"
        },
        "directDebitDueDate": {
          "type": "string",
          "format": "date-time",
          "description": "Direct debit due date of the cycle"
        },
        "gracePeriodEndDate": {
          "type": "string",
          "format": "date-time",
          "description": "Grace period end date of the cycle"
        },
        "dueDateForSelfPayer": {
          "type": "string",
          "format": "date-time",
          "description": "Due date for self payer of the cycle"
        },
        "cycleDueDate": {
          "type": "string",
          "format": "date-time",
          "description": "Due date of the cycle, used for monitoring process (delinquency)"
        },
        "statementEffectiveStartDate": {
          "type": "string",
          "format": "date",
          "description": "Effective start date of the statement period.\n\t\t\t\t\tExample :\n\t\tCycle closure is on 28th of each month at 20.00 PM\n\t\tIf closure on 28/08,\n\t\t- For August Statement:  statementEffectiveStartDate = 29/07/2025 and statementEffectiveEndDate = 28/08/2025]\n\t\t- For September Statement : statementEffectiveStartDate = 29/08/2025 and statementEffectiveEndDate = 28/09/2025"
        },
        "statementEffectiveEndDate": {
          "type": "string",
          "format": "date",
          "description": "Effective end date of the statement period.\n\t\t\t\t\tExample :\n\t\tCycle closure is on 28th of each month at 20.00 PM\n\t\tIf closure on 28/08,\n\t\t- For August Statement:  statementEffectiveStartDate = 29/07/2025 and statementEffectiveEndDate = 28/08/2025]\n\t\t- For September Statement : statementEffectiveStartDate = 29/08/2025 and statementEffectiveEndDate = 28/09/2025"
        }
      },
      "title": "CycleInformation"
    },
    "Links": {
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "type": "string",
          "description": "Service method URL"
        },
        "next": {
          "type": "string",
          "description": "URL pagination query parameter next page"
        }
      },
      "title": "Links"
    },
    "LoyaltyPoint": {
      "type": "object",
      "properties": {
        "unit": {
          "type": "string",
          "description": " Unit in which the loyalty points are expressed. Defined by Bonus/Loyalty program (can be currency, points...) (optional)."
        },
        "cumulatedValue": {
          "type": "integer",
          "format": "int64",
          "description": "Total number of loyalty points (optional)."
        }
      },
      "title": "LoyaltyPoint"
    },
    "ReprintHistory": {
      "type": "object",
      "properties": {
        "requestedDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date of the reprinting request (mandatory)"
        },
        "origin": {
          "type": "string",
          "description": "Origin used when the reprinting of the statement was requested."
        },
        "username": {
          "type": "string",
          "description": "Name of the user who requested to reprint the statement"
        }
      },
      "title": "ReprintHistory"
    },
    "ResponseMetadata": {
      "type": "object",
      "required": [
        "correlationId",
        "responseDateTime",
        "statusCode",
        "statusMessage"
      ],
      "properties": {
        "correlationId": {
          "type": "string",
          "description": "Correlation Identifier"
        },
        "links": {
          "description": "Metadata Links",
          "allOf": [
            {
              "$ref": "#/$defs/Links"
            }
          ]
        },
        "statusMessage": {
          "type": "string",
          "description": "Executed REST API status message"
        },
        "statusCode": {
          "type": "integer",
          "format": "int32",
          "description": "HTTP status code"
        },
        "responseDateTime": {
          "type": "string",
          "description": "Timestamp when response date was generated"
        },
        "timeTakenMs": {
          "type": "integer",
          "format": "int64",
          "description": "Wall clock time required from service to generate the response"
        }
      },
      "title": "ResponseMetadata"
    },
    "Statement": {
      "type": "object",
      "properties": {
        "issuerId": {
          "type": "string",
          "description": "Issuer identifier (unique per platform)"
        },
        "accountIdentifier": {
          "description": "Refer to Account.accountIdentifier",
          "allOf": [
            {
              "$ref": "#/$defs/AccountIdentifier"
            }
          ]
        },
        "cycleClosureDate": {
          "type": "string",
          "format": "date-time",
          "description": "Cycle closure date (mandatory)"
        },
        "reprintHistory": {
          "type": "array",
          "description": "Historic data of reprinting if any (optional).\n_Embedded property, only filled when available for the endpoint and explicitly requested in the 'embed' query parameter._",
          "items": {
            "$ref": "#/$defs/ReprintHistory"
          }
        },
        "creationDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date when the statement is generated"
        },
        "paymentDueDate": {
          "type": "string",
          "format": "date-time",
          "description": "Deprecated"
        },
        "directDebitAmount": {
          "description": "Amount of the direct debit that is issued for payment when the payment mode is autopayment (direct debit).\nDepending on the issuer configuration, the direct Debit Amount can be different from the amount calculated at the cycle closure date (field theoricDirectDebitAmount) if credit operations (reversal, credit voucher…) are posted to the account between the cycle closure date and the date the direct debit is issued.",
          "allOf": [
            {
              "$ref": "#/$defs/Amount"
            }
          ]
        },
        "theoricDirectDebitAmount": {
          "description": "Direct debit amount calculated at the cycle closure date when the payment mode is autopayment (direct debit) and depending on the payment conditions.",
          "allOf": [
            {
              "$ref": "#/$defs/Amount"
            }
          ]
        },
        "cycleBalance": {
          "description": "Balance amount for the statement",
          "allOf": [
            {
              "$ref": "#/$defs/Amount"
            }
          ]
        },
        "previousCycleBalance": {
          "description": "Balance amount of the previous cyclic closure (start balance of the statement).\nNot provided for a non-closed cycle.",
          "allOf": [
            {
              "$ref": "#/$defs/Amount"
            }
          ]
        },
        "totalOfPayment": {
          "description": "Sum of all payment operations received during the cycle.",
          "allOf": [
            {
              "$ref": "#/$defs/Amount"
            }
          ]
        },
        "loyaltyPoints": {
          "type": "array",
          "description": "Refer to LoyaltyPoint.loyaltyPoints",
          "items": {
            "$ref": "#/$defs/LoyaltyPoint"
          }
        },
        "previousCycleClosureDate": {
          "type": "string",
          "format": "date-time",
          "description": "The closure date of the previous cycle (optional)"
        },
        "nextCycleClosureDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date of the next cycle closure (optional)"
        },
        "amountDue": {
          "description": "Minimum payment amount calculated by our system depending  on the payment conditions of the customer (full payer/partial payer) the customer has to pay to reimburse his debt.",
          "allOf": [
            {
              "$ref": "#/$defs/Amount"
            }
          ]
        },
        "initialPastAmountDue": {
          "description": "Remaining amount due of the previous cycle, set at cycle closure (optional, no past amount due for the first cycle or if the amount due was fully repaid for during the previous cycle).",
          "allOf": [
            {
              "$ref": "#/$defs/Amount"
            }
          ]
        },
        "initialRemainingAmountDue": {
          "description": "Sum of the amountDue (minimum payment amount) of the cycle and the initialPastAmountDue (optional).",
          "allOf": [
            {
              "$ref": "#/$defs/Amount"
            }
          ]
        },
        "statementDuplicatedForCompany": {
          "type": "boolean",
          "description": "Indicates if the company receives a duplicate for statement generated by other paying accounts in the corporate contract"
        },
        "iban": {
          "type": "string",
          "description": "International Bank Account Number of the customer (debtor)"
        },
        "payingAccountIdentifier": {
          "description": "The reference of paying account",
          "allOf": [
            {
              "$ref": "#/$defs/AccountIdentifier"
            }
          ]
        },
        "cycleInformation": {
          "description": "Dates related to the closure calendar for the closure cycle",
          "allOf": [
            {
              "$ref": "#/$defs/CycleInformation"
            }
          ]
        }
      },
      "title": "Statement"
    }
  }
}