Paypal API
  1. Invoices
Paypal API
  • Authorization
    • Generate access_token
      POST
    • Terminate access_token
      POST
    • User Info
      GET
    • Generate client_token
      POST
  • Orders
    • Create order
      POST
    • Show order details
      GET
    • Update order
      PATCH
    • Authorize payment for order
      POST
    • Capture payment for order
      POST
  • Payments
    • Show details for authorized payment
      GET
    • Reauthorize authorized payment
      POST
    • Void authorized payment
      POST
    • Capture authorized payment
      POST
    • Show captured payment details
      GET
    • Refund captured payment
      POST
    • Show refund details
      GET
  • Invoices
    • Invoices
      • Generate invoice number
        POST
      • Create draft invoice
        POST
      • Show invoice details
        GET
      • List invoices
        GET
      • Generate QR code
        POST
      • Fully update invoice
        PUT
      • Send invoice
        POST
      • Send invoice reminder
        POST
      • Cancel sent invoice
        POST
      • Delete invoice
        DELETE
      • Search for invoices
        POST
      • Record payment for invoice
        POST
      • Delete external payment
        DELETE
      • Record refund for invoice
        POST
      • Delete external refund
        DELETE
    • Templates
      • List templates
      • Create template
      • Show template details
      • Fully update template
      • Delete template
  • Subscriptions
    • Catalog Products
      • Create product
      • List products
      • Show product details
      • Update product
    • Plans
      • Create plan
      • List plans
      • Show plan details
      • Update plan
      • Deactivate plan
      • Activate plan
      • Update pricing
    • Subscriptions
      • Create subscription
      • Show subscription details
      • Update subscription
      • Revise plan or quantity of subscription
      • Suspend subscription
      • Activate subscription
      • Cancel subscription
      • Capture authorized payment on subscription
      • List transactions for subscription
  • Payouts
    • Create batch payout
    • Show payout batch details
    • Show payout item details
    • Cancel unclaimed payout item
  • Webhooks
    • List available events
    • Create webhook
    • List webhooks
    • Show webhook details
    • List event notifications
    • List event subscriptions for webhook
    • Show event notification details
    • Trigger a sample event
    • Verify webhook signature
    • Resend event notification
    • Simulate webhook event
    • Update webhook
    • Delete webhook
  • Shipment Tracking
    • Add tracking information for multiple PayPal transactions
    • Show tracking information
    • Update or cancel tracking information for PayPal transaction
  • Transaction Search
    • List transactions
    • List all balances
  • Disputes
    • List disputes
    • Show dispute details
    • Accept claim
    • Appeal dispute
    • Settle dispute
    • Update dispute status
    • Make offer to resolve dispute
    • Provide evidence
    • Acknowledge returned item
    • Provide supporting information for dispute
    • Escalate dispute to claim
    • Accept offer to resolve dispute
    • Send message about dispute to other party
    • Deny offer to resolve dispute
    • Partially update dispute
  • Onboarding (Limited Release)
    • Manage Accounts
      • Create managed account
      • Search managed account through external id
      • Search managed account by Seller Id
      • Partially updates information for a managed account
      • Shows collection of registered wallet domains
  1. Invoices

List invoices

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

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 username:password
示例:
Authorization: Basic *****************
Query 参数
page
string 
必需
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.
示例值:
1
page_size
string 
必需
The maximum number of invoices to return in the response.
示例值:
10
total_required
string 
必需
Indicates whether the to show total_pages and total_items in the response.
示例值:
true
fields
string 
必需
A comma-separated list of additional fields to return, if available.
示例值:
amount

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-m.sandbox.paypal.com/v2/invoicing/invoices?page=1&page_size=10&total_required=true&fields=amount' \
--header 'Authorization: Basic Og=='

返回响应

🟢200200 - List Invoices with Minimal request
application/json
Body
items
array [object {7}] 
必需
id
string 
必需
status
string 
必需
detail
object 
必需
primary_recipients
array [object {2}] 
必需
amount
object 
必需
due_amount
object 
必需
links
array [object {3}] 
必需
links
array [object {3}] 
必需
href
string 
必需
rel
string 
必需
method
string 
必需
示例
{
  "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"
        },
        {
          "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": "<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": "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": "<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": "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": "<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": "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": "<A note to the invoice recipient. Also appears on the invoice notification email.>",
        "memo": "<A private bookkeeping note for merchant.>",
        "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": "<A note to the invoice recipient. Also appears on the invoice notification email.>",
        "memo": "<A private bookkeeping note for merchant.>",
        "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": "<A note to the invoice recipient. Also appears on the invoice notification email.>",
        "memo": "<A private bookkeeping note for merchant.>",
        "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": "<A note to the invoice recipient. Also appears on the invoice notification email.>",
        "memo": "<A private bookkeeping note for merchant.>",
        "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"
        }
      ]
    },
    {
      "id": "INV2-5884-9JQ7-2YF4-P74Y",
      "status": "DRAFT",
      "detail": {
        "reference": "deal-ref",
        "currency_code": "USD",
        "note": "Thank you for your business.",
        "memo": "This is a long contract",
        "invoice_number": "1643942727",
        "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:45:27Z"
        }
      },
      "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-5884-9JQ7-2YF4-P74Y",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-5884-9JQ7-2YF4-P74Y/send",
          "rel": "send",
          "method": "POST"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-5884-9JQ7-2YF4-P74Y",
          "rel": "replace",
          "method": "PUT"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-5884-9JQ7-2YF4-P74Y",
          "rel": "delete",
          "method": "DELETE"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-5884-9JQ7-2YF4-P74Y/payments",
          "rel": "record-payment",
          "method": "POST"
        }
      ]
    },
    {
      "id": "INV2-TRM6-RCVD-3FBM-AE77",
      "status": "DRAFT",
      "detail": {
        "reference": "deal-ref",
        "currency_code": "USD",
        "note": "Thank you for your business.",
        "memo": "This is a long contract",
        "invoice_number": "1643942720",
        "invoice_date": "2021-02-04",
        "payment_term": {
          "due_date": "2021-02-14"
        },
        "viewed_by_recipient": false,
        "group_draft": false,
        "metadata": {
          "create_time": "2022-02-04T02:45:19Z"
        }
      },
      "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-TRM6-RCVD-3FBM-AE77",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-TRM6-RCVD-3FBM-AE77/send",
          "rel": "send",
          "method": "POST"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-TRM6-RCVD-3FBM-AE77",
          "rel": "replace",
          "method": "PUT"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-TRM6-RCVD-3FBM-AE77",
          "rel": "delete",
          "method": "DELETE"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-TRM6-RCVD-3FBM-AE77/payments",
          "rel": "record-payment",
          "method": "POST"
        }
      ]
    },
    {
      "id": "INV2-MEGS-4LC4-HDU3-PF7D",
      "status": "DRAFT",
      "detail": {
        "reference": "deal-ref",
        "currency_code": "USD",
        "note": "Thank you for your business.",
        "memo": "This is a long contract",
        "invoice_number": "1643942693",
        "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:44:53Z"
        }
      },
      "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-MEGS-4LC4-HDU3-PF7D",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-MEGS-4LC4-HDU3-PF7D/send",
          "rel": "send",
          "method": "POST"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-MEGS-4LC4-HDU3-PF7D",
          "rel": "replace",
          "method": "PUT"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-MEGS-4LC4-HDU3-PF7D",
          "rel": "delete",
          "method": "DELETE"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-MEGS-4LC4-HDU3-PF7D/payments",
          "rel": "record-payment",
          "method": "POST"
        }
      ]
    },
    {
      "id": "INV2-F7GC-A6EJ-53N6-7HEQ",
      "status": "DRAFT",
      "detail": {
        "reference": "deal-ref",
        "currency_code": "USD",
        "note": "Thank you for your business.",
        "memo": "This is a long contract",
        "invoice_number": "1643942686",
        "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:44:46Z"
        }
      },
      "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-F7GC-A6EJ-53N6-7HEQ",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-F7GC-A6EJ-53N6-7HEQ/send",
          "rel": "send",
          "method": "POST"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-F7GC-A6EJ-53N6-7HEQ",
          "rel": "replace",
          "method": "PUT"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-F7GC-A6EJ-53N6-7HEQ",
          "rel": "delete",
          "method": "DELETE"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-F7GC-A6EJ-53N6-7HEQ/payments",
          "rel": "record-payment",
          "method": "POST"
        }
      ]
    },
    {
      "id": "INV2-TKNW-LEZX-7NEF-Q4V2",
      "status": "DRAFT",
      "detail": {
        "currency_code": "USD",
        "invoice_number": "1643942295",
        "invoice_date": "2018-11-12",
        "viewed_by_recipient": false,
        "group_draft": false,
        "metadata": {
          "create_time": "2022-02-04T02:40:06Z"
        }
      },
      "amount": {
        "currency_code": "USD",
        "value": "0.00"
      },
      "due_amount": {
        "currency_code": "USD",
        "value": "0.00"
      },
      "links": [
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-TKNW-LEZX-7NEF-Q4V2",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-TKNW-LEZX-7NEF-Q4V2/send",
          "rel": "send",
          "method": "POST"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-TKNW-LEZX-7NEF-Q4V2",
          "rel": "replace",
          "method": "PUT"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-TKNW-LEZX-7NEF-Q4V2",
          "rel": "delete",
          "method": "DELETE"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-TKNW-LEZX-7NEF-Q4V2/payments",
          "rel": "record-payment",
          "method": "POST"
        }
      ]
    },
    {
      "id": "INV2-8TRJ-K6ZV-AUB5-2B9A",
      "status": "DRAFT",
      "detail": {
        "currency_code": "USD",
        "invoice_number": "1643942294",
        "invoice_date": "2018-11-12",
        "viewed_by_recipient": false,
        "group_draft": false,
        "metadata": {
          "create_time": "2022-02-04T02:39:57Z"
        }
      },
      "amount": {
        "currency_code": "USD",
        "value": "0.00"
      },
      "due_amount": {
        "currency_code": "USD",
        "value": "0.00"
      },
      "links": [
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-8TRJ-K6ZV-AUB5-2B9A",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-8TRJ-K6ZV-AUB5-2B9A/send",
          "rel": "send",
          "method": "POST"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-8TRJ-K6ZV-AUB5-2B9A",
          "rel": "replace",
          "method": "PUT"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-8TRJ-K6ZV-AUB5-2B9A",
          "rel": "delete",
          "method": "DELETE"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-8TRJ-K6ZV-AUB5-2B9A/payments",
          "rel": "record-payment",
          "method": "POST"
        }
      ]
    },
    {
      "id": "INV2-K75C-QBA6-6CWL-5CD2",
      "status": "DRAFT",
      "detail": {
        "currency_code": "USD",
        "invoice_number": "1643942293",
        "invoice_date": "2018-11-12",
        "viewed_by_recipient": false,
        "group_draft": false,
        "metadata": {
          "create_time": "2022-02-04T02:38:36Z"
        }
      },
      "amount": {
        "currency_code": "USD",
        "value": "0.00"
      },
      "due_amount": {
        "currency_code": "USD",
        "value": "0.00"
      },
      "links": [
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-K75C-QBA6-6CWL-5CD2",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-K75C-QBA6-6CWL-5CD2/send",
          "rel": "send",
          "method": "POST"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-K75C-QBA6-6CWL-5CD2",
          "rel": "replace",
          "method": "PUT"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-K75C-QBA6-6CWL-5CD2",
          "rel": "delete",
          "method": "DELETE"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-K75C-QBA6-6CWL-5CD2/payments",
          "rel": "record-payment",
          "method": "POST"
        }
      ]
    },
    {
      "id": "INV2-HS73-2GDW-WF93-YDKM",
      "status": "DRAFT",
      "detail": {
        "currency_code": "USD",
        "invoice_number": "1643942292",
        "invoice_date": "2018-11-12",
        "payment_term": {
          "due_date": "2018-11-22"
        },
        "viewed_by_recipient": false,
        "group_draft": false,
        "metadata": {
          "create_time": "2022-02-04T02:38:30Z"
        }
      },
      "amount": {
        "currency_code": "USD",
        "value": "0.00"
      },
      "due_amount": {
        "currency_code": "USD",
        "value": "0.00"
      },
      "links": [
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-HS73-2GDW-WF93-YDKM",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-HS73-2GDW-WF93-YDKM/send",
          "rel": "send",
          "method": "POST"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-HS73-2GDW-WF93-YDKM",
          "rel": "replace",
          "method": "PUT"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-HS73-2GDW-WF93-YDKM",
          "rel": "delete",
          "method": "DELETE"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-HS73-2GDW-WF93-YDKM/payments",
          "rel": "record-payment",
          "method": "POST"
        }
      ]
    },
    {
      "id": "INV2-MTZE-BFR8-U9A7-9FBP",
      "status": "DRAFT",
      "detail": {
        "currency_code": "USD",
        "memo": "This is a long contract",
        "invoice_number": "1643942291",
        "invoice_date": "2018-11-12",
        "payment_term": {
          "due_date": "2018-11-22"
        },
        "viewed_by_recipient": false,
        "group_draft": false,
        "metadata": {
          "create_time": "2022-02-04T02:38:28Z"
        }
      },
      "amount": {
        "currency_code": "USD",
        "value": "0.00"
      },
      "due_amount": {
        "currency_code": "USD",
        "value": "0.00"
      },
      "links": [
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-MTZE-BFR8-U9A7-9FBP",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-MTZE-BFR8-U9A7-9FBP/send",
          "rel": "send",
          "method": "POST"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-MTZE-BFR8-U9A7-9FBP",
          "rel": "replace",
          "method": "PUT"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-MTZE-BFR8-U9A7-9FBP",
          "rel": "delete",
          "method": "DELETE"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-MTZE-BFR8-U9A7-9FBP/payments",
          "rel": "record-payment",
          "method": "POST"
        }
      ]
    },
    {
      "id": "INV2-6VSC-42RT-MVJM-74MV",
      "status": "DRAFT",
      "detail": {
        "currency_code": "USD",
        "memo": "This is a long contract",
        "invoice_number": "1643942290",
        "invoice_date": "2018-11-12",
        "payment_term": {
          "due_date": "2018-11-22"
        },
        "viewed_by_recipient": false,
        "group_draft": false,
        "metadata": {
          "create_time": "2022-02-04T02:38:26Z"
        }
      },
      "amount": {
        "currency_code": "USD",
        "value": "0.00"
      },
      "due_amount": {
        "currency_code": "USD",
        "value": "0.00"
      },
      "links": [
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-6VSC-42RT-MVJM-74MV",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-6VSC-42RT-MVJM-74MV/send",
          "rel": "send",
          "method": "POST"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-6VSC-42RT-MVJM-74MV",
          "rel": "replace",
          "method": "PUT"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-6VSC-42RT-MVJM-74MV",
          "rel": "delete",
          "method": "DELETE"
        },
        {
          "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-6VSC-42RT-MVJM-74MV/payments",
          "rel": "record-payment",
          "method": "POST"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices?page=1&page_size=20&total_required=false",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices?page=2&page_size=20&total_required=false",
      "rel": "next",
      "method": "GET"
    }
  ]
}
🟢200200 - List Invoices With Pagination
🟠400400 Bad Request - Invalid Page Size
🟠401401 Unauthorized - Invalid Token
修改于 2023-08-16 07:18:59
上一页
Show invoice details
下一页
Generate QR code
Built with