List invoices

GET {{base_url}}/v2/invoicing/invoices?page=1&page_size=10&total_required=true&fields=amount

Lists invoices. To filter the invoices that appear in the response, you can specify one or more optional query parameters.

Request Params

| Key | Datatype | Required | Description | | page | number | | The page number to be retrieved, for the list of items. So, a combination of page=1 and page_size=20 returns the first 20 invoices. A combination of page=2 and page_size=20 returns the next 20 invoices. | | page_size | number | | The maximum number of invoices to return in the response. | | total_required | boolean | | Indicates whether the to show <code>total_pages</code> and <code>total_items</code> in the response. | | fields | string | | A comma-separated list of additional fields to return, if available. |

HEADERS

| Key | Datatype | Required | Description | | Content-Type | string | | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. | | PayPal-Request-Id | string | | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. | | PayPal-Client-Metadata-Id | string | | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. | | PayPal-Partner-Attribution-Id | string | | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. | | PayPal-Auth-Assertion | string | | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant. | | Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> | | Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |

RESPONSES

status: OK

{"total_pages":4,"total_items":33,"items":[{"id":"INV2-GWNR-QBAW-496B-4Y5P","status":"DRAFT","detail":{"reference":"\u003cThe reference data. Includes a post office (PO) number.\u003e","currency_code":"USD","note":"\u003cA note to the invoice recipient. Also appears on the invoice notification email.\u003e","memo":"\u003cA private bookkeeping note for merchant.\u003e","invoice_number":"1643943687","invoice_date":"2022-02-04","payment_term":{"due_date":"2022-02-14"},"viewed_by_recipient":false,"group_draft":false,"metadata":{"create_time":"2022-02-04T03:01:26Z"}},"primary_recipients":[{"billing_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"},"email_address":"foobuyer@example.com"},"shipping_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"}}}],"amount":{"currency_code":"USD","value":"74.21"},"due_amount":{"currency_code":"USD","value":"74.21"},"links":[{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-GWNR-QBAW-496B-4Y5P","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-GWNR-QBAW-496B-4Y5P/send","rel":"send","method":"POST"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-GWNR-QBAW-496B-4Y5P","rel":"replace","method":"PUT"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-GWNR-QBAW-496B-4Y5P","rel":"delete","method":"DELETE"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-GWNR-QBAW-496B-4Y5P/payments","rel":"record-payment","method":"POST"}]},{"id":"INV2-K9Z3-8X6H-YZA9-WAXD","status":"DRAFT","detail":{"reference":"\u003cThe reference data. Includes a post office (PO) number.\u003e","currency_code":"USD","note":"\u003cA note to the invoice recipient. Also appears on the invoice notification email.\u003e","memo":"\u003cA private bookkeeping note for merchant.\u003e","invoice_number":"1643943679","invoice_date":"2022-02-04","payment_term":{"due_date":"2022-02-14"},"viewed_by_recipient":false,"group_draft":false,"metadata":{"create_time":"2022-02-04T03:01:19Z"}},"primary_recipients":[{"billing_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"},"email_address":"foobuyer@example.com"},"shipping_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"}}}],"amount":{"currency_code":"USD","value":"74.21"},"due_amount":{"currency_code":"USD","value":"74.21"},"links":[{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-K9Z3-8X6H-YZA9-WAXD","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-K9Z3-8X6H-YZA9-WAXD/send","rel":"send","method":"POST"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-K9Z3-8X6H-YZA9-WAXD","rel":"replace","method":"PUT"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-K9Z3-8X6H-YZA9-WAXD","rel":"delete","method":"DELETE"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-K9Z3-8X6H-YZA9-WAXD/payments","rel":"record-payment","method":"POST"}]},{"id":"INV2-Z53A-M2DL-3DED-EDP7","status":"DRAFT","detail":{"reference":"\u003cThe reference data. Includes a post office (PO) number.\u003e","currency_code":"USD","note":"\u003cA note to the invoice recipient. Also appears on the invoice notification email.\u003e","memo":"\u003cA private bookkeeping note for merchant.\u003e","invoice_number":"1643943411","invoice_date":"2022-02-04","payment_term":{"due_date":"2022-02-14"},"viewed_by_recipient":false,"group_draft":false,"metadata":{"create_time":"2022-02-04T02:56:51Z"}},"primary_recipients":[{"billing_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"},"email_address":"foobuyer@gmail.com"},"shipping_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"}}}],"amount":{"currency_code":"USD","value":"74.21"},"due_amount":{"currency_code":"USD","value":"74.21"},"links":[{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-Z53A-M2DL-3DED-EDP7","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-Z53A-M2DL-3DED-EDP7/send","rel":"send","method":"POST"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-Z53A-M2DL-3DED-EDP7","rel":"replace","method":"PUT"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-Z53A-M2DL-3DED-EDP7","rel":"delete","method":"DELETE"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-Z53A-M2DL-3DED-EDP7/payments","rel":"record-payment","method":"POST"}]},{"id":"INV2-Z3KT-GBE7-6667-YEKU","status":"DRAFT","detail":{"reference":"\u003cThe reference data. Includes a post office (PO) number.\u003e","currency_code":"USD","note":"\u003cA note to the invoice recipient. Also appears on the invoice notification email.\u003e","memo":"\u003cA private bookkeeping note for merchant.\u003e","invoice_number":"1643943215","invoice_date":"2022-02-04","payment_term":{"due_date":"2022-02-14"},"viewed_by_recipient":false,"group_draft":false,"metadata":{"create_time":"2022-02-04T02:53:35Z"}},"primary_recipients":[{"billing_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"},"email_address":"foobuyer@gmail.com"},"shipping_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"}}}],"amount":{"currency_code":"USD","value":"74.21"},"due_amount":{"currency_code":"USD","value":"74.21"},"links":[{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-Z3KT-GBE7-6667-YEKU","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-Z3KT-GBE7-6667-YEKU/send","rel":"send","method":"POST"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-Z3KT-GBE7-6667-YEKU","rel":"replace","method":"PUT"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-Z3KT-GBE7-6667-YEKU","rel":"delete","method":"DELETE"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-Z3KT-GBE7-6667-YEKU/payments","rel":"record-payment","method":"POST"}]},{"id":"INV2-D7SP-L8SF-U6CS-CNBW","status":"DRAFT","detail":{"reference":"\u003cThe reference data. Includes a post office (PO) number.\u003e","currency_code":"USD","note":"\u003cA note to the invoice recipient. Also appears on the invoice notification email.\u003e","memo":"\u003cA private bookkeeping note for merchant.\u003e","invoice_number":"1643943102","invoice_date":"2022-02-04","payment_term":{"due_date":"2022-02-14"},"viewed_by_recipient":false,"group_draft":false,"metadata":{"create_time":"2022-02-04T02:51:43Z"}},"primary_recipients":[{"billing_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"},"email_address":"foobuyer@gmail.com"},"shipping_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"}}}],"amount":{"currency_code":"USD","value":"74.21"},"due_amount":{"currency_code":"USD","value":"74.21"},"links":[{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-D7SP-L8SF-U6CS-CNBW","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-D7SP-L8SF-U6CS-CNBW/send","rel":"send","method":"POST"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-D7SP-L8SF-U6CS-CNBW","rel":"replace","method":"PUT"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-D7SP-L8SF-U6CS-CNBW","rel":"delete","method":"DELETE"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-D7SP-L8SF-U6CS-CNBW/payments","rel":"record-payment","method":"POST"}]},{"id":"INV2-P9YA-M4QP-WFDY-T3QW","status":"DRAFT","detail":{"reference":"deal-ref","currency_code":"USD","note":"\u003cA note to the invoice recipient. Also appears on the invoice notification email.\u003e","memo":"\u003cA private bookkeeping note for merchant.\u003e","invoice_number":"1643943018","invoice_date":"2022-02-04","payment_term":{"due_date":"2022-02-14"},"viewed_by_recipient":false,"group_draft":false,"metadata":{"create_time":"2022-02-04T02:50:18Z"}},"primary_recipients":[{"billing_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"},"email_address":"foobuyer@gmail.com"},"shipping_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"}}}],"amount":{"currency_code":"USD","value":"74.21"},"due_amount":{"currency_code":"USD","value":"74.21"},"links":[{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-P9YA-M4QP-WFDY-T3QW","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-P9YA-M4QP-WFDY-T3QW/send","rel":"send","method":"POST"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-P9YA-M4QP-WFDY-T3QW","rel":"replace","method":"PUT"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-P9YA-M4QP-WFDY-T3QW","rel":"delete","method":"DELETE"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-P9YA-M4QP-WFDY-T3QW/payments","rel":"record-payment","method":"POST"}]},{"id":"INV2-9PSC-2JBY-QGAS-X3JY","status":"DRAFT","detail":{"reference":"deal-ref","currency_code":"USD","note":"\u003cA note to the invoice recipient. Also appears on the invoice notification email.\u003e","memo":"\u003cA private bookkeeping note for merchant.\u003e","invoice_number":"1643943005","invoice_date":"2022-02-04","payment_term":{"due_date":"2022-02-14"},"viewed_by_recipient":false,"group_draft":false,"metadata":{"create_time":"2022-02-04T02:50:04Z"}},"primary_recipients":[{"billing_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"},"email_address":"foobuyer@gmail.com"},"shipping_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"}}}],"amount":{"currency_code":"USD","value":"74.21"},"due_amount":{"currency_code":"USD","value":"74.21"},"links":[{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-9PSC-2JBY-QGAS-X3JY","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-9PSC-2JBY-QGAS-X3JY/send","rel":"send","method":"POST"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-9PSC-2JBY-QGAS-X3JY","rel":"replace","method":"PUT"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-9PSC-2JBY-QGAS-X3JY","rel":"delete","method":"DELETE"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-9PSC-2JBY-QGAS-X3JY/payments","rel":"record-payment","method":"POST"}]},{"id":"INV2-RHB4-CNP6-5D4Z-7PJK","status":"DRAFT","detail":{"reference":"deal-ref","currency_code":"USD","note":"\u003cA note to the invoice recipient. Also appears on the invoice notification email.\u003e","memo":"\u003cA private bookkeeping note for merchant.\u003e","invoice_number":"1643942957","invoice_date":"2022-02-04","payment_term":{"due_date":"2022-02-14"},"viewed_by_recipient":false,"group_draft":false,"metadata":{"create_time":"2022-02-04T02:49:17Z"}},"primary_recipients":[{"billing_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"},"email_address":"foobuyer@gmail.com"},"shipping_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"}}}],"amount":{"currency_code":"USD","value":"74.21"},"due_amount":{"currency_code":"USD","value":"74.21"},"links":[{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-RHB4-CNP6-5D4Z-7PJK","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-RHB4-CNP6-5D4Z-7PJK/send","rel":"send","method":"POST"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-RHB4-CNP6-5D4Z-7PJK","rel":"replace","method":"PUT"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-RHB4-CNP6-5D4Z-7PJK","rel":"delete","method":"DELETE"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-RHB4-CNP6-5D4Z-7PJK/payments","rel":"record-payment","method":"POST"}]},{"id":"INV2-4SL5-33HQ-E8TA-2GLW","status":"DRAFT","detail":{"reference":"deal-ref","currency_code":"USD","note":"\u003cA note to the invoice recipient. Also appears on the invoice notification email.\u003e","memo":"\u003cA private bookkeeping note for merchant.\u003e","invoice_number":"1643942944","invoice_date":"2022-02-04","payment_term":{"due_date":"2022-02-14"},"viewed_by_recipient":false,"group_draft":false,"metadata":{"create_time":"2022-02-04T02:49:04Z"}},"primary_recipients":[{"billing_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"},"email_address":"foobuyer@gmail.com"},"shipping_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"}}}],"amount":{"currency_code":"USD","value":"74.21"},"due_amount":{"currency_code":"USD","value":"74.21"},"links":[{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-4SL5-33HQ-E8TA-2GLW","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-4SL5-33HQ-E8TA-2GLW/send","rel":"send","method":"POST"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-4SL5-33HQ-E8TA-2GLW","rel":"replace","method":"PUT"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-4SL5-33HQ-E8TA-2GLW","rel":"delete","method":"DELETE"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-4SL5-33HQ-E8TA-2GLW/payments","rel":"record-payment","method":"POST"}]},{"id":"INV2-JML4-DM39-5WQJ-CR6T","status":"DRAFT","detail":{"reference":"deal-ref","currency_code":"USD","note":"A note to the invoice recipient. Also appears on the invoice notification email.","memo":"This is a long contract","invoice_number":"1643942812","invoice_date":"2022-02-04","payment_term":{"due_date":"2022-02-14"},"viewed_by_recipient":false,"group_draft":false,"metadata":{"create_time":"2022-02-04T02:46:52Z"}},"primary_recipients":[{"billing_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"},"email_address":"foobuyer@gmail.com"},"shipping_info":{"name":{"given_name":"Stephanie","surname":"Meyers","full_name":"Stephanie Meyers"}}}],"amount":{"currency_code":"USD","value":"74.21"},"due_amount":{"currency_code":"USD","value":"74.21"},"links":[{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-JML4-DM39-5WQJ-CR6T","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-JML4-DM39-5WQJ-CR6T/send","rel":"send","method":"POST"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-JML4-DM39-5WQJ-CR6T","rel":"replace","method":"PUT"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-JML4-DM39-5WQJ-CR6T","rel":"delete","method":"DELETE"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-JML4-DM39-5WQJ-CR6T/payments","rel":"record-payment","method":"POST"}]}],"links":[{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices?page=1\u0026page_size=10\u0026total_required=true","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/invoicing/invoices?page=2\u0026page_size=10\u0026total_required=true","rel":"next","method":"GET"}]}