- 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)
Search for invoices
POST
/v2/invoicing/search-invoices
请求参数
Authorization
在 Header 添加参数
Authorization
，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password示例：
Authorization: Basic *****************Query 参数
Header 参数
Body 参数application/json
示例
{
"recipient_email": "foobuyer@gmail.com",
"recipient_first_name": "Stephanie",
"recipient_last_name": "Meyers",
"recipient_business_name": "",
"invoice_number": "1644275305",
"status": [
"DRAFT"
],
"reference": "298",
"currency_code": "USD",
"memo": "<A private bookkeeping note for merchant.>",
"total_amount_range": {
"lower_amount": {
"currency_code": "USD",
"value": "100.00"
},
"upper_amount": {
"currency_code": "USD",
"value": "1000.00"
}
},
"invoice_date_range": {
"start": "2022-01-01",
"end": "2022-02-07"
}
}请求示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-m.sandbox.paypal.com/v2/invoicing/search-invoices?page=1&page_size=10&total_required=true' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
"recipient_email": "foobuyer@gmail.com",
"recipient_first_name": "Stephanie",
"recipient_last_name": "Meyers",
"recipient_business_name": "",
"invoice_number": "1644275305",
"status": [
"DRAFT"
],
"reference": "298",
"currency_code": "USD",
"memo": "<A private bookkeeping note for merchant.>",
"total_amount_range": {
"lower_amount": {
"currency_code": "USD",
"value": "100.00"
},
"upper_amount": {
"currency_code": "USD",
"value": "1000.00"
}
},
"invoice_date_range": {
"start": "2022-01-01",
"end": "2022-02-07"
}
}'返回响应
🟢200200 - Search Invoice By Date
application/json
Body
示例
{
"total_pages": 5,
"total_items": 44,
"items": [
{
"id": "INV2-6GCT-RGT9-JXGA-TZAE",
"status": "PARTIALLY_PAID",
"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": "1644273964",
"invoice_date": "2022-01-04",
"payment_term": {
"due_date": "2022-01-14"
},
"viewed_by_recipient": false,
"group_draft": false,
"metadata": {
"create_time": "2022-02-07T22:46: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": "198.21"
},
"due_amount": {
"currency_code": "USD",
"value": "188.21"
},
"payments": {
"paid_amount": {
"currency_code": "USD",
"value": "10.00"
}
},
"refunds": {
"refund_amount": {
"currency_code": "USD",
"value": "5.00"
}
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-6GCT-RGT9-JXGA-TZAE",
"rel": "self",
"method": "GET"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-6GCT-RGT9-JXGA-TZAE/payments",
"rel": "record-payment",
"method": "POST"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-6GCT-RGT9-JXGA-TZAE/refunds",
"rel": "record-refund",
"method": "POST"
}
]
},
{
"id": "INV2-8B9B-RB25-PBKA-2LEZ",
"status": "REFUNDED",
"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": "1644273499",
"invoice_date": "2022-01-04",
"payment_term": {
"due_date": "2022-01-14"
},
"viewed_by_recipient": false,
"group_draft": false,
"metadata": {
"create_time": "2022-02-07T22:38: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": "198.21"
},
"due_amount": {
"currency_code": "USD",
"value": "0.00"
},
"payments": {
"paid_amount": {
"currency_code": "USD",
"value": "198.21"
}
},
"refunds": {
"refund_amount": {
"currency_code": "USD",
"value": "198.21"
}
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-8B9B-RB25-PBKA-2LEZ",
"rel": "self",
"method": "GET"
}
]
},
{
"id": "INV2-YXDK-4FLQ-K2UQ-2BHS",
"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": "1644272108",
"invoice_date": "2022-01-04",
"payment_term": {
"due_date": "2022-01-14"
},
"viewed_by_recipient": false,
"group_draft": false,
"metadata": {
"create_time": "2022-02-07T22:15:08Z"
}
},
"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": "198.21"
},
"due_amount": {
"currency_code": "USD",
"value": "198.21"
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-YXDK-4FLQ-K2UQ-2BHS",
"rel": "self",
"method": "GET"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-YXDK-4FLQ-K2UQ-2BHS/send",
"rel": "send",
"method": "POST"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-YXDK-4FLQ-K2UQ-2BHS",
"rel": "replace",
"method": "PUT"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-YXDK-4FLQ-K2UQ-2BHS",
"rel": "delete",
"method": "DELETE"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-YXDK-4FLQ-K2UQ-2BHS/payments",
"rel": "record-payment",
"method": "POST"
}
]
},
{
"id": "INV2-GJVZ-PTEW-BAHM-QRZX",
"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": "1644272025",
"invoice_date": "2022-01-04",
"payment_term": {
"due_date": "2022-01-14"
},
"viewed_by_recipient": false,
"group_draft": false,
"metadata": {
"create_time": "2022-02-07T22:13:45Z"
}
},
"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": "196.90"
},
"due_amount": {
"currency_code": "USD",
"value": "196.90"
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-GJVZ-PTEW-BAHM-QRZX",
"rel": "self",
"method": "GET"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-GJVZ-PTEW-BAHM-QRZX/send",
"rel": "send",
"method": "POST"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-GJVZ-PTEW-BAHM-QRZX",
"rel": "replace",
"method": "PUT"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-GJVZ-PTEW-BAHM-QRZX",
"rel": "delete",
"method": "DELETE"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-GJVZ-PTEW-BAHM-QRZX/payments",
"rel": "record-payment",
"method": "POST"
}
]
},
{
"id": "INV2-SXKQ-2EFK-QXMA-47JG",
"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": "1644271853",
"invoice_date": "2022-01-04",
"payment_term": {
"due_date": "2022-01-14"
},
"viewed_by_recipient": false,
"group_draft": false,
"metadata": {
"create_time": "2022-02-07T22:10: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": "198.21"
},
"due_amount": {
"currency_code": "USD",
"value": "198.21"
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-SXKQ-2EFK-QXMA-47JG",
"rel": "self",
"method": "GET"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-SXKQ-2EFK-QXMA-47JG/send",
"rel": "send",
"method": "POST"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-SXKQ-2EFK-QXMA-47JG",
"rel": "replace",
"method": "PUT"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-SXKQ-2EFK-QXMA-47JG",
"rel": "delete",
"method": "DELETE"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-SXKQ-2EFK-QXMA-47JG/payments",
"rel": "record-payment",
"method": "POST"
}
]
},
{
"id": "INV2-X8L9-SUD9-YW2Z-U6NC",
"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": "1644271844",
"invoice_date": "2022-01-04",
"payment_term": {
"due_date": "2022-01-14"
},
"viewed_by_recipient": false,
"group_draft": false,
"metadata": {
"create_time": "2022-02-07T22:10:44Z"
}
},
"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": "187.21"
},
"due_amount": {
"currency_code": "USD",
"value": "187.21"
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-X8L9-SUD9-YW2Z-U6NC",
"rel": "self",
"method": "GET"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-X8L9-SUD9-YW2Z-U6NC/send",
"rel": "send",
"method": "POST"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-X8L9-SUD9-YW2Z-U6NC",
"rel": "replace",
"method": "PUT"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-X8L9-SUD9-YW2Z-U6NC",
"rel": "delete",
"method": "DELETE"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-X8L9-SUD9-YW2Z-U6NC/payments",
"rel": "record-payment",
"method": "POST"
}
]
},
{
"id": "INV2-UZTP-QHQW-VM2D-F269",
"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": "1644271837",
"invoice_date": "2022-01-04",
"payment_term": {
"due_date": "2022-01-14"
},
"viewed_by_recipient": false,
"group_draft": false,
"metadata": {
"create_time": "2022-02-07T22:10:37Z"
}
},
"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": "188.21"
},
"due_amount": {
"currency_code": "USD",
"value": "188.21"
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-UZTP-QHQW-VM2D-F269",
"rel": "self",
"method": "GET"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-UZTP-QHQW-VM2D-F269/send",
"rel": "send",
"method": "POST"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-UZTP-QHQW-VM2D-F269",
"rel": "replace",
"method": "PUT"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-UZTP-QHQW-VM2D-F269",
"rel": "delete",
"method": "DELETE"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-UZTP-QHQW-VM2D-F269/payments",
"rel": "record-payment",
"method": "POST"
}
]
},
{
"id": "INV2-SPFK-AZHR-2J6J-YZ4P",
"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": "1644271831",
"invoice_date": "2022-01-04",
"payment_term": {
"due_date": "2022-01-14"
},
"viewed_by_recipient": false,
"group_draft": false,
"metadata": {
"create_time": "2022-02-07T22:10:31Z"
}
},
"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": "198.21"
},
"due_amount": {
"currency_code": "USD",
"value": "198.21"
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-SPFK-AZHR-2J6J-YZ4P",
"rel": "self",
"method": "GET"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-SPFK-AZHR-2J6J-YZ4P/send",
"rel": "send",
"method": "POST"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-SPFK-AZHR-2J6J-YZ4P",
"rel": "replace",
"method": "PUT"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-SPFK-AZHR-2J6J-YZ4P",
"rel": "delete",
"method": "DELETE"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-SPFK-AZHR-2J6J-YZ4P/payments",
"rel": "record-payment",
"method": "POST"
}
]
},
{
"id": "INV2-XKMW-4CJ2-7TME-XQZK",
"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": "1644271823",
"invoice_date": "2022-01-04",
"payment_term": {
"due_date": "2022-01-14"
},
"viewed_by_recipient": false,
"group_draft": false,
"metadata": {
"create_time": "2022-02-07T22:10:23Z"
}
},
"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": "217.90"
},
"due_amount": {
"currency_code": "USD",
"value": "217.90"
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-XKMW-4CJ2-7TME-XQZK",
"rel": "self",
"method": "GET"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-XKMW-4CJ2-7TME-XQZK/send",
"rel": "send",
"method": "POST"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-XKMW-4CJ2-7TME-XQZK",
"rel": "replace",
"method": "PUT"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-XKMW-4CJ2-7TME-XQZK",
"rel": "delete",
"method": "DELETE"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-XKMW-4CJ2-7TME-XQZK/payments",
"rel": "record-payment",
"method": "POST"
}
]
},
{
"id": "INV2-8GEC-KUUR-58AD-U4RP",
"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": "1644271814",
"invoice_date": "2022-01-04",
"payment_term": {
"due_date": "2022-01-14"
},
"viewed_by_recipient": false,
"group_draft": false,
"metadata": {
"create_time": "2022-02-07T22:10:14Z"
}
},
"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": "168.68"
},
"due_amount": {
"currency_code": "USD",
"value": "168.68"
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-8GEC-KUUR-58AD-U4RP",
"rel": "self",
"method": "GET"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-8GEC-KUUR-58AD-U4RP/send",
"rel": "send",
"method": "POST"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-8GEC-KUUR-58AD-U4RP",
"rel": "replace",
"method": "PUT"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-8GEC-KUUR-58AD-U4RP",
"rel": "delete",
"method": "DELETE"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-8GEC-KUUR-58AD-U4RP/payments",
"rel": "record-payment",
"method": "POST"
}
]
}
],
"links": [
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/search-invoice?page=1&page_size=10&total_required=true",
"rel": "self",
"method": "POST"
},
{
"href": "https://api.sandbox.paypal.com/v2/invoicing/search-invoice?page=2&page_size=10&total_required=true",
"rel": "next",
"method": "POST"
}
]
}🟢200200 - Search Invoice By Amount
🟢200200 - Search Invoice By Recipient Email
🟢200200 - Search Invoice By Recipient First Name
🟢200200 - Search Invoice By Invoice Number
🟢200200 - Search Invoice By Status
🟢200200 - Search Invoice By Reference
🟢200200 - Search Invoice By Memo
🟢200200 - Search Invoice By Multiple Criteria
🟠401401 Unauthorized - Invalid Token
🟢200200 - Search Invoice By Fields
修改于 2023-08-16 07:18:59