List invoices

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

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200200 - List Invoices with Minimal request

application/json

Body

示例

{
    "items": [
        {
            "id": "INV2-GWNR-QBAW-496B-4Y5P",
            "status": "DRAFT",
            "detail": {
                "reference": "<The reference data. Includes a post office (PO) number.>",
                "currency_code": "USD",
                "note": "<A note to the invoice recipient. Also appears on the invoice notification email.>",
                "memo": "<A private bookkeeping note for merchant.>",
                "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": "<The reference data. Includes a post office (PO) number.>",
                "currency_code": "USD",
                "note": "<A note to the invoice recipient. Also appears on the invoice notification email.>",
                "memo": "<A private bookkeeping note for merchant.>",
                "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"
                },
                {
                    "hr

🟢200200 - List Invoices With Pagination

🟠400400 Bad Request - Invalid Page Size

🟠401401 Unauthorized - Invalid Token

请求参数

请求示例代码

返回响应