get https://api.revolv3.com/api/Invoices
This API allows you to search for invoices based on the following optional criteria:
- Merchant Customer Ref ID
- Merchant Invoice Ref ID
- Start Date
- End Date
Query Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
merchantCustomerRefID | String | A unique reference ID associated with the customer. | No |
merchantInvoiceRefID | String | A unique reference ID associated with the invoice. | No |
startDate | Date | The start date for filtering invoices, in the format 'YYYY-MM-DD'. Used to filter based on billing date. | No |
endDate | Date | The end date for filtering invoices, in the format 'YYYY-MM-DD'. Used to filter based on billing date. | No |
page | Integer | The page number for pagination. Starts from 1. Default: 1. | No |
pageSize | Integer | The number of records per page. Default: 100. Max value: ___ | No |
Response Body Parameters
| Parameter | Type | Description |
|---|---|---|
invoiceId | Integer | Unique identifier for the invoice. |
customerId | Integer | Unique identifier for the customer. |
merchantInvoiceRefId | String | Reference ID associated with the merchant's invoice. |
binNumber | String | Bank Identification Number associated with the invoice. |
last4Digit | String | Last four digits of a card number. |
invoiceStatus | String | Status of the invoice. |
subtotal | Decimal | Subtotal amount of the invoice. |
tax | Decimal | Tax amount applied to the invoice. |
total | Decimal | Total amount including tax. |
billingDate | String | Date when the invoice was billed. |
merchantLegalName | String | Legal name of the merchant. |
merchantCustomerRefId | String | Customer reference ID provided by the merchant. |
customerFirstName | String | First name of the customer. |
customerLastName | String | Last name of the customer. |