SwissQR bill data. More...

Inherits BaseJavaClass.

Public Member Functions
None	__init__ (self, javaClass)

None	createAndSetCreditorReference (self, str rawReference)
	Creates and sets a ISO11649 creditor reference from a raw string by prefixing the String with "RF" and the modulo 97 checksum. More...

bool	equals (self, SwissQRBill obj)
	Determines whether the specified object is equal to the current object. More...

str	getAccount (self)
	Gets the creditor's account number. More...

List[AlternativeScheme]	getAlternativeSchemes (self)
	Gets the alternative payment schemes. More...

float	getAmount (self)
	Gets the payment amount. More...

str	getBillInformation (self)
	Gets the additional structured bill information. More...

Optional[Address]	getCreditor (self)
	Gets the creditor address. More...

str	getCurrency (self)
	Gets the payment currency. More...

Optional[Address]	getDebtor (self)
	Gets the debtor address. More...

str	getReference (self)
	Gets the creditor payment reference. More...

str	getUnstructuredMessage (self)
	Gets the additional unstructured message. More...

QrBillStandardVersion	getVersion (self)
	Gets the version of the SwissQR bill standard. More...

int	hashCode (self)
	Gets the hash code for this instance. More...

None	init (self)

None	setAccount (self, str value)
	Sets the creditor's account number. More...

None	setAlternativeSchemes (self, List[AlternativeScheme] value)
	Sets the alternative payment schemes. More...

None	setAmount (self, float value)
	Sets the payment amount. More...

None	setBillInformation (self, str value)
	Sets the additional structured bill information. More...

None	setCreditor (self, Address value)
	Sets the creditor address. More...

None	setCurrency (self, str value)
	Sets the payment currency. More...

None	setDebtor (self, Address value)
	Sets the debtor address. More...

None	setReference (self, str value)
	Sets the creditor payment reference. More...

None	setUnstructuredMessage (self, str value)
	Sets the additional unstructured message. More...

None	setVersion (self, QrBillStandardVersion value)
	Sets the version of the SwissQR bill standard. More...

Public Member Functions inherited from BaseJavaClass
def	getJavaClass (self)

str	getJavaClassName (self)

bool	isNull (self)

None	printJavaClassName (self)

None	setJavaClass (self, javaClass)

Static Public Member Functions
List[AlternativeScheme]	convertAlternativeSchemes (javaAlternativeSchemes)

Public Attributes
	creditor

	debtor

Public Attributes inherited from BaseJavaClass
	javaClass

	javaClassName

Detailed Description

SwissQR bill data.

Constructor & Destructor Documentation

◆ init()

None __init__	(	self,
		javaClass
	)

Reimplemented from BaseJavaClass.

Member Function Documentation

◆ convertAlternativeSchemes()

List[AlternativeScheme] convertAlternativeSchemes ( javaAlternativeSchemes )

static

◆ createAndSetCreditorReference()

None createAndSetCreditorReference	(		self,
		str	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

ArgumentException rawReference contains invalid characters.

Parameters

rawReference The raw reference.

◆ equals()

bool equals	(		self,
		SwissQRBill	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

obj	The object to compare with the current object.

◆ getAccount()

str 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.

Returns: :The creditor account number.

◆ getAlternativeSchemes()

List[AlternativeScheme] getAlternativeSchemes ( self )

Gets the alternative payment schemes.

A maximum of two schemes with parameters are allowed.

Returns: :The alternative payment schemes.

◆ getAmount()

float getAmount ( self )

Gets the payment amount.

Valid values are between 0.01 and 999,999,999.99.

Returns: :The payment amount.

◆ getBillInformation()

str getBillInformation ( self )

Gets the additional structured bill information.

Returns: :The structured bill information.

◆ getCreditor()

Optional[Address] getCreditor ( self )

Gets the creditor address.

Returns: :The creditor address.

◆ getCurrency()

str getCurrency ( self )

Gets the payment currency.

Valid values are "CHF" and "EUR".

Returns: :The payment currency.

◆ getDebtor()

Optional[Address] getDebtor ( self )

Gets the debtor address.

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

Returns: :The debtor address.

◆ getReference()

str 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.

Returns: :The creditor payment reference.

◆ getUnstructuredMessage()

str getUnstructuredMessage ( self )

Gets the additional unstructured message.

Returns: :The unstructured message.

◆ getVersion()

QrBillStandardVersion getVersion ( self )

Gets the version of the SwissQR bill standard.

Returns: :The SwissQR bill standard version.

◆ hashCode()

int hashCode ( self )

Gets the hash code for this instance.

Returns: A hash code for the current object.

◆ init()

None init ( self )

Reimplemented from BaseJavaClass.

◆ setAccount()

None setAccount	(		self,
		str	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.

Parameters

:The	creditor account number.

◆ setAlternativeSchemes()

None setAlternativeSchemes	(		self,
		List[AlternativeScheme]	value
	)

Sets the alternative payment schemes.

A maximum of two schemes with parameters are allowed.

Parameters

:The	alternative payment schemes.

◆ setAmount()

None setAmount	(		self,
		float	value
	)

Sets the payment amount.

Valid values are between 0.01 and 999,999,999.99.

Parameters

:The	payment amount.

◆ setBillInformation()

None setBillInformation	(		self,
		str	value
	)

Sets the additional structured bill information.

Parameters

:The	structured bill information.

◆ setCreditor()

None setCreditor	(		self,
		Address	value
	)

Sets the creditor address.

Parameters

:The	creditor address.

◆ setCurrency()

None setCurrency	(		self,
		str	value
	)

Sets the payment currency.

Valid values are "CHF" and "EUR".

Parameters

:The	payment currency.

◆ setDebtor()

None setDebtor	(		self,
		Address	value
	)

Sets the debtor address.

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

Parameters

:The	debtor address.

◆ setReference()

None setReference	(		self,
		str	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.

Parameters

:The	creditor payment reference.

◆ setUnstructuredMessage()

None setUnstructuredMessage	(		self,
		str	value
	)

Sets the additional unstructured message.

Parameters

:The	unstructured message.

◆ setVersion()

None setVersion	(		self,
		QrBillStandardVersion	value
	)

Sets the version of the SwissQR bill standard.

Parameters

:The	SwissQR bill standard version.

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ init()

Member Function Documentation

◆ convertAlternativeSchemes()

◆ createAndSetCreditorReference()

◆ equals()

◆ getAccount()

◆ getAlternativeSchemes()

◆ getAmount()

◆ getBillInformation()

◆ getCreditor()

◆ getCurrency()

◆ getDebtor()

◆ getReference()

◆ getUnstructuredMessage()

◆ getVersion()

◆ hashCode()

◆ init()

◆ setAccount()

◆ setAlternativeSchemes()

◆ setAmount()

◆ setBillInformation()

◆ setCreditor()

◆ setCurrency()

◆ setDebtor()

◆ setReference()

◆ setUnstructuredMessage()

◆ setVersion()

Member Data Documentation

◆ creditor

◆ debtor

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ convertAlternativeSchemes()

◆ createAndSetCreditorReference()

◆ equals()

◆ getAccount()

◆ getAlternativeSchemes()

◆ getAmount()

◆ getBillInformation()

◆ getCreditor()

◆ getCurrency()

◆ getDebtor()

◆ getReference()

◆ getUnstructuredMessage()

◆ getVersion()

◆ hashCode()

◆ init()

◆ setAccount()

◆ setAlternativeSchemes()

◆ setAmount()

◆ setBillInformation()

◆ setCreditor()

◆ setCurrency()

◆ setDebtor()

◆ setReference()

◆ setUnstructuredMessage()

◆ setVersion()

Member Data Documentation

◆ creditor

◆ debtor

◆ init()