| Name | Description | Type | Additional information |
|---|---|---|---|
| ActivePaymentAmount | decimal? |
None. |
|
| AdditionalFields | Collection of AdditionalFieldModel |
None. |
|
| 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. |
| AmountRemaining | decimal |
None. |
|
| 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 |
|
| BillID | long |
None. |
|
| BillingAccountID | long |
None. |
|
| 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. |
| DecryptedReferenceNumber | string |
None. |
|
| DefaultPaymentAmount | decimal |
None. |
|
| Details | Collection of InvoiceDetailModel |
None. |
|
| DiscountRate | decimal |
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 |
|
| DisplayPaymentAmountOptions | boolean |
None. |
|
| dtDue | date-time? |
None. |
|
| dtStatement | date-time? |
None. |
|
| DueDate |
The date the bill is due. |
date-time? |
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 |
|
| HasCreditMemoPayments | boolean |
None. |
|
| HasOpenRFP | boolean |
None. |
|
| HasPayments | boolean |
None. |
|
| ID | long |
None. |
|
| InvAltTaxAmount | decimal? |
None. |
|
| InvAltTaxAmtItmLevel | decimal? |
None. |
|
| InvAltTaxID | string |
String length: inclusive between 0 and 15 |
|
| InvAltTaxIdItmLevel | string |
String length: inclusive between 0 and 15 |
|
| InvAltTaxIDOrdLevel | string |
String length: inclusive between 0 and 2 |
|
| InvAltTaxRate | string |
String length: inclusive between 0 and 5 |
|
| InvAltTaxType | string |
String length: inclusive between 0 and 2 |
|
| InvAltTaxTypeApp | string |
String length: inclusive between 0 and 4 |
|
| InvCommodityCode | string |
String length: inclusive between 0 and 12 |
|
| InvCustomerCode | string |
String length: inclusive between 0 and 16 |
|
| InvDestAddress1 | string |
String length: inclusive between 0 and 30 |
|
| InvDestAddress2 | string |
String length: inclusive between 0 and 30 |
|
| InvDestCardholderName | string |
String length: inclusive between 0 and 30 |
|
| InvDestCity | string |
String length: inclusive between 0 and 20 |
|
| InvDestCountryCode | string |
String length: inclusive between 0 and 3 |
|
| InvDestStateCode | string |
String length: inclusive between 0 and 2 |
|
| InvDestZipCode | string |
String length: inclusive between 0 and 10 |
|
| InvDiscountPerItem | decimal? |
None. |
|
| InvDutyAmount | decimal? |
None. |
|
| InvFreightAmount | decimal? |
None. |
|
| InvLineItemDiscountRate | string |
None. |
|
| InvLineItemTaxRate | string |
None. |
|
| InvLineItemTotal | decimal? |
None. |
|
| InvLineItemVATTaxAmount | decimal? |
None. |
|
| InvLineItemVATTaxRate | string |
None. |
|
| InvLocalTaxAmount | decimal? |
None. |
|
| InvLocalTaxItmLevel | decimal? |
None. |
|
| InvLocalTaxRate | string |
None. |
|
| InvMerchantVATRegistrationNumber | string |
String length: inclusive between 0 and 20 |
|
| InvNationalTaxAmount | decimal? |
None. |
|
| InvNationalTaxItmLevel | decimal? |
None. |
|
| InvNationalTaxRate | string |
None. |
|
| InvNetGrossIndicator | string |
String length: inclusive between 0 and 1 |
|
| InvoiceAge | int |
None. |
|
| InvoiceStatus | InvoiceStatusType |
None. |
|
| InvOrderDisAmtOrdLevel | string |
String length: inclusive between 0 and 11 |
|
| InvProductCode | string |
String length: inclusive between 0 and 12 |
|
| InvProductName | string |
String length: inclusive between 0 and 35 |
|
| InvProductSKU | string |
String length: inclusive between 0 and 30 |
|
| InvPstTaxRegNum | string |
String length: inclusive between 0 and 15 |
|
| InvPurchaseID | string |
String length: inclusive between 0 and 25 |
|
| InvPurchaseIDItmLevel | string |
String length: inclusive between 0 and 23 |
|
| InvQuantity | int? |
None. |
|
| InvRequestorName | string |
String length: inclusive between 0 and 38 |
|
| InvShipFromZipCode | string |
String length: inclusive between 0 and 10 |
|
| InvSummaryCommodityCode | string |
String length: inclusive between 0 and 4 |
|
| InvSupplierOrdRef | string |
String length: inclusive between 0 and 25 |
|
| InvTaxAmount | decimal? |
None. |
|
| InvTaxRate | string |
String length: inclusive between 0 and 5 |
|
| InvUnitCost | decimal? |
None. |
|
| InvUnitMeasure | string |
String length: inclusive between 0 and 12 |
|
| InvVatRefNumber | string |
String length: inclusive between 0 and 15 |
|
| InvVatRegNumber | string |
String length: inclusive between 0 and 13 |
|
| InvVatTaxAmount | decimal? |
None. |
|
| InvVatTaxRate | string |
String length: inclusive between 0 and 5 |
|
| IsCreditMemo | boolean |
None. |
|
| IsExpired | boolean |
None. |
|
| IsPaidOther | boolean |
None. |
|
| IsPartiallyApplied | boolean |
None. |
|
| IsPayable | boolean |
None. |
|
| IsReadOnly | boolean |
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 |
|
| PaymentAmountOptions | Dictionary of PaymentAmountOptions [key] and decimal [value] |
None. |
|
| PaymentInstrumentBlock | Collection of string |
None. |
|
| PaymentInstrumentBlock | string |
None. |
|
| PaymentInstrumentBlockDescriptor | 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. |
|
| ReferenceNumber | string |
String length: inclusive between 0 and 100 |
|
| State | string |
String length: inclusive between 0 and 2 |
|
| StatementDate | date-time? |
None. |
|
| Status | InvoiceStatusType |
None. |
|
| Stopped | boolean |
None. |
|
| TaxType | string |
None. |
|
| TotalAccountBalance | decimal? |
None. |
|
| Zip | string |
String length: inclusive between 0 and 10 |