On this page
No Headings
The invoice search parameters.
objectrecipient_emailstring^[\S\s]*$Filters the search by the email address.
recipient_first_namestring^[\S\s]*$Filters the search by the recipient first name.
recipient_last_namestring^[\S\s]*$Filters the search by the recipient last name.
recipient_business_namestring^[\S\s]*$Filters the search by the recipient business name.
invoice_numberstring^[\S\s]*$Filters the search by the invoice number.
statusarrayAn array of status values.
itemsstring"DRAFT", "SENT", "SCHEDULED", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED", "UNPAID", "PAYMENT_PENDING", "AUTO_CANCELLED", "PAID_EXTERNAL", "REFUNDED_EXTERNAL", "SHARED"The status of the invoice.
referencestring^[\S\s]*$The reference data. Includes a Purchase Order (PO) number.
currency_codestring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
memostring^[\S\s]*$A private bookkeeping memo for the user.
total_amount_rangeobjectThe amount range.
Filters the search by the total amount.
lower_amountrequiredobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The lower limit of the amount range.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.upper_amountrequiredobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The upper limit of the amount range.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.invoice_date_rangeobjectThe date range. Filters invoices by creation date, invoice date, due date, and payment date.
Filters the search by a date range for the invoice, in Internet date and time format.
startrequiredobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The start date of the range. Filters invoices by creation date, invoice date, due date, and payment date.
endrequiredobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The end date of the range. Filters invoices by creation date, invoice date, due date, and payment date.
due_date_rangeobjectThe date range. Filters invoices by creation date, invoice date, due date, and payment date.
Filters the search by a due date range for the invoice, in Internet date and time format.
startrequiredobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The start date of the range. Filters invoices by creation date, invoice date, due date, and payment date.
endrequiredobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The end date of the range. Filters invoices by creation date, invoice date, due date, and payment date.
payment_date_rangeobjectThe date and time range. Filters invoices by creation date, invoice date, due date, and payment date.
startrequiredobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The start date of the range. Filters invoices by creation date, invoice date, due date, and payment date.
endrequiredobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The end date of the range. Filters invoices by creation date, invoice date, due date, and payment date.
Note: The regular expression provides guidance but does not reject all invalid dates.
^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T,t:[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$creation_date_rangeobjectThe date and time range. Filters invoices by creation date, invoice date, due date, and payment date.
Filters the search by a creation date range for the invoice, in Internet date and time format.
startrequiredobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The start date of the range. Filters invoices by creation date, invoice date, due date, and payment date.
endrequiredobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The end date of the range. Filters invoices by creation date, invoice date, due date, and payment date.
Note: The regular expression provides guidance but does not reject all invalid dates.
^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T,t:[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$archivedbooleanIndicates whether to list merchant-archived invoices in the response. Value is:
true. Response lists only merchant-archived invoices.false. Response lists only unarchived invoices.null. Response lists all invoices.fieldsarrayA CSV file of fields to return for the user, if available. Because the invoice object can be very large, field filtering is required. Valid collection fields are items, payments, refunds, additional_recipients_info, and attachments.
itemsstring^[\S\s]*$The name of the field.