Billing Presentment - Query Invoice
Search for invoices in Billing Presentment database.
| Variable | Required | Max Size | Value | Notes |
| publisher-name | Mandatory | NA | Gateway account username issued to you. | |
| publisher-password | Mandatory | NA | Remote Client Password - This is different then the password used to login. | |
| mode | Mandatory | NA | query_client | Value needs to be set to ‘query_invoice’ |
| client | Optional | NA | Used to modify system behavior to support specific client software. | |
| qresp | Optional | NA | simple | When specified limits the invoice data to only those fields minimally required to interact with the invoice.(assumes full invoice details should be returned when not specified) |
| fuzzflg | Optional | 1 | 1 | Match using partial info provided. (Assumes exact match when not specified) |
| status | Optional | 20 | open,closed,hidden,merged,paid,expired,unpaid | The value of this field, will represent the type of invoice you are seeking. [When not specified, all invoices will be assumed]open - represents invoices which are open/unpaid.closed - represents invoices which were revoked, but can still be seen.hidden - represents invoices which the client cannot see.merged - represents invoices which were merged into another invoice.paid - represents invoices which have been paid.expired - represents open invoices which have passed its expire date.unpaid - represents open invoices which have not expired and may still be paid. |
| Optional | 250 | customer@domain.com | Email address of customer (single email address only) | |
| invoices | Optional | 10 | enter_date,expire_date | Used to filter response.Requires startdate and enddate to be included, when this is defined.enter_date - limits results to only invoices which have an enter_date within specified date range.expire_date - limits results to only invoices which have an expire_date within specified date range.Assumes all invoices when not defined. |
| startdate | Optional | 8 | YYYYMMDD | Start date for ‘invoices’ search criteria. |
| enddate | Optional | 8 | YYYYMMDD | End date for ‘invoices’ search criteria. |
| invoice_no | Optional | 24 | Invoice number on the customer’s bill. | |
| alias | Optional | 24 | Customer’s alias.When specified, will retrieve email of matching client and use that in in place of ’email’ field. (Only use when ‘alias’ is unique for each client on file.) | |
| account_no | Optional | 24 | Account number on the customer’s bill. | |
| orderid | Optional | 20 | Unique numeric order ID of the transaction. | |
| shipname | Optional | 40 | Shipping Name as it should appear in invoices. | |
| shipcompany | Optional | 40 | Shipping Company as it should appear in invoices. | |
| shipaddr1 | Optional | 40 | Shipping address line 1 as it should appear in invoices. | |
| shipaddr2 | Optional | 40 | Shipping address line 2 as it should appear in invoices. | |
| shipcity | Optional | 40 | Shipping City as it should appear in invoices. | |
| shipstate | Optional | 2 | Shipping State as it should appear in invoices. 2 Char. State Code | |
| shipzip | Optional | 14 | Shipping Zip Code as it should appear in invoices. | |
| shipcountry | Optional | 2 | Shipping Country as it should appear in invoices. 2 Char. Country Code | |
| amount_min | Optional | 10 | 1234.56 format | Limits results to invoices greater-than or equal-to the amount indicated. |
| amount_max | Optional | 10 | 1234.56 format | Limits results to invoices less-than or equal-to the amount indicated. |
Notes:
Returns FinalStatus, MErrMsg, aux-msg, TranCount, resp-code, aXXXXX
Each aXXXXX contains the details of a single invoice.
For open/unpaid invoices, which have not yet expired, you may also see the following fields in the aXXXXX data:
-
payment_amt - recommended/calculated amount of the invoice payment due
-
payment_type - type of payment the ‘payment_amt’ was for
And should overpayment be permitted, you may also see:
-
payment_min - minimum amount of payment that can be specified
-
payment_max - maximum amount of payment that can be specified