Encodian - Barcode
The 'Encodian - Barcode' connector provides an extensive collection of actions which facilitate creating and reading barcodes / QR codes covering all common file formats. This connector is one of nine connectors which form 'Encodian Flowr'; a complete solution for end-to-end document automation used by over 75,000 organizations. 'Encodian Flowr' powers everything from templated document creation to complex document manipulation.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | All Power Automate regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Encodian Support |
| URL | https://support.encodian.com |
| support@encodian.com |
| Connector Metadata | |
|---|---|
| Publisher | Encodian |
| Website | https://www.encodian.com |
| Privacy policy | https://support.encodian.com/hc/en-gb/articles/360010885513-Privacy-Policy |
| Categories | Content and Files;Collaboration |
Encodian 'Flowr' Barcode for Power Automate
The 'Encodian Flowr Barcode' connector provide enterprise grade and simple to use Power Automate actions for creating both barcodes and QR codes, it also provides actions for reading and extracting barcode / QR code values from images and files (PDF and Microsoft Word).
The Encodian 'Flowr' Barcode connector is supported by Power Automate, Azure Logic Apps and Power Apps.
Register Account
An Encodian subscription is required to use the Encodian 'Flowr' Barcode connector.
Complete the sign-up form to register for a 30-day trial and obtain an API Key
Click here for a step by step guide on how to create an Encodian connection in Power Automate
Support
Contact Encodian Support to request assistance
Encodian action documentation can be found here, and example flows can be found here
Further Information
Visit Encodian website for subscription plan pricing.
Once your 30-day trial expires, your Encodian subscription is automatically transitioned to Encodian's 'Free' subscription tier unless a paid plan has been purchased.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | Get an API Key - https://www.encodian.com/apikey/ | True |
| Region | string |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
Barcode - Create
Create a Barcode in the specified image format - https://support.encodian.com/hc/en-gb/articles/360006165457-Create-Barcode
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Barcode Type
|
barcodeTypeParameter | string |
Set the barcode type |
|
|
operation
|
operation | dynamic |
Request object, refer to schema definition: DtoResponseCreateBarcode |
Returns
Barcode - Read from Document
Read barcode(s) from the document provided - https://support.encodian.com/hc/en-gb/articles/360006170938-Read-Barcode-Document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Type
|
fileType | string |
Select the source document format. |
|
|
File Content
|
FileContent | byte |
The file content of the source file |
|
|
Confidence
|
barcodeReadConfidence | string |
Set the confidence level for barcode detection |
|
|
Quality
|
barcodeReadQuality | string |
Set the quality level for barcode detection |
|
|
Start Page
|
startPage | integer |
Set the page number to begin reading from |
|
|
End Page
|
endPage | integer |
Set the page number to end reading on |
|
|
Remove Control Characters
|
barcodeRemoveControlChars | boolean |
Set whether recognised control characters should be removed |
Returns
Barcode - Read from Image
Read a barcode from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170918-Read-Barcode-Image
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source image file |
|
Image Format
|
barcodeImageFormat | True | string |
Select the image format for the barcode image provided |
|
Confidence
|
barcodeReadConfidence | string |
Set the confidence level for barcode detection |
|
|
Remove Control Characters
|
barcodeRemoveControlChars | boolean |
Set whether recognised control characters should be removed |
Returns
QR Code - Create
Create a QR code in the specified image format - https://support.encodian.com/hc/en-gb/articles/360005178237-Create-QR-Code
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Barcode Data
|
barcodeData | True | string |
Set the string value used to generate the QR barcode. |
|
Image Format
|
barcodeImageFormat | True | string |
Set the image format for barcode. |
|
Height
|
height | integer |
Set the QR code height (pixels). |
|
|
Width
|
width | integer |
Set the QR code width (pixels). |
|
|
Auto Size Mode
|
sizeMode | string |
Set the QR auto size mode, use 'Nearest' to assure QR code readability |
|
|
Fore Color
|
foreColor | string |
Set the QR code foreground color (HTML Color #000000) |
|
|
Back Color
|
backColor | string |
Set the QR code background color (HTML Color #FFFFFF) |
|
|
Visible Border
|
visibleBorder | boolean |
Set whether the QR code border is visible |
|
|
Border Color
|
borderColor | string |
Set the QR code border color (HTML Color #000000) |
|
|
Border Style
|
borderStyle | string |
Set the QR code border style |
|
|
Border Width
|
borderWidth | integer |
Set the QR code border width in pixels |
|
|
Resolution
|
resolution | integer |
Set the QR code border image resolution (dpi) |
|
|
Encode Mode
|
encodeMode | string |
Set the QR code encode mode |
|
|
Encode Type
|
encodeType | string |
Set the QR code encode type |
|
|
Encoding Type
|
textEncodingType | string |
Set the QR code text encoding type |
|
|
Logo Filename
|
logoFileName | string |
The filename of the source logo file, the file extension is mandatory: 'file.png' and not 'file' |
|
|
Logo File Content
|
logoFileContent | byte |
The file content of the source logo file |
|
|
Logo Position
|
logoPosition | string |
Set the position of the logo |
|
|
Caption Above Text
|
captionAboveText | string |
Set the caption above text |
|
|
Caption Above Font
|
captionAboveFont | string |
Set the font for the caption text |
|
|
Caption Above Font Size
|
captionAboveFontSize | integer |
Set the size of font for the caption text |
|
|
Caption Above Font Colour
|
captionAboveFontColour | string |
Set the font colour for the caption text |
|
|
Caption Above Alignment
|
captionAboveAlignment | string |
Set the alignment of the caption text |
|
|
Caption Above No Wrap
|
captionAboveNoWrap | boolean |
Set the wrapping of the caption text |
|
|
Caption Below Text
|
captionBelowText | string |
Set the caption below text |
|
|
Caption Below Font
|
captionBelowFont | string |
Set the font for the caption text |
|
|
Caption Below Font Size
|
captionBelowFontSize | integer |
Set the size of font for the caption text |
|
|
Caption Below Font Colour
|
captionBelowFontColour | string |
Set the font colour for the caption text |
|
|
Caption Below Alignment
|
captionBelowAlignment | string |
Set the alignment of the caption text |
|
|
Caption Below No Wrap
|
captionBelowNoWrap | boolean |
Set the wrapping of the caption text |
Returns
QR Code - Read from Document
Read a QR code(s) from the document provided - https://support.encodian.com/hc/en-gb/articles/360006165437-Read-QR-Code-Document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Type
|
fileType | string |
Select the source document format. |
|
|
File Content
|
FileContent | byte |
The file content of the source file |
|
|
Confidence
|
barcodeReadConfidence | string |
Set the confidence level for barcode detection |
|
|
Start Page
|
startPage | integer |
Set the page number to begin reading from |
|
|
End Page
|
endPage | integer |
Set the page number to end reading on |
|
|
Remove Control Characters
|
barcodeRemoveControlChars | boolean |
Set whether recognised control characters should be removed |
Returns
QR Code - Read from Image
Read a QR code from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170898-Read-QR-Code-Image
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source image file |
|
Image Format
|
barcodeImageFormat | True | string |
Select the image format for the QR Code image provided |
|
Confidence
|
barcodeReadConfidence | string |
Set the confidence level for barcode detection |
|
|
Remove Control Characters
|
barcodeRemoveControlChars | boolean |
Set whether recognised control characters should be removed |
Returns
Swiss QR Code - Create
Create a Swiss QR code in the specified image format - https://support.encodian.com/hc/en-gb/articles/22209145105052
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Image Format
|
imageFormat | True | string |
Set the image format of the Swiss QR code |
|
Account
|
account | True | string |
Set the 'Account' value |
|
Currency
|
currency | True | string |
Select the 'Currency' value |
|
Amount
|
amount | True | double |
Set the 'Amount' value |
|
Reference
|
reference | True | string |
Set the 'Reference' value |
|
Creditor - Name
|
name | True | string |
Set the 'Name' of the creditor |
|
Creditor - House Number
|
houseNo | string |
Set the 'House Number' of the creditor |
|
|
Creditor - Address Line 1
|
addressLine1 | string |
Set the 'Address Line 1' of the creditor |
|
|
Creditor - Address Line 2
|
addressLine2 | string |
Set the 'Address Line 2' of the creditor |
|
|
Creditor - Street
|
street | string |
Set the 'Street' of the creditor |
|
|
Creditor - Town
|
town | string |
Set the 'Town' of the creditor |
|
|
Creditor - Postcode
|
postcode | string |
Set the 'Postcode' of the creditor |
|
|
Creditor - Country Code
|
countryCode | True | string |
Set the 'Country Code' of the creditor |
|
Debtor - Name
|
name | True | string |
Set the 'Name' of the debtor |
|
Debtor - House Number
|
houseNo | string |
Set the 'House Number' of the debtor |
|
|
Debtor - Address Line 1
|
addressLine1 | string |
Set the 'Address Line 1' of the debtor |
|
|
Debtor - Address Line 2
|
addressLine2 | string |
Set the 'Address Line 2' of the debtor |
|
|
Debtor - Street
|
street | string |
Set the 'Street' of the debtor |
|
|
Debtor - Town
|
town | string |
Set the 'Town' of the debtor |
|
|
Debtor - Postcode
|
postcode | string |
Set the 'Postcode' of the debtor |
|
|
Debtor - Country Code
|
countryCode | True | string |
Set the 'Country Code' of the debtor |
|
Encode Mode
|
encodeMode | string |
Set the Swiss QR code encode mode |
|
|
Error Correction
|
errorCorrectionLevel | string |
Set the amount of 'backup' data to include within the QR code for error correction |
|
|
Resolution
|
resolution | integer |
Set the Swiss QR code border image resolution (dpi) |
|
|
Size - Mode
|
sizeMode | string |
Set the Swiss QR auto size mode, use 'Nearest' to assure QR code readability |
|
|
Size - Height
|
height | integer |
Set the Swiss QR code height (pixels) |
|
|
Size - Width
|
width | integer |
Set the Swiss QR code width (pixels) |
|
|
Style - Border Visible
|
borderVisible | boolean |
Set whether the QR code border is visible |
|
|
Style - Border Color
|
borderColor | string |
Set the Swiss QR code border color (HTML Color #000000) |
|
|
Style - Border Style
|
borderStyle | string |
Set the Swiss QR code border style |
|
|
Style - Border Width
|
borderWidth | integer |
Set the Swiss QR code border width (pixels) |
|
|
Style - Background Color
|
backColor | string |
Set the Swiss QR code background color (HTML) |
|
|
Style - Fore Color
|
foreColor | string |
Set the Swiss QR code foreground color (HTML) |
|
|
Style - Padding Bottom
|
paddingBottom | integer |
Set the Swiss QR code bottom padding value (pixels) |
|
|
Style - Padding Left
|
paddingLeft | integer |
Set the Swiss QR code left padding value (pixels) |
|
|
Style - Padding Right
|
paddingRight | integer |
Set the Swiss QR code right padding value (pixels) |
|
|
Style - Padding Top
|
paddingTop | integer |
Set the Swiss QR code top padding value (pixels) |
Returns
Swiss QR Code - Read from Image
Read a Swiss QR code from the image provided - https://support.encodian.com/hc/en-gb/articles/22624743460892
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source image file |
|
Remove Control Characters
|
barcodeRemoveControlChars | boolean |
Set whether recognised control characters should be removed |
Returns
Definitions
DtoResponseCreateBarcode
| Name | Path | Type | Description |
|---|---|---|---|
|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
|
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
|
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
|
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
|
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
|
Filename
|
Filename | string |
The filename of the document. |
|
File Content
|
FileContent | byte |
The processed document. |
DtoResponseCreateQrCode
| Name | Path | Type | Description |
|---|---|---|---|
|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
|
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
|
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
|
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
|
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
|
Filename
|
Filename | string |
The filename of the document. |
|
File Content
|
FileContent | byte |
The processed document. |
DtoResponseCreateSwissQrCode
| Name | Path | Type | Description |
|---|---|---|---|
|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
|
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
|
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
|
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
|
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
|
File Content
|
FileContent | byte |
The processed document. |
DtoResponseReadBarcodeFromDocument
| Name | Path | Type | Description |
|---|---|---|---|
|
Barcodes
|
barcodes | array of string |
The value of the barcodes detected |
|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
|
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
|
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
|
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
|
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
DtoResponseReadBarcodeFromImage
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
Value | string |
The value of the barcode |
|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
|
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
|
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
|
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
|
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
DtoResponseReadQrCodeFromDocument
| Name | Path | Type | Description |
|---|---|---|---|
|
QR Codes
|
qrCodes | array of string |
The value of the QR Codes detected |
|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
|
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
|
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
|
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
|
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
DtoResponseReadQrCodeFromImage
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
Value | string |
The value of the QR Code |
|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
|
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
|
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
|
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
|
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
DtoResponseReadSwissQrCodeFromImage
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
value | string |
The value of the Swiss QR Code |
|
Account
|
account | string |
The account from the Swiss QR Code |
|
Currency
|
currency | string |
The currency from the Swiss QR Code |
|
Amount
|
amount | double |
The amount from the Swiss QR Code |
|
Reference
|
reference | string |
The reference from the Swiss QR Code |
|
Creditor - Name
|
creditorName | string |
The 'Country Code' of the creditor |
|
Creditor - House Number
|
creditorHouseNo | string |
The 'House Number' of the creditor |
|
Creditor - Address Line 1
|
creditorAddressLine1 | string |
The 'Address Line 1' of the creditor |
|
Creditor - Address Line 2
|
creditorAddressLine2 | string |
The 'Address Line 2' of the creditor |
|
Creditor - Street
|
creditorStreet | string |
The 'Street' of the creditor |
|
Creditor - Town
|
creditorTown | string |
The 'Town' of the creditor |
|
Creditor - Postcode
|
creditorPostcode | string |
The 'Postcode' of the creditor |
|
Creditor - Country Code
|
creditorCountryCode | string |
The 'Country Code' of the creditor |
|
Debtor - Name
|
debtorName | string |
The 'Country Code' of the debtor |
|
Debtor - House Number
|
debtorHouseNo | string |
The 'House Number' of the debtor |
|
Debtor - Address Line 1
|
debtorAddressLine1 | string |
The 'Address Line 1' of the debtor |
|
Debtor - Address Line 2
|
debtorAddressLine2 | string |
The 'Address Line 2' of the debtor |
|
Debtor - Street
|
debtorStreet | string |
The 'Street' of the debtor |
|
Debtor - Town
|
debtorTown | string |
The 'Town' of the debtor |
|
Debtor - Postcode
|
debtorPostcode | string |
The 'Postcode' of the debtor |
|
Debtor - Country Code
|
debtorCountryCode | string |
The 'Country Code' of the debtor |
|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
|
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
|
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
|
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
|
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |