Aspose.Barcode for Python via Java Generation and Recognition API docs
asposebarcode.ComplexBarcode.SwissQRBill Class Reference

SwissQR bill data. More...

Inherits asposebarcode.Assist.BaseJavaClass.

Public Member Functions

def init (self)
 
def __init__ (self, javaClass)
 
def getVersion (self)
 Gets the version of the SwissQR bill standard. More...
 
def setVersion (self, value)
 Sets the version of the SwissQR bill standard. More...
 
def getAmount (self)
 Gets the payment amount. More...
 
def setAmount (self, value)
 Sets the payment amount. More...
 
def getCurrency (self)
 Gets the payment currency. More...
 
def setCurrency (self, value)
 Sets the payment currency. More...
 
def getAccount (self)
 Gets the creditor's account number. More...
 
def setAccount (self, value)
 Sets the creditor's account number. More...
 
def getCreditor (self)
 Gets the creditor address. More...
 
def setCreditor (self, value)
 Sets the creditor address. More...
 
def getReference (self)
 Gets the creditor payment reference. More...
 
def setReference (self, value)
 Sets the creditor payment reference. More...
 
def createAndSetCreditorReference (self, rawReference)
 Creates and sets a ISO11649 creditor reference from a raw string by prefixing the String with "RF" and the modulo 97 checksum. More...
 
def getDebtor (self)
 Gets the debtor address. More...
 
def setDebtor (self, value)
 Sets the debtor address. More...
 
def getUnstructuredMessage (self)
 Gets the additional unstructured message. More...
 
def setUnstructuredMessage (self, value)
 Sets the additional unstructured message. More...
 
def getBillInformation (self)
 Gets the additional structured bill information. More...
 
def setBillInformation (self, value)
 Sets the additional structured bill information. More...
 
def getAlternativeSchemes (self)
 Gets the alternative payment schemes. More...
 
def setAlternativeSchemes (self, value)
 Sets the alternative payment schemes. More...
 
def equals (self, obj)
 Determines whether the specified object is equal to the current object. More...
 
def hashCode (self)
 Gets the hash code for this instance. More...
 
- Public Member Functions inherited from asposebarcode.Assist.BaseJavaClass
def getJavaClass (self)
 
def setJavaClass (self, javaClass)
 
def getJavaClassName (self)
 
def isNull (self)
 
def printJavaClassName (self)
 

Static Public Member Functions

def convertAlternativeSchemes (javaAlternativeSchemes)
 

Public Attributes

 creditor
 
 debtor
 
- Public Attributes inherited from asposebarcode.Assist.BaseJavaClass
 javaClass
 
 javaClassName
 

Detailed Description

SwissQR bill data.

Constructor & Destructor Documentation

◆ __init__()

def asposebarcode.ComplexBarcode.SwissQRBill.__init__ (   self,
  javaClass 
)

Member Function Documentation

◆ convertAlternativeSchemes()

def asposebarcode.ComplexBarcode.SwissQRBill.convertAlternativeSchemes (   javaAlternativeSchemes)
static

◆ createAndSetCreditorReference()

def asposebarcode.ComplexBarcode.SwissQRBill.createAndSetCreditorReference (   self,
  rawReference 
)

Creates and sets a ISO11649 creditor reference from a raw string by prefixing the String with "RF" and the modulo 97 checksum.

Whitespace is removed from the reference

Exceptions
ArgumentExceptionrawReference contains invalid characters.
Parameters
rawReferenceThe raw reference.

◆ equals()

def asposebarcode.ComplexBarcode.SwissQRBill.equals (   self,
  obj 
)

Determines whether the specified object is equal to the current object.

Returns
true if the specified object is equal to the current object; otherwise, false.
Parameters
objThe object to compare with the current object.

◆ getAccount()

def asposebarcode.ComplexBarcode.SwissQRBill.getAccount (   self)

Gets the creditor's account number.

Account numbers must be valid IBANs of a bank of Switzerland or Liechtenstein. Spaces are allowed in the account number. Value: The creditor account number.

◆ getAlternativeSchemes()

def asposebarcode.ComplexBarcode.SwissQRBill.getAlternativeSchemes (   self)

Gets the alternative payment schemes.

A maximum of two schemes with parameters are allowed. Value: The alternative payment schemes.

◆ getAmount()

def asposebarcode.ComplexBarcode.SwissQRBill.getAmount (   self)

Gets the payment amount.

Valid values are between 0.01 and 999,999,999.99. Value: The payment amount.

◆ getBillInformation()

def asposebarcode.ComplexBarcode.SwissQRBill.getBillInformation (   self)

Gets the additional structured bill information.

Value: The structured bill information.

◆ getCreditor()

def asposebarcode.ComplexBarcode.SwissQRBill.getCreditor (   self)

Gets the creditor address.

Value: The creditor address.

◆ getCurrency()

def asposebarcode.ComplexBarcode.SwissQRBill.getCurrency (   self)

Gets the payment currency.

Valid values are "CHF" and "EUR". Value: The payment currency.

◆ getDebtor()

def asposebarcode.ComplexBarcode.SwissQRBill.getDebtor (   self)

Gets the debtor address.

The debtor is optional. If it is omitted, both setting this field to null or setting an address with all null or empty values is ok. Value: The debtor address.

◆ getReference()

def asposebarcode.ComplexBarcode.SwissQRBill.getReference (   self)

Gets the creditor payment reference.

The reference is mandatory for SwissQR IBANs, i.e.IBANs in the range CHxx30000xxxxxx through CHxx31999xxxxx. If specified, the reference must be either a valid SwissQR reference (corresponding to ISR reference form) or a valid creditor reference according to ISO 11649 ("RFxxxx"). Both may contain spaces for formatting. Value: The creditor payment reference.

◆ getUnstructuredMessage()

def asposebarcode.ComplexBarcode.SwissQRBill.getUnstructuredMessage (   self)

Gets the additional unstructured message.

Value: The unstructured message.

◆ getVersion()

def asposebarcode.ComplexBarcode.SwissQRBill.getVersion (   self)

Gets the version of the SwissQR bill standard.

Value: The SwissQR bill standard version.

◆ hashCode()

def asposebarcode.ComplexBarcode.SwissQRBill.hashCode (   self)

Gets the hash code for this instance.

Returns
A hash code for the current object.

◆ init()

def asposebarcode.ComplexBarcode.SwissQRBill.init (   self)

◆ setAccount()

def asposebarcode.ComplexBarcode.SwissQRBill.setAccount (   self,
  value 
)

Sets the creditor's account number.

Account numbers must be valid IBANs of a bank of Switzerland or Liechtenstein. Spaces are allowed in the account number. Value: The creditor account number.

◆ setAlternativeSchemes()

def asposebarcode.ComplexBarcode.SwissQRBill.setAlternativeSchemes (   self,
  value 
)

Sets the alternative payment schemes.

A maximum of two schemes with parameters are allowed. Value: The alternative payment schemes.

◆ setAmount()

def asposebarcode.ComplexBarcode.SwissQRBill.setAmount (   self,
  value 
)

Sets the payment amount.

Valid values are between 0.01 and 999,999,999.99. Value: The payment amount.

◆ setBillInformation()

def asposebarcode.ComplexBarcode.SwissQRBill.setBillInformation (   self,
  value 
)

Sets the additional structured bill information.

Value: The structured bill information.

◆ setCreditor()

def asposebarcode.ComplexBarcode.SwissQRBill.setCreditor (   self,
  value 
)

Sets the creditor address.

Value: The creditor address.

◆ setCurrency()

def asposebarcode.ComplexBarcode.SwissQRBill.setCurrency (   self,
  value 
)

Sets the payment currency.

Valid values are "CHF" and "EUR". Value: The payment currency.

◆ setDebtor()

def asposebarcode.ComplexBarcode.SwissQRBill.setDebtor (   self,
  value 
)

Sets the debtor address.

The debtor is optional. If it is omitted, both setting this field to null or setting an address with all null or empty values is ok. Value: The debtor address.

◆ setReference()

def asposebarcode.ComplexBarcode.SwissQRBill.setReference (   self,
  value 
)

Sets the creditor payment reference.

The reference is mandatory for SwissQR IBANs, i.e.IBANs in the range CHxx30000xxxxxx through CHxx31999xxxxx. If specified, the reference must be either a valid SwissQR reference (corresponding to ISR reference form) or a valid creditor reference according to ISO 11649 ("RFxxxx"). Both may contain spaces for formatting. Value: The creditor payment reference.

◆ setUnstructuredMessage()

def asposebarcode.ComplexBarcode.SwissQRBill.setUnstructuredMessage (   self,
  value 
)

Sets the additional unstructured message.

Value: The unstructured message.

◆ setVersion()

def asposebarcode.ComplexBarcode.SwissQRBill.setVersion (   self,
  value 
)

Sets the version of the SwissQR bill standard.

Value: The SwissQR bill standard version.

Member Data Documentation

◆ creditor

asposebarcode.ComplexBarcode.SwissQRBill.creditor

◆ debtor

asposebarcode.ComplexBarcode.SwissQRBill.debtor