Connectors Reference

PDF4me SwissQR

PDF4me SwissQR gives you functionalities like create SwissQR bill on your PDF document, split by SwissQR Code and Read SwissQR Code as Json on your PDF file.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

CreateSwissQrBill_V1 ([Optional]CreateSwissQrBill_V1ParameterBody body)

Create SwissQR Bill

ReadSwissQrBill_V1 ([Optional]ReadSwissQrBill_V1ParameterBody body)

Read SwissQR Code

SplitDocBySwissQrCode_V1 ([Optional]SplitDocBySwissQrCode_V1ParameterBody body)

Split Document by SwissQR Code

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

CreateSwissQrBill_V1ParameterBody

 

ReadSwissQrBill_V1ParameterBody

 

SplitDocBySwissQrCode_V1ParameterBody

 

SplitDocBySwissQrCode_V1Response

 

 

Actions:

CreateSwissQrBill_V1

Summary: Create SwissQR Bill

Description: Create the SwissQR bill payment part with your PDF document. https://developer.pdf4me.com/docs/api/swiss-qr/swissqrapi/

 

Syntax:

PDF4meSwissQR.CreateSwissQrBill_V1 ([Optional]CreateSwissQrBill_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateSwissQrBill_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me API response

 

ReadSwissQrBill_V1

Summary: Read SwissQR Code

Description: Read-out Billing Data from SwissQR Bill. https://developer.pdf4me.com/docs/api/swiss-qr/scan-swiss-qr-bill/

 

Syntax:

PDF4meSwissQR.ReadSwissQrBill_V1 ([Optional]ReadSwissQrBill_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ReadSwissQrBill_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me API response

 

SplitDocBySwissQrCode_V1

Summary: Split Document by SwissQR Code

Description: Split the PDF document by barcode types and filters. https://developer.pdf4me.com/docs/api/microsoft-flow/split-by-barcode-flow-connector/

 

Syntax:

PDF4meSwissQR.SplitDocBySwissQrCode_V1 ([Optional]SplitDocBySwissQrCode_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

SplitDocBySwissQrCode_V1ParameterBody

 

 

False

 

Returns:

          Type:SplitDocBySwissQrCode_V1Response

 


 

CreateSwissQrBill_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

amount

string

 

Amount, The amount element is to be entered without leading zeroes, including decimal separators and two decimal places.

av1Parameters

string

 

Alternative scheme parameter, Maximum 100 characters permitted.

av2Parameters

string

 

Alternative scheme parameter, Maximum 100 characters permitted.

billingInfo

string

 

BillingInfo, Maximum 140 characters permitted.

crAddressType

string

 

The creditor's address type is specified using a code S or K.  Values: [S, K]

crCity

string

 

The creditor's Town/City with max 35 characters length.

crName

string

 

The creditor's name or company according to the account name.

crPostalCode

string

 

The creditor's PostalCode with max 16 characters length.

crStreetOrAddressLine1

string

 

The creditor's address line 1 with max 70 characters length.

crStreetOrAddressLine2

string

 

The creditor's address line 2. For S type 16 characters, K type 70 characters length permitted.

currency

string

 

The payment currency, Only CHF and EUR are permitted.  Values: [CHF, EUR]

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

iban

string

 

IBAN or QR-IBAN of the creditor. Max 21 characters with CH or LI only.

languageType

string

 

Choose the language type.  Values: [German, French, Italian, English]

reference

string

 

Reference, Maximum 27 characters permitted.

referenceType

string

 

Reference Type.  Values: [QRR, SCOR, NON]

seperatorLine

string

 

Choose the Seperator Line.  Values: [LineWithScissor, Line, None]

udAddressType

string

 

The Ultimate Debtor's address type is specified using a code S or K.  Values: [S, K]

udCity

string

 

The Ultimate Debtor's Town/City with max 35 characters length.

udName

string

 

The Ultimate Debtor's name or company according to the account name.

udPostalCode

string

 

The Ultimate Debtor's PostalCode with max 16 characters length.

udStreetOrAddressLine1

string

 

The Ultimate Debtor's address line 1 with max 70 characters length.

udStreetOrAddressLine2

string

 

The Ultimate Debtor's address line 2. For S type 16 characters, K type 70 characters length permitted.

unstructuredMessage

string

 

UnstructuredMessage, Maximum 140 characters permitted.

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Input file name from the source

 


 

ReadSwissQrBill_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Name of the file from the source

 


 

SplitDocBySwissQrCode_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

barcodeFilter

string

 

Choose the QrCode filter  Values: [startsWith, endsWith, contains, exact]

barcodeString

string

 

Type the QrCode data to split

barcodeType

string

 

Choose the QrCode type  Values: [any, datamatrix, qrcode]

docContent

string(byte)

 

The content of the input file

document

Document

 

document

splitBarcodePage

string

 

Choose the Split QrCode Page  Values: [before, after]

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Name of the file

 


 

SplitDocBySwissQrCode_V1Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

splitedDocuments

array of (SplitedDocumentsItem)

 

splitedDocuments

 

SplitedDocumentsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileName

string

 

Output file name

streamFile

string(byte)

 

Output file content