GET Api/Invoice?CustomerToken={CustomerToken}&MasterEntityLevel={MasterEntityLevel}&OnlyOneTime={OnlyOneTime}&Page={Page}&PageSize={PageSize}&AmountDueFrom={AmountDueFrom}&AmountDueTo={AmountDueTo}&AsCustomer={AsCustomer}&BillerInvoiceNo={BillerInvoiceNo}&BillingAccountID={BillingAccountID}&CreditMemos={CreditMemos}&DueDateFrom={DueDateFrom}&DueDateTo={DueDateTo}&Filter={Filter}&HideExpired={HideExpired}&IncludeCreditMemos={IncludeCreditMemos}&InvoiceAgeFrom={InvoiceAgeFrom}&InvoiceAgeTo={InvoiceAgeTo}&LookbackDate={LookbackDate}&Name={Name}&OtherData={OtherData}&ReferenceNumber={ReferenceNumber}&Sort={Sort}&StatementDateFrom={StatementDateFrom}&StatementDateTo={StatementDateTo}&Type={Type}

Searches for an existing invoice in the system.

Request Information

URI Parameters

Name	Description	Type	Additional information
AmountDueFrom		decimal?	None.
AmountDueTo		decimal?	None.
AsCustomer		boolean	None.
BillerInvoiceNo		string	String length: inclusive between 0 and 50
BillingAccountID		long?	None.
CreditMemos		boolean	None.
CustomerToken	For enrolled invoice search requests, contains the unique customer token used to identify the customer performing the search.	string	None.
DueDateFrom		date-time?	None.
DueDateTo		date-time?	None.
Filter		string	String length: inclusive between 0 and 2048
HideExpired		boolean	None.
IncludeCreditMemos		boolean	None.
InvoiceAgeFrom		int?	None.
InvoiceAgeTo		int?	None.
LookbackDate		date-time?	None.
MasterEntityLevel	If set to True, will cause all the invoices for all billing accounts under the ME to be returned when searching for a billing account under and ME.	boolean?	None.
Name		string	None.
OnlyOneTime	Force invoice search to look up as a one-time customer only, regardless of any enrolled customers against the account.	boolean	None.
OtherData		string	String length: inclusive between 0 and 256
Page	Specifies the page to return in the result set. Defaults to 1.	int?	None.
PageSize	Specifies the number of records to return per-page. Defaults to 50.	int?	None.
ReferenceNumber		string	String length: inclusive between 0 and 256
Sort		string	String length: inclusive between 0 and 100
StatementDateFrom		date-time?	None.
StatementDateTo		date-time?	None.
Type		InvoiceViewType	None.

Body Parameters

None.

Response Information

Resource Description

Searches for an existing invoice in the system.

APIInvoiceSearchResponseModel

Name	Description	Type	Additional information
ErrorCode	Name of the error condition. See ErrorCode model for details.	ErrorCode	None.
ErrorID	Internal error identification number that uniquely identifies this specific error that occurred.	string	None.
ErrorNum	Numeric value of the ErrorCode	int	None.
Errors	List of errors that occurred when performing the requested operation.	Collection of string	None.
Result		InvoicesCompositeModel	None.
Success	Indicates sucess or failure of the REST request.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorCode": "None",
  "ErrorID": "sample string 1",
  "ErrorNum": 0,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Result": {
    "InvoiceCount": 1,
    "Invoices": [
      {
        "ActivePaymentAmount": 1.0,
        "AdditionalFields": [
          {
            "BillerId": 1,
            "FieldName": "sample string 2",
            "FieldOrder": 3,
            "FieldText": "sample string 4",
            "FieldValue": "sample string 5",
            "ID": 6,
            "InvoiceId": 7,
            "IsEditable": true,
            "IsRequired": true
          },
          {
            "BillerId": 1,
            "FieldName": "sample string 2",
            "FieldOrder": 3,
            "FieldText": "sample string 4",
            "FieldValue": "sample string 5",
            "ID": 6,
            "InvoiceId": 7,
            "IsEditable": true,
            "IsRequired": true
          }
        ],
        "AmountRemaining": 1.0,
        "BillID": 40,
        "BillingAccountID": 2,
        "DecryptedReferenceNumber": "sample string 94",
        "DefaultPaymentAmount": 3.0,
        "DiscountRate": 4.0,
        "DisplayPaymentAmountOptions": true,
        "dtDue": "2025-05-21T06:35:32.4064279Z",
        "dtStatement": "2025-05-21T06:35:32.4220536Z",
        "HasCreditMemoPayments": true,
        "HasOpenRFP": true,
        "HasPayments": true,
        "InvoiceStatus": "Active",
        "IsCreditMemo": true,
        "IsExpired": false,
        "IsPaidOther": false,
        "IsPartiallyApplied": true,
        "IsPayable": true,
        "IsReadOnly": false,
        "PaymentAmountOptions": {
          "MinimumPaymentAmount": 1.0
        },
        "PaymentInstrumentBlock": [
          "sample string 1",
          "sample string 2"
        ],
        "PaymentInstrumentBlockDescriptor": "sample string 12",
        "Stopped": true,
        "TaxType": "sample string 14",
        "Address": "sample string 15",
        "Address2": "sample string 16",
        "AmountDue": 1.0,
        "BillerInvoiceNo": "sample string 17",
        "BillerRemittanceField1": "sample string 18",
        "BillerRemittanceField2": "sample string 19",
        "BillerRemittanceField3": "sample string 20",
        "BillerRemittanceField4": "sample string 21",
        "BillerRemittanceField5": "sample string 22",
        "City": "sample string 23",
        "CompanyName": "sample string 24",
        "Country": "sample string 25",
        "CurrentCharges": 1.0,
        "CustomAttributes": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "Details": [
          {
            "ItemDesc": "sample string 1",
            "ItemFromDate": "sample string 2",
            "ItemNetAmount": "sample string 3",
            "ItemNum": "sample string 4",
            "ItemOrderQty": "sample string 5",
            "ItemQtyShipped": "sample string 6",
            "ItemToDate": "sample string 7",
            "ItemUnitPrice": "sample string 8"
          },
          {
            "ItemDesc": "sample string 1",
            "ItemFromDate": "sample string 2",
            "ItemNetAmount": "sample string 3",
            "ItemNum": "sample string 4",
            "ItemOrderQty": "sample string 5",
            "ItemQtyShipped": "sample string 6",
            "ItemToDate": "sample string 7",
            "ItemUnitPrice": "sample string 8"
          }
        ],
        "DisplayField1": "sample string 26",
        "DisplayField2": "sample string 27",
        "DisplayField3": "sample string 28",
        "DisplayField4": "sample string 29",
        "DisplayField5": "sample string 30",
        "DueDate": "2025-05-21T06:35:32.4064279Z",
        "Email": "test1@test.com",
        "EntryField1": "sample string 31",
        "EntryField2": "sample string 32",
        "EntryField3": "sample string 33",
        "EntryField4": "sample string 34",
        "EntryField5": "sample string 35",
        "ExternalID": "sample string 36",
        "Fax": "sample string 37",
        "FDICode": "sample string 38",
        "FirstName": "sample string 39",
        "ID": 40,
        "InvoiceAge": 41,
        "InvAltTaxAmount": 1.0,
        "InvAltTaxAmtItmLevel": 1.0,
        "InvAltTaxIdItmLevel": "sample string 42",
        "InvAltTaxIDOrdLevel": "sample string 43",
        "InvAltTaxID": "sample string 44",
        "InvAltTaxRate": "sample string 45",
        "InvAltTaxType": "sample string 46",
        "InvAltTaxTypeApp": "sample string 47",
        "InvCommodityCode": "sample string 48",
        "InvCustomerCode": "sample string 49",
        "InvDestAddress1": "sample string 50",
        "InvDestAddress2": "sample string 51",
        "InvDestCardholderName": "sample string 52",
        "InvDestCity": "sample string 53",
        "InvDestCountryCode": "sample string 54",
        "InvDestStateCode": "sample string 55",
        "InvDestZipCode": "sample string 56",
        "InvDiscountPerItem": 1.0,
        "InvDutyAmount": 1.0,
        "InvFreightAmount": 1.0,
        "InvLineItemTotal": 1.0,
        "InvLineItemDiscountRate": "sample string 57",
        "InvLineItemTaxRate": "sample string 58",
        "InvLineItemVATTaxAmount": 1.0,
        "InvLineItemVATTaxRate": "sample string 59",
        "InvLocalTaxAmount": 1.0,
        "InvLocalTaxItmLevel": 1.0,
        "InvLocalTaxRate": "sample string 60",
        "InvMerchantVATRegistrationNumber": "sample string 61",
        "InvNationalTaxAmount": 1.0,
        "InvNationalTaxItmLevel": 1.0,
        "InvNationalTaxRate": "sample string 62",
        "InvNetGrossIndicator": "sample string 63",
        "InvOrderDisAmtOrdLevel": "sample string 64",
        "InvProductCode": "sample string 65",
        "InvProductName": "sample string 66",
        "InvProductSKU": "sample string 67",
        "InvPurchaseID": "sample string 68",
        "InvPurchaseIDItmLevel": "sample string 69",
        "InvPstTaxRegNum": "sample string 70",
        "InvRequestorName": "sample string 71",
        "InvQuantity": 1,
        "InvShipFromZipCode": "sample string 72",
        "InvSummaryCommodityCode": "sample string 73",
        "InvSupplierOrdRef": "sample string 74",
        "InvTaxAmount": 1.0,
        "InvTaxRate": "sample string 75",
        "InvUnitCost": 1.0,
        "InvUnitMeasure": "sample string 76",
        "InvVatRefNumber": "sample string 77",
        "InvVatRegNumber": "sample string 78",
        "InvVatTaxAmount": 1.0,
        "InvVatTaxRate": "sample string 79",
        "LastName": "sample string 80",
        "MerchantDescriptor": "sample string 81",
        "MerchantDescriptorAlt": "sample string 82",
        "MerchantDescriptorCity": "sample string 83",
        "MerchantDescriptorContact": "sample string 84",
        "MerchantDescriptorCountry": "sample string 85",
        "MerchantDescriptorState": "sample string 86",
        "MerchantDescriptorStreet": "sample string 87",
        "MerchantDescriptorZip": "sample string 88",
        "Message_OutstandingBalance": "sample string 89",
        "MiddleName": "sample string 90",
        "MinimumAmountDue": 1.0,
        "OtherData": "sample string 91",
        "PaymentReceived": 1.0,
        "PaymentsPostedAsOfDate": "2025-05-21T06:35:32.4220536Z",
        "PayThisAmount": 1.0,
        "Phone": "sample string 93",
        "Prev_0To30Days": 1.0,
        "Prev_30To60Days": 1.0,
        "Prev_60To90Days": 1.0,
        "Prev_90DaysPlus": 1.0,
        "PreviousBalance": 1.0,
        "ReferenceNumber": "sample string 94",
        "State": "sample string 95",
        "StatementDate": "2025-05-21T06:35:32.4220536Z",
        "Status": "Active",
        "TotalAccountBalance": 1.0,
        "Zip": "sample string 96"
      },
      {
        "ActivePaymentAmount": 1.0,
        "AdditionalFields": [
          {
            "BillerId": 1,
            "FieldName": "sample string 2",
            "FieldOrder": 3,
            "FieldText": "sample string 4",
            "FieldValue": "sample string 5",
            "ID": 6,
            "InvoiceId": 7,
            "IsEditable": true,
            "IsRequired": true
          },
          {
            "BillerId": 1,
            "FieldName": "sample string 2",
            "FieldOrder": 3,
            "FieldText": "sample string 4",
            "FieldValue": "sample string 5",
            "ID": 6,
            "InvoiceId": 7,
            "IsEditable": true,
            "IsRequired": true
          }
        ],
        "AmountRemaining": 1.0,
        "BillID": 40,
        "BillingAccountID": 2,
        "DecryptedReferenceNumber": "sample string 94",
        "DefaultPaymentAmount": 3.0,
        "DiscountRate": 4.0,
        "DisplayPaymentAmountOptions": true,
        "dtDue": "2025-05-21T06:35:32.4064279Z",
        "dtStatement": "2025-05-21T06:35:32.4220536Z",
        "HasCreditMemoPayments": true,
        "HasOpenRFP": true,
        "HasPayments": true,
        "InvoiceStatus": "Active",
        "IsCreditMemo": true,
        "IsExpired": false,
        "IsPaidOther": false,
        "IsPartiallyApplied": true,
        "IsPayable": true,
        "IsReadOnly": false,
        "PaymentAmountOptions": {
          "MinimumPaymentAmount": 1.0
        },
        "PaymentInstrumentBlock": [
          "sample string 1",
          "sample string 2"
        ],
        "PaymentInstrumentBlockDescriptor": "sample string 12",
        "Stopped": true,
        "TaxType": "sample string 14",
        "Address": "sample string 15",
        "Address2": "sample string 16",
        "AmountDue": 1.0,
        "BillerInvoiceNo": "sample string 17",
        "BillerRemittanceField1": "sample string 18",
        "BillerRemittanceField2": "sample string 19",
        "BillerRemittanceField3": "sample string 20",
        "BillerRemittanceField4": "sample string 21",
        "BillerRemittanceField5": "sample string 22",
        "City": "sample string 23",
        "CompanyName": "sample string 24",
        "Country": "sample string 25",
        "CurrentCharges": 1.0,
        "CustomAttributes": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "Details": [
          {
            "ItemDesc": "sample string 1",
            "ItemFromDate": "sample string 2",
            "ItemNetAmount": "sample string 3",
            "ItemNum": "sample string 4",
            "ItemOrderQty": "sample string 5",
            "ItemQtyShipped": "sample string 6",
            "ItemToDate": "sample string 7",
            "ItemUnitPrice": "sample string 8"
          },
          {
            "ItemDesc": "sample string 1",
            "ItemFromDate": "sample string 2",
            "ItemNetAmount": "sample string 3",
            "ItemNum": "sample string 4",
            "ItemOrderQty": "sample string 5",
            "ItemQtyShipped": "sample string 6",
            "ItemToDate": "sample string 7",
            "ItemUnitPrice": "sample string 8"
          }
        ],
        "DisplayField1": "sample string 26",
        "DisplayField2": "sample string 27",
        "DisplayField3": "sample string 28",
        "DisplayField4": "sample string 29",
        "DisplayField5": "sample string 30",
        "DueDate": "2025-05-21T06:35:32.4064279Z",
        "Email": "test1@test.com",
        "EntryField1": "sample string 31",
        "EntryField2": "sample string 32",
        "EntryField3": "sample string 33",
        "EntryField4": "sample string 34",
        "EntryField5": "sample string 35",
        "ExternalID": "sample string 36",
        "Fax": "sample string 37",
        "FDICode": "sample string 38",
        "FirstName": "sample string 39",
        "ID": 40,
        "InvoiceAge": 41,
        "InvAltTaxAmount": 1.0,
        "InvAltTaxAmtItmLevel": 1.0,
        "InvAltTaxIdItmLevel": "sample string 42",
        "InvAltTaxIDOrdLevel": "sample string 43",
        "InvAltTaxID": "sample string 44",
        "InvAltTaxRate": "sample string 45",
        "InvAltTaxType": "sample string 46",
        "InvAltTaxTypeApp": "sample string 47",
        "InvCommodityCode": "sample string 48",
        "InvCustomerCode": "sample string 49",
        "InvDestAddress1": "sample string 50",
        "InvDestAddress2": "sample string 51",
        "InvDestCardholderName": "sample string 52",
        "InvDestCity": "sample string 53",
        "InvDestCountryCode": "sample string 54",
        "InvDestStateCode": "sample string 55",
        "InvDestZipCode": "sample string 56",
        "InvDiscountPerItem": 1.0,
        "InvDutyAmount": 1.0,
        "InvFreightAmount": 1.0,
        "InvLineItemTotal": 1.0,
        "InvLineItemDiscountRate": "sample string 57",
        "InvLineItemTaxRate": "sample string 58",
        "InvLineItemVATTaxAmount": 1.0,
        "InvLineItemVATTaxRate": "sample string 59",
        "InvLocalTaxAmount": 1.0,
        "InvLocalTaxItmLevel": 1.0,
        "InvLocalTaxRate": "sample string 60",
        "InvMerchantVATRegistrationNumber": "sample string 61",
        "InvNationalTaxAmount": 1.0,
        "InvNationalTaxItmLevel": 1.0,
        "InvNationalTaxRate": "sample string 62",
        "InvNetGrossIndicator": "sample string 63",
        "InvOrderDisAmtOrdLevel": "sample string 64",
        "InvProductCode": "sample string 65",
        "InvProductName": "sample string 66",
        "InvProductSKU": "sample string 67",
        "InvPurchaseID": "sample string 68",
        "InvPurchaseIDItmLevel": "sample string 69",
        "InvPstTaxRegNum": "sample string 70",
        "InvRequestorName": "sample string 71",
        "InvQuantity": 1,
        "InvShipFromZipCode": "sample string 72",
        "InvSummaryCommodityCode": "sample string 73",
        "InvSupplierOrdRef": "sample string 74",
        "InvTaxAmount": 1.0,
        "InvTaxRate": "sample string 75",
        "InvUnitCost": 1.0,
        "InvUnitMeasure": "sample string 76",
        "InvVatRefNumber": "sample string 77",
        "InvVatRegNumber": "sample string 78",
        "InvVatTaxAmount": 1.0,
        "InvVatTaxRate": "sample string 79",
        "LastName": "sample string 80",
        "MerchantDescriptor": "sample string 81",
        "MerchantDescriptorAlt": "sample string 82",
        "MerchantDescriptorCity": "sample string 83",
        "MerchantDescriptorContact": "sample string 84",
        "MerchantDescriptorCountry": "sample string 85",
        "MerchantDescriptorState": "sample string 86",
        "MerchantDescriptorStreet": "sample string 87",
        "MerchantDescriptorZip": "sample string 88",
        "Message_OutstandingBalance": "sample string 89",
        "MiddleName": "sample string 90",
        "MinimumAmountDue": 1.0,
        "OtherData": "sample string 91",
        "PaymentReceived": 1.0,
        "PaymentsPostedAsOfDate": "2025-05-21T06:35:32.4220536Z",
        "PayThisAmount": 1.0,
        "Phone": "sample string 93",
        "Prev_0To30Days": 1.0,
        "Prev_30To60Days": 1.0,
        "Prev_60To90Days": 1.0,
        "Prev_90DaysPlus": 1.0,
        "PreviousBalance": 1.0,
        "ReferenceNumber": "sample string 94",
        "State": "sample string 95",
        "StatementDate": "2025-05-21T06:35:32.4220536Z",
        "Status": "Active",
        "TotalAccountBalance": 1.0,
        "Zip": "sample string 96"
      }
    ],
    "TotalBalance": 2.0
  },
  "Success": true
}