| Name | Description | Type | Additional information |
|---|---|---|---|
| Address | string |
String length: inclusive between 0 and 256 |
|
| Address2 | string |
String length: inclusive between 0 and 100 |
|
| AmountDue |
The total amount due for the Bill. |
decimal? |
None. |
| AttnAddressLine | string |
String length: inclusive between 0 and 256 |
|
| BillerInvoiceNo | string |
String length: inclusive between 0 and 50 |
|
| BillerRemittanceField1 | string |
String length: inclusive between 0 and 50 |
|
| BillerRemittanceField2 | string |
String length: inclusive between 0 and 50 |
|
| BillerRemittanceField3 | string |
String length: inclusive between 0 and 1024 |
|
| BillerRemittanceField4 | string |
String length: inclusive between 0 and 1024 |
|
| BillerRemittanceField5 | string |
String length: inclusive between 0 and 50 |
|
| City | string |
String length: inclusive between 0 and 50 |
|
| CompanyName | string |
String length: inclusive between 0 and 256 |
|
| Country | string |
None. |
|
| CurrentCharges | decimal? |
None. |
|
| CustomAttributes |
Only used for external invoice retrieval, not persisted |
Dictionary of string [key] and string [value] |
None. |
| Details | Collection of InvoiceDetailModel |
None. |
|
| DisplayField1 | string |
String length: inclusive between 0 and 256 |
|
| DisplayField2 | string |
String length: inclusive between 0 and 256 |
|
| DisplayField3 | string |
String length: inclusive between 0 and 256 |
|
| DisplayField4 | string |
String length: inclusive between 0 and 256 |
|
| DisplayField5 | string |
String length: inclusive between 0 and 256 |
|
| DisputedAmount |
Total amount disputed for the current invoice |
decimal? |
None. |
| DueDate |
The date the bill is due. |
date-time? |
None. |
| EIR | boolean |
None. |
|
| EIRShouldPersist | boolean |
None. |
|
| EIRTransmissionLogID | long? |
None. |
|
| string |
Email address String length: inclusive between 0 and 128 |
||
| EntryField1 | string |
String length: inclusive between 0 and 256 |
|
| EntryField2 | string |
String length: inclusive between 0 and 256 |
|
| EntryField3 | string |
String length: inclusive between 0 and 256 |
|
| EntryField4 | string |
String length: inclusive between 0 and 256 |
|
| EntryField5 | string |
String length: inclusive between 0 and 256 |
|
| ExternalID | string |
String length: inclusive between 0 and 256 |
|
| Fax | string |
String length: inclusive between 0 and 20 |
|
| FDICode | string |
String length: inclusive between 0 and 20 |
|
| FirstName | string |
String length: inclusive between 0 and 32 |
|
| HasLevel3InDetails | boolean? |
None. |
|
| ID | long |
None. |
|
| InvAltTaxAmount |
Level 2/3 data field at the Order level. Represents the Alternate Tax Amount for the invoice. |
decimal? |
None. |
| InvAltTaxAmtItmLevel |
Level 2/3 data field at the Item level. Represents the Alternate Tax Amount of the individual line item on the invoice. |
decimal? |
None. |
| InvAltTaxID |
Level 2/3 data field at the Item level. Represents Invoice Alternative Tax ID of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 15 |
| InvAltTaxIdItmLevel |
Level 2/3 data field at the Item level. Represents Alternate Tax Indicator of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 15 |
| InvAltTaxIDOrdLevel |
Level 2/3 data field at the Order level. Represents Alternate Tax Indicator for the invoice. |
string |
String length: inclusive between 0 and 2 |
| InvAltTaxRate |
Level 2/3 data field at the Item level. Represents Alternate Tax Rate of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 5 |
| InvAltTaxType |
Level 2/3 data field at the Item level. Represents Alternate Tax Type of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 2 |
| InvAltTaxTypeApp |
Level 2/3 data field at the Item level. Represents Alternate Tax Type Applied of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 4 |
| InvCommodityCode |
Level 2/3 data field at the Item level. Represents Commodity Code of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 12 |
| InvCustomerCode |
Level 2/3 data field at the Order level. Represents Customer Code for the invoice. |
string |
String length: inclusive between 0 and 16 |
| InvDestAddress1 |
Level 2/3 data field at the Order level. Represents destination Address1 for the invoice. |
string |
String length: inclusive between 0 and 30 |
| InvDestAddress2 |
Level 2/3 data field at the Order level. Represents destination Address2 for the invoice. |
string |
String length: inclusive between 0 and 30 |
| InvDestCardholderName |
Level 2/3 data field at the Order level. Represents destination Cardholder Name for the invoice. |
string |
String length: inclusive between 0 and 30 |
| InvDestCity |
Level 2/3 data field at the Order level. Represents destination City for the invoice. |
string |
String length: inclusive between 0 and 20 |
| InvDestCountryCode |
Level 2/3 data field at the Order level. Represents destination Country for the invoice. |
string |
String length: inclusive between 0 and 3 |
| InvDestStateCode |
Level 2/3 data field at the Order level. Represents destination State for the invoice. |
string |
String length: inclusive between 0 and 2 |
| InvDestZipCode |
Level 2/3 data field at the Order level. Represents destination Postal/Zip Code for the invoice. |
string |
String length: inclusive between 0 and 10 |
| InvDiscountPerItem |
Level 2/3 data field at the Item level. Represents Discount Amount of the individual line item on the invoice. |
decimal? |
None. |
| InvDutyAmount |
Level 2/3 data field at the Order level. Represents the Duty Amount for the invoice. |
decimal? |
None. |
| InvFreightAmount |
Level 2/3 data field at the Order level. Represents the Freight Amount for the invoice. |
decimal? |
None. |
| InvLineItemDiscountRate |
Level 2/3 data field at the Item level. Represents Line Item Discount Rate of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 10 |
| InvLineItemTaxRate |
Level 2/3 data field at the Item level. Represents Line Item Tax Rate of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 10 |
| InvLineItemTotal |
Level 2/3 data field at the Item level. Represents the Line Item Total of the individual line item on the invoice. |
decimal? |
None. |
| InvLineItemVATTaxAmount |
Level 2/3 data field at the Item level. Represents Line Item VAT Tax Amount of the individual line item on the invoice. |
decimal? |
None. |
| InvLineItemVATTaxRate |
Level 2/3 data field at the Item level. Represents Line Item VAT Tax Rate of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 10 |
| InvLocalTaxAmount |
Level 2/3 data field at the Order level. Represents the Local Tax Amount for the invoice. Sales tax for the order |
decimal? |
None. |
| InvLocalTaxItmLevel |
Level 2/3 data field at the Item level. Represents Local Tax of the individual line item on the invoice. |
decimal? |
None. |
| InvLocalTaxRate |
Level 2/3 data field at the Order level. Represents Local Tax Rate for the invoice. |
string |
String length: inclusive between 0 and 15 |
| InvMerchantVATRegistrationNumber |
Level 2/3 data field at the Order level. Represents Merchant VAT Registration Number. |
string |
String length: inclusive between 0 and 20 |
| InvNationalTaxAmount |
Level 2/3 data field at the Order level. Represents National Tax Amount for the invoice. |
decimal? |
None. |
| InvNationalTaxItmLevel |
Level 2/3 data field at the Item level. Represents National Tax of the individual line item on the invoice. |
decimal? |
None. |
| InvNationalTaxRate |
Level 2/3 data field at the Order level. Represents National Tax Rate for the invoice. |
string |
String length: inclusive between 0 and 15 |
| InvNetGrossIndicator |
Level 2/3 data field at the Item level. Represents the net gross indicator of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 1 |
| InvoiceAge | int |
None. |
|
| InvoiceCategory | InvoiceCategory |
None. |
|
| InvOrderDisAmtOrdLevel |
Level 2/3 data field at the Order level. Represents Order Discount Amount for the invoice. |
string |
String length: inclusive between 0 and 11 |
| InvProductCode |
Level 2/3 data field at the Item level. Represents the Product Code of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 12 |
| InvProductName |
Level 2/3 data field at the Item level. Represents the Product Name of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 35 |
| InvProductSKU |
Level 2/3 data field at the Item level. Represents the Product SKU of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 30 |
| InvPstTaxRegNum |
Level 2/3 data field at the Order level. Represents Canadian provincial sales tax registration number for the invoice. |
string |
String length: inclusive between 0 and 15 |
| InvPurchaseID |
Level 2/3 data field at the Order level. Represents Purchase Order Number for invoice. |
string |
String length: inclusive between 0 and 25 |
| InvPurchaseIDItmLevel |
Level 2/3 data field at the Item level. Represents the Invoice Number of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 23 |
| InvQuantity |
Legacy field. Will be removed in a future release. Use ItemQuantity instead. |
int? |
Obsolete. InvQuantity is a legacy field. Use ItemQuantity instead. |
| InvRequestorName |
Level 2/3 data field at the Order level. Represents Requestor Name for the invoice. |
string |
String length: inclusive between 0 and 38 |
| InvShipFromZipCode |
Level 2/3 data field at the Order level. Represents Ship From Postal/Zip Code for the invoice. |
string |
String length: inclusive between 0 and 10 |
| InvSummaryCommodityCode |
Level 2/3 data field at the Order level. Represents Summary Commodity Code for the invoice. |
string |
String length: inclusive between 0 and 4 |
| InvSupplierOrdRef |
Level 2/3 data field at the Order level. Represents Supplier Order Reference Number for the invoice. |
string |
String length: inclusive between 0 and 25 |
| InvTaxAmount |
Level 2/3 data field at the Item level. Represents the Tax Amount of the individual line item on the invoice. |
decimal? |
None. |
| InvTaxRate | string |
String length: inclusive between 0 and 5 |
|
| InvUnitCost |
Level 2/3 data field at the Item level. Represents the Unit Price of the individual line item on the invoice. |
decimal? |
None. |
| InvUnitMeasure |
Level 2/3 data field at the Item level. Represents the Unit Of Measure of the individual line item on the invoice. |
string |
String length: inclusive between 0 and 12 |
| InvVatRefNumber |
Level 2/3 data field at the Order level. Represents VAT Invoice Reference Number. |
string |
String length: inclusive between 0 and 15 |
| InvVatRegNumber |
Level 2/3 data field at the Order level. Represents Purchaser VAT Registration Number for the invoice. |
string |
String length: inclusive between 0 and 13 |
| InvVatTaxAmount |
Level 2/3 data field at the Order level. Represents the VAT Tax Amount for the invoice. |
decimal? |
None. |
| InvVatTaxRate |
Level 2/3 data field at the Order level. Represents the VAT Tax Rate for the invoice. |
string |
String length: inclusive between 0 and 15 |
| ItemQuantity |
Level 2/3 data field at the Item level. Represents the Item Quantity of the individual line item on the invoice. |
decimal? |
None. |
| LastName | string |
String length: inclusive between 0 and 32 |
|
| MerchantDescriptor | string |
String length: inclusive between 0 and 50 |
|
| MerchantDescriptorAlt | string |
String length: inclusive between 0 and 50 |
|
| MerchantDescriptorCity | string |
String length: inclusive between 0 and 50 |
|
| MerchantDescriptorContact | string |
String length: inclusive between 0 and 20 |
|
| MerchantDescriptorCountry | string |
String length: inclusive between 0 and 2 |
|
| MerchantDescriptorState | string |
String length: inclusive between 0 and 20 |
|
| MerchantDescriptorStreet | string |
String length: inclusive between 0 and 60 |
|
| MerchantDescriptorZip | string |
String length: inclusive between 0 and 14 |
|
| Message_OutstandingBalance | string |
String length: inclusive between 0 and 1024 |
|
| MiddleName | string |
String length: inclusive between 0 and 32 |
|
| MinimumAmountDue | decimal? |
None. |
|
| OtherData | string |
String length: inclusive between 0 and 100 |
|
| PaymentInstrumentBlock | string |
None. |
|
| PaymentReceived | decimal? |
None. |
|
| PaymentsPostedAsOfDate | date-time? |
None. |
|
| PayThisAmount | decimal? |
None. |
|
| Phone | string |
String length: inclusive between 0 and 20 |
|
| Prev_0To30Days |
Only available for detail Billers. Bill will be rejected if the Biller is not configured as a detail Biller. |
decimal? |
None. |
| Prev_30To60Days |
Only available for detail Billers. Bill will be rejected if the Biller is not configured as a detail Biller. |
decimal? |
None. |
| Prev_60To90Days |
Only available for detail Billers. Bill will be rejected if the Biller is not configured as a detail Biller. |
decimal? |
None. |
| Prev_90DaysPlus |
Only available for detail Billers. Bill will be rejected if the Biller is not configured as a detail Biller. |
decimal? |
None. |
| PreviousBalance | decimal? |
None. |
|
| Promise | PromiseModel |
None. |
|
| ReferenceNumber | string |
String length: inclusive between 0 and 100 |
|
| RemainingAmount | decimal |
None. |
|
| State | string |
String length: inclusive between 0 and 2 |
|
| StatementDate | date-time? |
None. |
|
| Status | InvoiceStatusType |
None. |
|
| TotalAccountBalance | decimal? |
None. |
|
| WaiveFee |
BillingAccount level property indicating if Fee should be Waived for Customer linked to the BillingAccount |
boolean? |
None. |
| Zip | string |
String length: inclusive between 0 and 10 |