ch.codeblock.qrinvoice.rest.model.PaymentReference Maven / Gradle / Ivy

Go to download
package ch.codeblock.qrinvoice.rest.model;

@javax.annotation.Generated(value = "ch.codeblock.qrinvoice.tools.ch.codeblock.qrinvoice.tools.generator.RestModelGenerator", date = "2024-10-23T15:17:26.661")
public class PaymentReference {

    @javax.validation.constraints.Size(min = 3, max = 4)
    @javax.validation.constraints.NotNull
    @io.swagger.v3.oas.annotations.media.Schema(required = true, description = "Reference type (QR, ISO)
The following codes are permitted:
QRR – QR reference
SCOR – Creditor Reference (ISO 11649)
NON – without reference
Maximum four characters, alphanumeric
Must contain the code QRR where a QR-IBAN is used;
where the IBAN is used, either the SCOR or NON code can be entered", deprecated = false, example = "SCOR")
    @com.fasterxml.jackson.annotation.JsonProperty("referenceType")
    @com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)
    private ch.codeblock.qrinvoice.rest.model.ReferenceTypeEnum referenceType;

    @javax.validation.constraints.Size(min = 0, max = 27)
    @io.swagger.v3.oas.annotations.media.Schema(required = false, description = "Reference number
Structured payment reference
The reference is either a QR reference or a Creditor Reference (ISO 11649)
Maximum 27 characters, alphanumeric;
must be filled if a QR-IBAN is used.
QR reference: 27 characters, numeric, check sum calculation according to Modulo 10 recursive (27th position of the reference)
Creditor Reference (ISO 11649): max 25 characters, alphanumeric
The element may not be filled for the NON reference type.

REST API
On the REST API automatic creation of both QRR and SCOR reference numbers can be used. To do so, wrap the reference number in curly brackets `{42}`. In case of the QRR, customerId can be passed as well, separated by a colon, e.g. `{123456:42}`, whereas 123456 is the customerId", deprecated = false, example = "RF18539007547034")
    @com.fasterxml.jackson.annotation.JsonProperty("reference")
    @com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)
    private java.lang.String reference;

    @io.swagger.v3.oas.annotations.media.Schema(required = false, description = "", deprecated = false, example = "")
    @com.fasterxml.jackson.annotation.JsonProperty("additionalInformation")
    @com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)
    private ch.codeblock.qrinvoice.rest.model.AdditionalInformation additionalInformation;

    public ch.codeblock.qrinvoice.rest.model.ReferenceTypeEnum getReferenceType() {
        return this.referenceType;
    }

    public void setReferenceType(ch.codeblock.qrinvoice.rest.model.ReferenceTypeEnum referenceType) {
        this.referenceType = referenceType;
    }

    public java.lang.String getReference() {
        return this.reference;
    }

    public void setReference(java.lang.String reference) {
        this.reference = reference;
    }

    public ch.codeblock.qrinvoice.rest.model.AdditionalInformation getAdditionalInformation() {
        return this.additionalInformation;
    }

    public void setAdditionalInformation(ch.codeblock.qrinvoice.rest.model.AdditionalInformation additionalInformation) {
        this.additionalInformation = additionalInformation;
    }

}