Security change on December 1, 2026: TLS 1.2 will become the minimum standard for 365 business Print Agent. Details and system requirements
365 business development
365 business development API
365 business development API

Schemas

businessdev.API.Models.AddressValidation.v2.AddressValidationRequest

address
​string | null
city
​string | null
country
​string | null
cityDistrict
​string | null
houseNumber
​string | null
street
​string | null
zip
​string | null

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobAcceptedData

Contains the durable admission data of one EBICS job.
jobId
​string | null

Gets or sets the job identifier.

Enum values:
GenerateKeys
Ini
Hia
DownloadBankKeys
FileUpload
FileDownload
LockAccess
UpdateSignatureKey
Enum values:
Accepted
Running
Succeeded
Failed
InDoubt
CredentialsRequired
Acknowledged
statusUrl
​string | null

Gets or sets the absolute polling URL.

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobAcceptedResponse

Wraps the durable admission result returned with HTTP 202.

Contains the durable admission data of one EBICS job.

Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobStatusData

Contains every result field that can be produced by an EBICS job.
jobId
​string

Gets or sets the job identifier.

Enum values:
GenerateKeys
Ini
Hia
DownloadBankKeys
FileUpload
FileDownload
LockAccess
UpdateSignatureKey
Enum values:
Accepted
Running
Succeeded
Failed
InDoubt
CredentialsRequired
Acknowledged
attemptCount
​integer · int32

Gets or sets the execution attempt count.

createdAt
​string · date-time

Gets or sets the creation timestamp.

updatedAt
​string · date-time

Gets or sets the last update timestamp.

orderNumber
​string | null

Gets or sets the optional EBICS order number.

transferCheckpoint
​string | null · byte

Gets or sets the opaque native recovery checkpoint.

payloadAvailable
​boolean

Gets or sets whether a separate payload is available.

noDataAvailable
​boolean

Gets or sets whether the bank returned no data.

​array | null

Gets or sets distributed-signature overview entries.

payloadLength
​integer | null · int64

Gets or sets the payload length.

payloadSha256
​string | null

Gets or sets the payload SHA-256 hash.

Enum values:
CredentialsRequired
PayloadStorageUnavailable
BankRejected
SdkOperationFailed
OutcomeUnknown
InternalProcessingError
nativeReporter
​integer | null · int32

Gets or sets the native Business-Logics reporter for a failed operation.

nativeErrorCode
​string | null

Gets or sets the raw native SDK error code with leading zeroes preserved.

ebicsReturnCode
​string | null

Gets or sets the six-digit bank-side EBICS return code when available.

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobStatusResponse

Wraps the complete durable status of one EBICS job.

Contains every result field that can be produced by an EBICS job.

Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.API.Models.Banking.v1.EBICS.EbicsAcknowledgeResponse

Represents a successful acknowledgement without additional business data.
Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.API.Models.Barcode.v3.AztecRequest

Represents the Request for Barcode Aztec encode.
errorCorrection
​integer · int32
layers
​integer · int32
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.CodabarRequest

Represents the Request for Barcode Codabar encode.
validateGeneratedBarcode
​boolean
showBarcodeValue
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.Code128GS1Request

Represents the Request for Barcode Code128 encode.
validateGeneratedBarcode
​boolean
showBarcodeValue
​boolean
gS1Format
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.Code39Request

Represents the Request for Barcode Code39 encode.
validateGeneratedBarcode
​boolean
showBarcodeValue
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.Code93Request

Represents the Request for Barcode Code93 encode.
validateGeneratedBarcode
​boolean
showBarcodeValue
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.DataMatrixGS1Request

Represents the Request for Barcode DataMatrix GS1 encode.
validateGeneratedBarcode
​boolean
showBarcodeValue
​boolean
gS1Format
​boolean
Enum values:
ASCII
C40
TEXT
X12
EDIFACT
BASE256
Enum values:
FORCE_NONE
FORCE_SQUARE
FORCE_RECTANGLE
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.DecodeRequest

file
​string | null · byte

businessdev.API.Models.Barcode.v3.EAN13Request

Represents the Request for Barcode EAN13 encode.
validateGeneratedBarcode
​boolean
showBarcodeValue
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.EAN8Request

Represents the Request for Barcode EAN8 encode.
validateGeneratedBarcode
​boolean
showBarcodeValue
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.ITF14Request

Represents the Request for Barcode ITF14 encode.
showBarcodeValue
​boolean
borderColor
​string | null
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.ITFRequest

Represents the Request for Barcode ITF encode.
validateGeneratedBarcode
​boolean
showBarcodeValue
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.MSIRequest

Represents the Request for Barcode MSI encode.
showBarcodeValue
​boolean
borderColor
​string | null
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.PDF417Request

Represents the Request for Barcode PDF417 encode.
Enum values:
L0
L1
L2
L3
L4
L5
L6
L7
aspectRatio
​businessdev.Barcode.Model.Enums.PDF417.AspectRation · enum
Enum values:
Ratio1
Ratio2
Ratio3
Ratio4
Auto
compactMode
​boolean
margin
​integer · int32
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.PlesseyRequest

Represents the Request for Barcode Plessey encode.
showBarcodeValue
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.QrCodeGS1Request

Represents the Request for Barcode QRCode GS1 encode.
errorCorrection
​businessdev.Barcode.Model.Enums.QrCode.ErrorCorrection · enum
Enum values:
L
M
Q
H
logo
​string | null · byte
validateGeneratedBarcode
​boolean
gS1Format
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.UPCARequest

Represents the Request for Barcode UPCA encode.
showBarcodeValue
​boolean
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Barcode.v3.UPCERequest

Represents the Request for Barcode UPCE encode.
showBarcodeValue
​boolean
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.API.Models.Cosmos.Service

name
​string | null

businessdev.API.Models.Cosmos.ServiceAuthenticationInfo

isAuthenticated
​boolean
reason
​string | null

businessdev.API.Models.Cosmos.ServiceLimitOptions

limit
​integer · int64
current
​integer · int64

businessdev.API.Models.Pdf.v3.Sign.SignRequest

Represents a PDF Stationery V3 Request
basePdf
​string | null · byte

businessdev.API.Models.Pdf.v4.AddBarcode.AztecRequest

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.CodabarRequest

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.Code128GS1Request

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.Code39Request

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.Code93Request

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.DataMatrixGS1Request

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.EAN13Request

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.EAN8Request

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.GS1.Code128GS1Extended

barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32
showBarcodeValue
​boolean
validateGeneratedBarcode
​boolean
gS1Format
​boolean

businessdev.API.Models.Pdf.v4.AddBarcode.GS1.DataMatrixGS1Extended

barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32
Enum values:
ASCII
C40
TEXT
X12
EDIFACT
BASE256
Enum values:
FORCE_NONE
FORCE_SQUARE
FORCE_RECTANGLE
validateGeneratedBarcode
​boolean
gS1Format
​boolean

businessdev.API.Models.Pdf.v4.AddBarcode.GS1.QRCodeGS1Extended

barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32
errorCorrection
​businessdev.Barcode.Model.Enums.QrCode.ErrorCorrection · enum
Enum values:
L
M
Q
H
logo
​string | null · byte
gS1Format
​boolean
validateGeneratedBarcode
​boolean

businessdev.API.Models.Pdf.v4.AddBarcode.ITF14Request

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.ITFRequest

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.MSIRequest

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.PDF417Request

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.PlesseyRequest

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.QRCodeGS1Request

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.UPCARequest

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.AddBarcode.UPCERequest

Enum values:
AllPages
FirstPage
pdfFile
​string | null · byte
rotationAngle
​integer · int32

businessdev.API.Models.Pdf.v4.Merge.MergeRequest

Represents a PDF Merge V4 Request
​array | null
copies
​integer · int32
copyOrder
​businessdev.Pdf.Model.Enums.Merge.CopyOrder · enum
Enum values:
Collated
Grouped

businessdev.API.Models.Pdf.v4.Stationery.StationeryRequest

Represents a PDF Stationery V4 Request

businessdev.API.Models.Pdf.v4.Zugferd.ExtractRequest

Represents the Zugferd Extract Pdf V4 request
basePdf
​string | null · byte

businessdev.API.Models.SanctionScreen.v1.Response

data
​
Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.API.Models.User.GetApiKeyRequest

Request all Services for a ApiKey
targetApiKey
​string | null

ApiKey to define

businessdev.API.Models.User.GetApiKeyResponse

Response for GetServices Request
​array | null

Services of requested ApiKey

apiKey
​string | null

Requested ApiKey

Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.API.Models.User.RegistrationRequest

Represents a Registration Request
companyName
​string | null

Company Name

companyAddress
​string | null

Company Address

companyAddress2
​string | null

Company Address 2

companyPostCode
​string | null

Company Postcode

companyCity
​string | null

Company City

companyCountry
​string | null

Company Country

contactName
​string | null

Contact Name

contactEMail
​string | null

Contact Email

contactPhoneNo
​string | null

Contact Phone number

contactLanguage
​string | null

Contact Language

businessdev.API.Models.User.RegistrationResponse

Represents the Registration Response for the customer
message
​string | null

Message

apiKey
​string | null

ApiKey

notice
​string | null

Notice

evaluationPeriodEnd
​string | null

Enddate of Evaluation

Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.API.Models.User.StatisticRequest

Represents a Statistic Request
startDate
​string · date-time

Statistic StartDate

endDate
​string · date-time

Statistic Enddate

businessdev.API.Models.User.UpgradeRequest

Represents a Upgrade Request

businessdev.API.Models.User.UpgradeResponse

Represents a response for Upgrade Response
apiKey
​string | null

API Key

message
​string | null

Message

Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.AddressValidation.Model.LoqateInternationalBatchCleanseResponse

latitude
​string | null
longitude
​string | null
geoAccuracy
​string | null
geoDistance
​string | null
address
​string | null
address1
​string | null
address2
​string | null
address3
​string | null
address4
​string | null
address5
​string | null
address6
​string | null
address7
​string | null
address8
​string | null
deliveryAddress
​string | null
deliveryAddress1
​string | null
deliveryAddress2
​string | null
deliveryAddress3
​string | null
deliveryAddress4
​string | null
deliveryAddress5
​string | null
deliveryAddress6
​string | null
deliveryAddress7
​string | null
deliveryAddress8
​string | null
id
​string | null
superAdministrativeArea
​string | null
administrativeArea
​string | null
subAdministrativeArea
​string | null
locality
​string | null
dependentLocality
​string | null
doubleDependentLocality
​string | null
thoroughfare
​string | null
dependentThoroughfare
​string | null
building
​string | null
premise
​string | null
subBuilding
​string | null
subBuildingFloor
​string | null
postalCode
​string | null
organization
​string | null
postBox
​string | null
countryName
​string | null
isO3166-2
​string | null
isO3166-3
​string | null
isO3166-N
​string | null
postalCodePrimary
​string | null
postalCodeSecondary
​string | null
addressFormat
​string | null
deliveryAddressFormat
​string | null
avc
​string | null
aqi
​string | null
sequence
​string | null
contact
​string | null
function
​string | null
department
​string | null
unmatched
​string | null
matchRuleLabel
​string | null
hyphenClass
​string | null
administrativeAreaName
​string | null
administrativeAreaTrailingType
​string | null
administrativeAreaType
​string | null
localityExtra
​string | null
localitySpecial
​string | null
localityName
​string | null
localityType
​string | null
localityTrailingType
​string | null
dependentLocalityName
​string | null
dependentLocalityType
​string | null
dependentLocalityLeadingType
​string | null
doubleDependentLocalityName
​string | null
doubleDependentLocalityType
​string | null
thoroughfarePreDirection
​string | null
thoroughfareType
​string | null
thoroughfareLeadingType
​string | null
thoroughfareName
​string | null
thoroughfareTrailingType
​string | null
thoroughfarePostDirection
​string | null
dependentThoroughfarePreDirection
​string | null
dependentThoroughfareLeadingType
​string | null
dependentThoroughfareName
​string | null
dependentThoroughfareTrailingType
​string | null
dependentThoroughfarePostDirection
​string | null
buildingLeadingType
​string | null
buildingName
​string | null
buildingType
​string | null
buildingTrailingType
​string | null
premiseType
​string | null
premiseNumber
​string | null
premiseExtra
​string | null
subBuildingType
​string | null
subBuildingLeadingType
​string | null
subBuildingNumber
​string | null
subBuildingName
​string | null
subBuildingBlock
​string | null
subBuildingDoor
​string | null
subBuildingStaircase
​string | null
bolignummer
​string | null
deliveryInstallationAreaName
​string | null
deliveryInstallationType
​string | null
deliveryInstallationQualifierName
​string | null
routeType
​string | null
routeNumber
​string | null
branchName
​string | null
makaniNumber
​string | null
shortAddressCode
​string | null
organizationName
​string | null
organizationType
​string | null
organizationTrailingType
​string | null
postBoxType
​string | null
postBoxNumber
​string | null
boxBagLobbyName
​string | null
dpid
​string | null
floorType
​string | null
floorNumber
​string | null
lotNumber
​string | null
postBoxNum
​string | null
postBoxNumberPrefix
​string | null
postBoxNumberSuffix
​string | null
primaryPremise
​string | null
primaryPremiseSuffix
​string | null
secondaryPremise
​string | null
secondaryPremiseSuffix
​string | null
preSortZone
​string | null
printPostZone
​string | null
barcode
​string | null
primaryAddressLine
​string | null
secondaryAddressLine
​string | null
autoZoneIndicator
​string | null
carrierRoute
​string | null
checkDigit
​string | null
cmraIndicator
​string | null
congressionalDistrict
​string | null
defaultFlag
​string | null
deliveryPointBarCode
​string | null
dna
​string | null
dpvConfirmedIndicator
​string | null
dpvFootnotes
​string | null
dpvlacsIndicator
​string | null
dropSiteIndicator
​string | null
eLOTCode
​string | null
eLOTNumber
​string | null
enhancedReturnCode
​string | null
ewsFlag
​string | null
falsePositiveIndicator
​string | null
finance
​string | null
fipsCountyCode
​string | null
lacsLinkCode
​string | null
lacsLinkIndicator
​string | null
lacsStatus
​string | null
nddFlag
​string | null
nddValues
​string | null
noStatIndicator
​string | null
noStatReason
​string | null
nsl
​string | null
parsedGarbage
​string | null
pbsaIndicator
​string | null
pmbNumber
​string | null
pmbType
​string | null
poBoxOnly
​string | null
recordType
​string | null
residentialDelivery
​string | null
resultsString
​string | null
returnCode
​string | null
suiteLinkFootnote
​string | null
throwbackIndicator
​string | null
vacantIndicator
​string | null
zip5Valid
​string | null
serpStatusEx
​string | null
questionable
​string | null
result
​string | null
generalDelivery
​string | null
deliveryInstallation
​string | null
route
​string | null
additionalContent
​string | null
resCom_Flag
​string | null
timeZone_UTC
​string | null
timeZone_DST
​string | null
timeZone_Name
​string | null
udprnKey
​string | null
uprn
​string | null
parentUPRN
​string | null
owningUDPRN
​string | null
umrrn
​string | null
residentialCommercialFlag
​string | null
dps
​string | null
postcodeType
​string | null
addressKey
​string | null
organisationKey
​string | null
formerPostalCounty
​string | null
administrativeCounty
​string | null
traditionalCounty
​string | null
administrativeAreaISO2
​string | null
country
​string | null
censusIndicator
​string | null
censusCode
​string | null
censusClassCode
​string | null
gnisFeatureID
​string | null
cbsaMetropolitanStatisticalArea
​string | null
cbsaMicropolitanStatisticalArea
​string | null
nectaMetropolitanStatisticalArea
​string | null
nectaMicropolitanStatisticalArea
​string | null
metropolitanDivision
​string | null
nectaDivision
​string | null
blockCode
​string | null
blockGroupCode
​string | null
cbsaCode
​string | null
cbsaName
​string | null
countyCode
​string | null
metroDivisionCode
​string | null
metroDivisionName
​string | null
nectaCode
​string | null
nectaName
​string | null
nectaDivisionCode
​string | null
nectaDivisionName
​string | null
oldMSACode
​string | null
oldMSAName
​string | null
stateCode
​string | null
tractCode
​string | null
latitudeStatus
​string | null
longitudeStatus
​string | null
addressStatus
​string | null
address1Status
​string | null
address2Status
​string | null
address3Status
​string | null
address4Status
​string | null
address5Status
​string | null
address6Status
​string | null
address7Status
​string | null
address8Status
​string | null
deliveryAddressStatus
​string | null
deliveryAddress1Status
​string | null
deliveryAddress2Status
​string | null
deliveryAddress3Status
​string | null
deliveryAddress4Status
​string | null
deliveryAddress5Status
​string | null
deliveryAddress6Status
​string | null
deliveryAddress7Status
​string | null
deliveryAddress8Status
​string | null
countryStatus
​string | null
idStatus
​string | null
superAdministrativeAreaStatus
​string | null
administrativeAreaStatus
​string | null
subAdministrativeAreaStatus
​string | null
localityStatus
​string | null
dependentLocalityStatus
​string | null
doubleDependentLocalityStatus
​string | null
thoroughfareStatus
​string | null
dependentThoroughfareStatus
​string | null
buildingStatus
​string | null
premiseStatus
​string | null
subBuildingStatus
​string | null
subBuildingFloorStatus
​string | null
postalCodeStatus
​string | null
organizationStatus
​string | null
postBoxStatus
​string | null
countryNameStatus
​string | null
isO3166-2Status
​string | null
isO3166-3Status
​string | null
isO3166-NStatus
​string | null
postalCodePrimaryStatus
​string | null
postalCodeSecondaryStatus
​string | null
addressFormatStatus
​string | null
deliveryAddressFormatStatus
​string | null
avcStatus
​string | null
aqiStatus
​string | null
sequenceStatus
​string | null
geoAccuracyStatus
​string | null
geoDistanceStatus
​string | null
contactStatus
​string | null
functionStatus
​string | null
departmentStatus
​string | null
unmatchedStatus
​string | null
matchRuleLabelStatus
​string | null
hyphenClassStatus
​string | null
administrativeAreaNameStatus
​string | null
administrativeAreaTrailingTypeStatus
​string | null
administrativeAreaTypeStatus
​string | null
localityExtraStatus
​string | null
localitySpecialStatus
​string | null
localityNameStatus
​string | null
localityTypeStatus
​string | null
localityTrailingTypeStatus
​string | null
dependentLocalityNameStatus
​string | null
dependentLocalityTypeStatus
​string | null
dependentLocalityLeadingTypeStatus
​string | null
doubleDependentLocalityNameStatus
​string | null
doubleDependentLocalityTypeStatus
​string | null
thoroughfarePreDirectionStatus
​string | null
thoroughfareTypeStatus
​string | null
thoroughfareLeadingTypeStatus
​string | null
thoroughfareNameStatus
​string | null
thoroughfareTrailingTypeStatus
​string | null
thoroughfarePostDirectionStatus
​string | null
dependentThoroughfarePreDirectionStatus
​string | null
dependentThoroughfareLeadingTypeStatus
​string | null
dependentThoroughfareNameStatus
​string | null
dependentThoroughfareTrailingTypeStatus
​string | null
dependentThoroughfarePostDirectionStatus
​string | null
buildingLeadingTypeStatus
​string | null
buildingNameStatus
​string | null
buildingTypeStatus
​string | null
buildingTrailingTypeStatus
​string | null
premiseTypeStatus
​string | null
premiseNumberStatus
​string | null
premiseExtraStatus
​string | null
subBuildingTypeStatus
​string | null
subBuildingLeadingTypeStatus
​string | null
subBuildingNumberStatus
​string | null
subBuildingNameStatus
​string | null
subBuildingBlockStatus
​string | null
subBuildingDoorStatus
​string | null
subBuildingStaircaseStatus
​string | null
bolignummerStatus
​string | null
deliveryInstallationAreaNameStatus
​string | null
deliveryInstallationTypeStatus
​string | null
deliveryInstallationQualifierNameStatus
​string | null
routeTypeStatus
​string | null
routeNumberStatus
​string | null
branchNameStatus
​string | null
makaniNumberStatus
​string | null
shortAddressCodeStatus
​string | null
organizationNameStatus
​string | null
organizationTypeStatus
​string | null
organizationTrailingTypeStatus
​string | null
postBoxTypeStatus
​string | null
postBoxNumberStatus
​string | null
boxBagLobbyNameStatus
​string | null
censusIndicatorStatus
​string | null
censusCodeStatus
​string | null
censusClassCodeStatus
​string | null
gnisFeatureIDStatus
​string | null
cbsaMetropolitanStatisticalAreaStatus
​string | null
cbsaMicropolitanStatisticalAreaStatus
​string | null
nectaMetropolitanStatisticalAreaStatus
​string | null
nectaMicropolitanStatisticalAreaStatus
​string | null
metropolitanDivisionStatus
​string | null
nectaDivisionStatus
​string | null
blockCodeStatus
​string | null
blockGroupCodeStatus
​string | null
cbsaCodeStatus
​string | null
cbsaNameStatus
​string | null
countyCodeStatus
​string | null
metroDivisionCodeStatus
​string | null
metroDivisionNameStatus
​string | null
nectaCodeStatus
​string | null
nectaNameStatus
​string | null
nectaDivisionCodeStatus
​string | null
nectaDivisionNameStatus
​string | null
oldMSACodeStatus
​string | null
oldMSANameStatus
​string | null
stateCodeStatus
​string | null
tractCodeStatus
​string | null
dpidStatus
​string | null
floorTypeStatus
​string | null
floorNumberStatus
​string | null
lotNumberStatus
​string | null
postBoxNumStatus
​string | null
postBoxNumberPrefixStatus
​string | null
postBoxNumberSuffixStatus
​string | null
primaryPremiseStatus
​string | null
primaryPremiseSuffixStatus
​string | null
secondaryPremiseStatus
​string | null
secondaryPremiseSuffixStatus
​string | null
preSortZoneStatus
​string | null
printPostZoneStatus
​string | null
barcodeStatus
​string | null
primaryAddressLineStatus
​string | null
secondaryAddressLineStatus
​string | null
autoZoneIndicatorStatus
​string | null
carrierRouteStatus
​string | null
checkDigitStatus
​string | null
cmraIndicatorStatus
​string | null
congressionalDistrictStatus
​string | null
defaultFlagStatus
​string | null
deliveryPointBarCodeStatus
​string | null
dnaStatus
​string | null
dpvConfirmedIndicatorStatus
​string | null
dpvFootnotesStatus
​string | null
dpvlacsIndicatorStatus
​string | null
dropSiteIndicatorStatus
​string | null
eLOTCodeStatus
​string | null
eLOTNumberStatus
​string | null
enhancedReturnCodeStatus
​string | null
ewsFlagStatus
​string | null
falsePositiveIndicatorStatus
​string | null
financeStatus
​string | null
fipsCountyCodeStatus
​string | null
lacsLinkCodeStatus
​string | null
lacsLinkIndicatorStatus
​string | null
lacsStatusStatus
​string | null
nddFlagStatus
​string | null
nddValuesStatus
​string | null
noStatIndicatorStatus
​string | null
noStatReasonStatus
​string | null
nslStatus
​string | null
parsedGarbageStatus
​string | null
pbsaIndicatorStatus
​string | null
pmbNumberStatus
​string | null
pmbTypeStatus
​string | null
poBoxOnlyStatus
​string | null
recordTypeStatus
​string | null
residentialDeliveryStatus
​string | null
resultsStringStatus
​string | null
returnCodeStatus
​string | null
suiteLinkFootnoteStatus
​string | null
throwbackIndicatorStatus
​string | null
vacantIndicatorStatus
​string | null
zip5ValidStatus
​string | null
serpStatusExStatus
​string | null
questionableStatus
​string | null
resultStatus
​string | null
generalDeliveryStatus
​string | null
deliveryInstallationStatus
​string | null
routeStatus
​string | null
additionalContentStatus
​string | null
resCom_FlagStatus
​string | null
timeZone_UTCStatus
​string | null
timeZone_DSTStatus
​string | null
timeZone_NameStatus
​string | null
udprnKeyStatus
​string | null
uprnStatus
​string | null
parentUPRNStatus
​string | null
owningUDPRNStatus
​string | null
umrrnStatus
​string | null
residentialCommercialFlagStatus
​string | null
dpsStatus
​string | null
postcodeTypeStatus
​string | null
addressKeyStatus
​string | null
organisationKeyStatus
​string | null
formerPostalCountyStatus
​string | null
administrativeCountyStatus
​string | null
traditionalCountyStatus
​string | null
administrativeAreaISO2Status
​string | null

businessdev.Barcode.Model.Aztec.AztecOptions

errorCorrection
​integer · int32
layers
​integer · int32
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.Codabar.CodabarOptions

showBarcodeValue
​boolean
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.Code39.Code39Options

showBarcodeValue
​boolean
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.Code93.Code93Options

showBarcodeValue
​boolean
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.EAN13.EAN13Options

showBarcodeValue
​boolean
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.EAN8.EAN8Options

showBarcodeValue
​boolean
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.Encode.IEncodeBaseOptions

barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
value
​string | null
height
​integer · int32
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.Enums.DataMatrix.Encoding

string · enum
Enum values:
ASCII
C40
TEXT
X12
EDIFACT
BASE256

businessdev.Barcode.Model.Enums.DataMatrix.SymbolShape

string · enum
Enum values:
FORCE_NONE
FORCE_SQUARE
FORCE_RECTANGLE

businessdev.Barcode.Model.Enums.Decode.BarcodeFormat

string · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13

businessdev.Barcode.Model.Enums.Encode.BarcodeFormat

string · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13

businessdev.Barcode.Model.Enums.PDF417.AspectRation

string · enum
Enum values:
Ratio1
Ratio2
Ratio3
Ratio4
Auto

businessdev.Barcode.Model.Enums.PDF417.ErrorCorrectionLevel

string · enum
Enum values:
L0
L1
L2
L3
L4
L5
L6
L7

businessdev.Barcode.Model.Enums.QrCode.ErrorCorrection

string · enum
Enum values:
L
M
Q
H

businessdev.Barcode.Model.ITF.ITFOptions

showBarcodeValue
​boolean
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.ITF14.ITF14Options

showBarcodeValue
​boolean
borderColor
​string | null
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.MSI.MSIOptions

showBarcodeValue
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.PDF417.PDF417Options

Enum values:
L0
L1
L2
L3
L4
L5
L6
L7
aspectRatio
​businessdev.Barcode.Model.Enums.PDF417.AspectRation · enum
Enum values:
Ratio1
Ratio2
Ratio3
Ratio4
Auto
compactMode
​boolean
margin
​integer · int32
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.Plessey.PlesseyOptions

showBarcodeValue
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.UPCA.UPCAOptions

showBarcodeValue
​boolean
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Barcode.Model.UPCE.UPCEOptions

showBarcodeValue
​boolean
validateGeneratedBarcode
​boolean
barcodeFormat
​businessdev.Barcode.Model.Enums.Encode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
height
​integer · int32
value
​string | null
backgroundColor
​string | null
color
​string | null
surfaceWidth
​integer · int32

businessdev.Pdf.Model.AddBarcode.BarcodePosition

Enum values:
Centimeter
Pica
Pixel
Point
Inch
Document
Millimeter
xValue
​number · float
yValue
​number · float

businessdev.Pdf.Model.Enums.AddBarcode.GraphicsUnit

string · enum
Enum values:
Centimeter
Pica
Pixel
Point
Inch
Document
Millimeter

businessdev.Pdf.Model.Enums.AddBarcode.Type

string · enum
Enum values:
AllPages
FirstPage

businessdev.Pdf.Model.Enums.Attachment.Relationship

string · enum
Enum values:
Source
Data
Alternative
Supplement
Unspecified

businessdev.Pdf.Model.Enums.General.ConformanceLevel

string · enum
Enum values:
None
Pdf_A1B
Pdf_X1A2001
Pdf_A2B
Pdf_A3B
Pdf_A1A
Pdf_A2A
Pdf_A2U

businessdev.Pdf.Model.Enums.General.Rotation

string · enum
Enum values:
None
RotateAngle90
RotateAngle180
RotateAngle270

businessdev.Pdf.Model.Enums.General.Severity

string · enum
Enum values:
Info
Warning
Error

businessdev.Pdf.Model.Enums.Merge.CopyOrder

string · enum
Enum values:
Collated
Grouped

businessdev.Pdf.Model.Enums.Security.Permissions

string · enum
Enum values:
Default
Print
EditContent
CopyContent
EditAnnotations
FillFields
AccessibilityCopyContent
AssembleDocument

businessdev.Pdf.Model.Enums.Security.ProtectionMode

string · enum
Enum values:
Open
Advanced
Both

businessdev.Pdf.Model.Enums.Stationery.Type

string · enum
Enum values:
AllPages
FirstPage
FollowingPage
SecondLastPage
LastPage

businessdev.Pdf.Model.Enums.Zugferd.ConformanceLevel

string · enum
Enum values:
None
Basic
Comfort
Extended
Minimum
EN16931
Basic_WL

businessdev.Pdf.Model.Enums.Zugferd.Version

string · enum
Enum values:
V1
V2
V2_1
V2_5
V2_5_2

businessdev.Pdf.Model.IAttachment

fileName
​string | null
description
​string | null
mimeType
​string | null
modificationDate
​string · date-time
data
​string | null · byte
relationship
​businessdev.Pdf.Model.Enums.Attachment.Relationship · enum
Enum values:
Source
Data
Alternative
Supplement
Unspecified

businessdev.Pdf.Model.IBrandingOptions

creatorTool
​string | null
producer
​string | null

businessdev.Pdf.Model.IDigitalSignOptions

data
​string | null · byte
password
​string | null

businessdev.Pdf.Model.IDocumentSettings

conformanceLevel
​businessdev.Pdf.Model.Enums.General.ConformanceLevel · enum
Enum values:
None
Pdf_A1B
Pdf_X1A2001
Pdf_A2B
Pdf_A3B
Pdf_A1A
Pdf_A2A
Pdf_A2U
compress
​boolean
title
​string | null
​array | null

businessdev.Pdf.Model.IFileMergeOption

data
​string | null · byte
rotation
​businessdev.Pdf.Model.Enums.General.Rotation · enum
Enum values:
None
RotateAngle90
RotateAngle180
RotateAngle270

businessdev.Pdf.Model.ISecurityOptions

Enum values:
Open
Advanced
Both
permissions
​businessdev.Pdf.Model.Enums.Security.Permissions · enum
Enum values:
Default
Print
EditContent
CopyContent
EditAnnotations
FillFields
AccessibilityCopyContent
AssembleDocument
ownerPassword
​string | null
userPassword
​string | null

businessdev.Pdf.Model.Stationery.IStationeryOptions

basePdf
​string | null · byte
​array | null

businessdev.Pdf.Model.Stationery.IStationeryPageSetting

Enum values:
AllPages
FirstPage
FollowingPage
SecondLastPage
LastPage
data
​string | null · byte

businessdev.Pdf.Model.Zugferd.IZugferdOptions

version
​businessdev.Pdf.Model.Enums.Zugferd.Version · enum
Enum values:
V1
V2
V2_1
V2_5
V2_5_2
conformanceLevel
​businessdev.Pdf.Model.Enums.Zugferd.ConformanceLevel · enum
Enum values:
None
Basic
Comfort
Extended
Minimum
EN16931
Basic_WL
fileName
​string | null
description
​string | null
mimeType
​string | null
modificationDate
​string · date-time
data
​string | null · byte
relationship
​businessdev.Pdf.Model.Enums.Attachment.Relationship · enum
Enum values:
Source
Data
Alternative
Supplement
Unspecified

businessdev.Pdf.Model.Zugferd.ZugferdValidationItem

severity
​businessdev.Pdf.Model.Enums.General.Severity · enum
Enum values:
Info
Warning
Error
message
​string | null

businessdev.WebApi.BaseModel.Common.v2.File

mime
​string | null
data
​string | null · byte

businessdev.WebApi.BaseModel.Enums.BaseResponse.Result

string · enum
Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests

businessdev.WebApi.Model.AddressValidation.v3.Response

​array | null
exceptionMessage
​string | null
Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.WebApi.Model.ApiKeyStatus.Response

isBlocked
​boolean
isEvaluation
​boolean
evaluationPeriodEnd
​string | null
Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.WebApi.Model.Barcode.v3.Decode.Response

value
​string | null
barcodeFormat
​businessdev.Barcode.Model.Enums.Decode.BarcodeFormat · enum
Enum values:
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.WebApi.Model.Barcode.v3.Encode.Response

Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.WebApi.Model.Pdf.v3.Response

Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.WebApi.Model.Pdf.v4.Zugferd.ValidateAndExtractResponse

​array | null
Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.WebApi.Model.Statistic.Response

apiKey
​string | null
Enum values:
None
Ok
Error
NotFound
BadRequest
UnauthorizedAccess
DebugSessionResult
TooManyRequests
processingTimeInMilliseconds
​integer · int64

businessdev.blebics.Contracts.Enums.BlebicsJobErrorCode

string · enum
Enum values:
CredentialsRequired
PayloadStorageUnavailable
BankRejected
SdkOperationFailed
OutcomeUnknown
InternalProcessingError

businessdev.blebics.Contracts.Enums.BlebicsJobStatus

string · enum
Enum values:
Accepted
Running
Succeeded
Failed
InDoubt
CredentialsRequired
Acknowledged

businessdev.blebics.Contracts.Enums.BlebicsJobType

string · enum
Enum values:
GenerateKeys
Ini
Hia
DownloadBankKeys
FileUpload
FileDownload
LockAccess
UpdateSignatureKey

businessdev.blebics.Contracts.Enums.EbicsProtocolVersion

string · enum
Enum values:
H003
H004
H005

businessdev.blebics.Contracts.Enums.EbicsSignatureVersion

string · enum
Enum values:
A005
A006

businessdev.blebics.Contracts.Requests.ChangeKeyPasswordRequest

newKeyPassword
​string
keyPassword
​string

businessdev.blebics.Contracts.Requests.DistributedSignatureOrderRequest

orderId
​string
keyPassword
​string

businessdev.blebics.Contracts.Requests.EbicsConnectionParameters

bankUrl
​string · uri
hostId
​string
partnerId
​string
userId
​string
protocolVersion
​businessdev.blebics.Contracts.Enums.EbicsProtocolVersion · enum
Enum values:
H003
H004
H005
expectedEncryptionKeyHash
​string
expectedAuthenticationKeyHash
​string

businessdev.blebics.Contracts.Requests.EbicsDownloadRequest

orderType
​string | null
fromDate
​string | null · date-time
toDate
​string | null · date-time
fileFormat
​string | null
countryCode
​string | null
​object
keyPassword
​string

businessdev.blebics.Contracts.Requests.EbicsService

serviceName
​string
messageName
​string
scope
​string | null
serviceOption
​string | null
containerType
​string | null
messageFormat
​string | null
messageVariant
​string | null
messageVersion
​string | null

businessdev.blebics.Contracts.Requests.EbicsStateCommand

keyPassword
​string

businessdev.blebics.Contracts.Requests.EbicsUploadRequest

content
​string
fileName
​string
fileDate
​string · date-time
orderType
​string | null
fileFormat
​string | null
countryCode
​string | null
​object
requestDistributedSignature
​boolean
additionalInformation
​string | null
keyPassword
​string

businessdev.blebics.Contracts.Requests.GenerateKeysRequest

signatureVersion
​businessdev.blebics.Contracts.Enums.EbicsSignatureVersion · enum
Enum values:
A005
A006
keyPassword
​string
signatureKeyLength
​integer · int32
protocolKeyLength
​integer · int32
useCertificates
​boolean
certificateCommonName
​string | null
certificateValidityYears
​integer · int32

businessdev.blebics.Contracts.Requests.UpdateAllKeysRequest

signatureVersion
​businessdev.blebics.Contracts.Enums.EbicsSignatureVersion · enum
Enum values:
A005
A006
signatureKeyLength
​integer · int32
protocolKeyLength
​integer · int32
keyPassword
​string

businessdev.blebics.Contracts.Requests.UpdateProtocolKeysRequest

protocolKeyLength
​integer · int32
keyPassword
​string

businessdev.blebics.Contracts.Requests.UpdateSignatureKeyRequest

signatureVersion
​businessdev.blebics.Contracts.Enums.EbicsSignatureVersion · enum
Enum values:
A005
A006
signatureKeyLength
​integer · int32
keyPassword
​string

businessdev.blebics.Contracts.Responses.Objects.DistributedSignatureDetailsInfo

displayFile
​string
orderDataAvailable
​boolean

businessdev.blebics.Contracts.Responses.Objects.DistributedSignatureOrderInfo

partnerId
​string
orderId
​string
orderType
​string | null
dataSize
​integer · int64
signaturesCompleted
​integer · int32
signaturesRequired
​integer · int32
readyToSign
​boolean
createdAt
​string | null · date-time
totalAmount
​string | null
currency
​string | null

businessdev.blebics.Contracts.Responses.Objects.EbicsPublicKeyInfo

version
​string
hash
​string
modulus
​string
exponent
​string

businessdev.blebics.Contracts.Responses.Objects.EbicsRuntimeState

bank
​string
partner
​string
user
​string