Class PaymentDetailsField

Information on a single payment.

Hierarchy

Field
- PaymentDetailsField

Index

Constructors

constructor

new PaymentDetailsField(constructor: PaymentDetailsConstructor): PaymentDetailsField
Parameters
- constructor: PaymentDetailsConstructor
  
  Constructor parameters.
Returns PaymentDetailsField
Overrides Field.constructor
- Defined in src/parsing/standard/paymentDetails.ts:43

Properties

accountNumber

accountNumber: undefined | string

The account number.

boundingBox

boundingBox: BoundingBox

Contains exactly 4 relative vertices coordinates (points) of a right rectangle containing the field in the document.

confidence

confidence: number

The confidence score of the prediction.

iban

iban: undefined | string

The International Bank Account Number (IBAN).

`Optional` pageId

pageId?: number

Page ID for multi-page document.

polygon

polygon: Polygon = []

Contains the relative vertices coordinates (points) of a polygon containing the field in the document.

reconstructed

reconstructed: boolean

true when the field was reconstructed or computed using other fields.

routingNumber

routingNumber: undefined | string

The routing number.

swift

swift: undefined | string

The bank's SWIFT Business Identifier Code (BIC).

`Optional` value

value?: string

Synonym for the iban property

Methods

compare

compare(other: BaseField): boolean
Parameters
- other: BaseField
Returns boolean
Inherited from Field.compare
- Defined in src/parsing/standard/base.ts:48

toString

toString(): string
Default string representation.

Returns string
Overrides Field.toString
- Defined in src/parsing/standard/paymentDetails.ts:81

`Static` `Private` #isKeySet

#isKeySet(value: any): boolean
Parameters
- value: any
Returns boolean
- Defined in src/parsing/standard/paymentDetails.ts:74

`Static` arrayConfidence

arrayConfidence(array: Field[]): number
Returns
product of all the fields probability
Parameters
- array: Field[]
  
  Array of Fields
Returns number
Inherited from Field.arrayConfidence
- Defined in src/parsing/standard/field.ts:63

`Static` arraySum

arraySum(array: BaseField[]): number
Returns
Sum of all the Fields values in the array
Parameters
- array: BaseField[]
  
  Array of Fields
Returns number
Inherited from Field.arraySum
- Defined in src/parsing/standard/base.ts:61

`Static` compareArrays

compareArrays(array1: Field[], array2: Field[], attr?: string): boolean
Returns
true if all elements in array1 exist in array2 and vice-versa, false otherwise
Parameters
- array1: Field[]
  
  first Array of Fields
- array2: Field[]
  
  second Array of Fields
- attr: string = "value"
  
  Attribute to compare
Returns boolean
Inherited from Field.compareArrays
- Defined in src/parsing/standard/field.ts:45

Class PaymentDetailsField

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

constructor: PaymentDetailsConstructor

Returns PaymentDetailsField

Properties

accountNumber

boundingBox

confidence

iban

Optional pageId

polygon

reconstructed

routingNumber

swift

Optional value

Methods

compare

Parameters

other: BaseField

Returns boolean

toString

Returns string

Static Private #isKeySet

Parameters

value: any

Returns boolean

Static arrayConfidence

Returns

Parameters

array: Field[]

Returns number

Static arraySum

Returns

Parameters

array: BaseField[]

Returns number

Static compareArrays

Returns

Parameters

array1: Field[]

array2: Field[]

attr: string = "value"

Returns boolean

Settings

Member Visibility

Theme

`Optional` pageId

`Optional` value

`Static` `Private` #isKeySet

`Static` arrayConfidence

`Static` arraySum

`Static` compareArrays