- Authorization
- Orders
- Payments
- Invoices
- Invoices
- Generate invoice numberPOST
- Create draft invoicePOST
- Show invoice detailsGET
- List invoicesGET
- Generate QR codePOST
- Fully update invoicePUT
- Send invoicePOST
- Send invoice reminderPOST
- Cancel sent invoicePOST
- Delete invoiceDELETE
- Search for invoicesPOST
- Record payment for invoicePOST
- Delete external paymentDELETE
- Record refund for invoicePOST
- Delete external refundDELETE
- Templates
- Subscriptions
- Payouts
- Webhooks
- Shipment Tracking
- Transaction Search
- 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)
List invoices
GET
/v2/invoicing/invoices
请求参数
Authorization
在 Header 添加参数
Authorization
，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password示例：
Authorization: Basic *****************Query 参数
page
string
必需
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
必需
示例值:
10
total_required
string
必需
total_pages and total_items in the response.示例值:
true
fields
string
必需
示例值:
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"
},
{
"hr🟢200200 - List Invoices With Pagination
🟠400400 Bad Request - Invalid Page Size
🟠401401 Unauthorized - Invalid Token