On this page
No Headings
The invoice search parameters.
objectemailstringThe initial letters of the email address.
recipient_first_namestringThe initial letters of the recipient's first name.
recipient_last_namestringThe initial letters of the recipient's last name.
recipient_business_namestringThe initial letters of the recipient's business name.
numberstringAny part of the invoice number.
statusstring"DRAFT", "SENT", "SCHEDULED", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED"The invoice status. To search by status, specify this value as an array. For example, "status": ["REFUNDED"]. The status indicates the phase of the invoice in its lifecycle:
| Status | Occurs when |
|---|---|
CANCELLED | A merchant or customer cancels a sent invoice. |
DRAFT | A merchant creates a draft invoice. Note: A customer cannot pay an invoice until a merchant sends it. |
MARKED_AS_PAID | A merchant marks an invoice as paid after he or she receives a check or cash payment for the invoice. |
MARKED_AS_REFUNDED | A merchant marks an invoice as refunded. Note: A merchant can only mark a marked-as-paid invoice as refunded. |
PAID | A customer fully pays an invoice. It is marked as paid through one or both of these methods:
|
PARTIALLY_PAID | A merchant or customer fully pays an invoice through one or both of these methods:
|
PARTIALLY_REFUNDED | A merchant partially refunds an invoice through one or both of these methods:
|
PAYMENT_PENDING | A customer pays an invoice but the payment is pending for one of these reasons:
Note: Most payments never go into a payment-pending state. |
REFUNDED | A merchant fully refunds an invoice through one or both of these methods:
|
SCHEDULED | A merchant schedules an invoice to be emailed by PayPal on a specified date. |
SENT | A merchant sends an invoice to the customer. After the merchant sends the invoice:
|
UNPAID | A merchant sends an invoice and sets the |
lower_total_amountstringThe lower limit of the total amount.
upper_total_amountstringThe upper limit of the total amount.
start_invoice_datestringdateThe start date for the invoice, in Internet date and time format. For example, yyyy-MM-dd z.
end_invoice_datestringdateThe end date for the invoice, in Internet date and time format. For example, yyyy-MM-dd z.
start_due_datestringdateThe start due date for the invoice, in Internet date and time format. For example, yyyy-MM-dd z.
end_due_datestringdateThe end due date for the invoice, in Internet date and time format. For example, yyyy-MM-dd z.
start_payment_datestringdateThe start payment date for the invoice, in Internet date and time format. For example, yyyy-MM-dd z.
end_payment_datestringdateThe end payment date for the invoice, in Internet date and time format. For example, yyyy-MM-dd z.
start_creation_datestringdateThe start creation date for the invoice, in Internet date and time format. For example, yyyy-MM-dd z.
end_creation_datestringdateThe end creation date for the invoice, in Internet date and time format. For example, yyyy-MM-dd z.
pagenumberThe zero-relative start index of the entire list of merchant invoices to return in the response. So, a combination of page=0 and page_size=20 returns the first 20 invoices. A combination of page=20 and page_size=20 returns the next 20 invoices.
page_sizenumberThe page size for the search results.
total_count_requiredbooleanfalseIndicates whether the response shows the total count.
archivedbooleanIndicates whether to list merchant-archived invoices in the response. If true, response lists only merchant-archived invoices. If false, response lists only unarchived invoices. If null, response lists all invoices.