Fully update invoice

PUT

/v2/invoicing/invoices/{invoice_id}

Fully updates an invoice, by ID. In the JSON request body, include a complete invoice object. This call does not support partial updates.

请求参数

Authorization

在 Header 添加参数

Authorization

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

示例：

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

Path 参数

invoice_id

string

必需

(Required) The ID of the invoice to update.

示例值:

Query 参数

send_to_recipient

string

必需

Indicates whether to send the invoice update notification to the recipient.

示例值:

true

send_to_invoicer

string

必需

Indicates whether to send the invoice update notification to the merchant.

示例值:

true

Header 参数

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.

示例值:

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.

示例值:

Body 参数application/json

string

必需

status

string

必需

detail

object

必需

invoice_number

string

必需

reference

string

必需

invoice_date

string

必需

currency_code

string

必需

note

string

必需

term

string

必需

memo

string

必需

payment_term

object

必需

invoicer

object

必需

name

object

必需

address

object

必需

phones

array [object {3}]

必需

website

string

必需

tax_id

string

必需

logo_url

string

必需

additional_notes

string

必需

primary_recipients

array [object {2}]

必需

billing_info

object

可选

shipping_info

object

可选

items

array [object {7}]

必需

name

string

必需

description

string

可选

quantity

string

必需

unit_amount

object

必需

tax

object

必需

discount

object

必需

unit_of_measure

string

必需

configuration

object

必需

partial_payment

object

必需

allow_tip

boolean

必需

tax_calculated_after_discount

boolean

必需

tax_inclusive

boolean

必需

amount

object

必需

currency_code

string

必需

value

string

必需

breakdown

object

必需

示例

{
  "id": "{{invoice_id}}",
  "status": "DRAFT",
  "detail": {
    "invoice_number": "{{$timestamp}}",
    "reference": "deal-reference-update",
    "invoice_date": "2018-11-12",
    "currency_code": "USD",
    "note": "Thank you for your business.",
    "term": "No refunds after 30 days.",
    "memo": "This is a long contract",
    "payment_term": {
      "term_type": "NET_10",
      "due_date": "2018-11-22"
    }
  },
  "invoicer": {
    "name": {
      "given_name": "David",
      "surname": "Larusso"
    },
    "address": {
      "address_line_1": "1234 First Street",
      "address_line_2": "337673 Hillside Court",
      "admin_area_2": "Anytown",
      "admin_area_1": "CA",
      "postal_code": "98765",
      "country_code": "US"
    },
    "phones": [
      {
        "country_code": "001",
        "national_number": "4085551234",
        "phone_type": "MOBILE"
      }
    ],
    "website": "www.test.com",
    "tax_id": "ABcNkWSfb5ICTt73nD3QON1fnnpgNKBy-Jb5SeuGj185MNNw6g",
    "logo_url": "https://example.com/logo.PNG",
    "additional_notes": "2-4"
  },
  "primary_recipients": [
    {
      "billing_info": {
        "name": {
          "given_name": "Stephanie",
          "surname": "Meyers"
        },
        "address": {
          "address_line_1": "1234 Main Street",
          "admin_area_2": "Anytown",
          "admin_area_1": "CA",
          "postal_code": "98765",
          "country_code": "US"
        },
        "email_address": "foobuyer@gmail.com",
        "phones": [
          {
            "country_code": "001",
            "national_number": "4884551234",
            "phone_type": "HOME"
          }
        ],
        "additional_info_value": "add-info"
      },
      "shipping_info": {
        "name": {
          "given_name": "Stephanie",
          "surname": "Meyers"
        },
        "address": {
          "address_line_1": "1234 Main Street",
          "admin_area_2": "Anytown",
          "admin_area_1": "CA",
          "postal_code": "98765",
          "country_code": "US"
        }
      }
    }
  ],
  "items": [
    {
      "name": "Yoga Mat",
      "description": "Elastic mat to practice yoga.",
      "quantity": "1",
      "unit_amount": {
        "currency_code": "USD",
        "value": "50.00"
      },
      "tax": {
        "name": "Sales Tax",
        "percent": "7.25",
        "amount": {
          "currency_code": "USD",
          "value": "3.27"
        }
      },
      "discount": {
        "percent": "5",
        "amount": {
          "currency_code": "USD",
          "value": "2.5"
        }
      },
      "unit_of_measure": "QUANTITY"
    },
    {
      "name": "Yoga t-shirt",
      "quantity": "1",
      "unit_amount": {
        "currency_code": "USD",
        "value": "10.00"
      },
      "tax": {
        "name": "Sales Tax",
        "percent": "7.25",
        "amount": {
          "currency_code": "USD",
          "value": "0.34"
        }
      },
      "discount": {
        "amount": {
          "currency_code": "USD",
          "value": "5.00"
        }
      },
      "unit_of_measure": "QUANTITY"
    }
  ],
  "configuration": {
    "partial_payment": {
      "allow_partial_payment": true,
      "minimum_amount_due": {
        "currency_code": "USD",
        "value": "20.00"
      }
    },
    "allow_tip": true,
    "tax_calculated_after_discount": true,
    "tax_inclusive": false
  },
  "amount": {
    "currency_code": "USD",
    "value": "74.21",
    "breakdown": {
      "item_total": {
        "currency_code": "USD",
        "value": "60.00"
      },
      "custom": {
        "label": "Packing Charges",
        "amount": {
          "currency_code": "USD",
          "value": "10.00"
        }
      },
      "shipping": {
        "amount": {
          "currency_code": "USD",
          "value": "10.00"
        },
        "tax": {
          "name": "Sales Tax",
          "percent": "7.25",
          "amount": {
            "currency_code": "USD",
            "value": "0.73"
          }
        }
      },
      "discount": {
        "item_discount": {
          "currency_code": "USD",
          "value": "-7.50"
        },
        "invoice_discount": {
          "percent": "5",
          "amount": {
            "currency_code": "USD",
            "value": "-2.63"
          }
        }
      },
      "tax_total": {
        "currency_code": "USD",
        "value": "4.34"
      }
    }
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PUT 'https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{{invoice_id}}?send_to_recipient=true&send_to_invoicer=true' \
--header 'PayPal-Request-Id: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "id": "{{invoice_id}}",
    "status": "DRAFT",
    "detail": {
        "invoice_number": "{{$timestamp}}",
        "reference": "deal-reference-update",
        "invoice_date": "2018-11-12",
        "currency_code": "USD",
        "note": "Thank you for your business.",
        "term": "No refunds after 30 days.",
        "memo": "This is a long contract",
        "payment_term": {
            "term_type": "NET_10",
            "due_date": "2018-11-22"
        }
    },
    "invoicer": {
        "name": {
            "given_name": "David",
            "surname": "Larusso"
        },
        "address": {
            "address_line_1": "1234 First Street",
            "address_line_2": "337673 Hillside Court",
            "admin_area_2": "Anytown",
            "admin_area_1": "CA",
            "postal_code": "98765",
            "country_code": "US"
        },
        "phones": [
            {
                "country_code": "001",
                "national_number": "4085551234",
                "phone_type": "MOBILE"
            }
        ],
        "website": "www.test.com",
        "tax_id": "ABcNkWSfb5ICTt73nD3QON1fnnpgNKBy-Jb5SeuGj185MNNw6g",
        "logo_url": "https://example.com/logo.PNG",
        "additional_notes": "2-4"
    },
    "primary_recipients": [
        {
            "billing_info": {
                "name": {
                    "given_name": "Stephanie",
                    "surname": "Meyers"
                },
                "address": {
                    "address_line_1": "1234 Main Street",
                    "admin_area_2": "Anytown",
                    "admin_area_1": "CA",
                    "postal_code": "98765",
                    "country_code": "US"
                },
                "email_address": "foobuyer@gmail.com",
                "phones": [
                    {
                        "country_code": "001",
                        "national_number": "4884551234",
                        "phone_type": "HOME"
                    }
                ],
                "additional_info_value": "add-info"
            },
            "shipping_info": {
                "name": {
                    "given_name": "Stephanie",
                    "surname": "Meyers"
                },
                "address": {
                    "address_line_1": "1234 Main Street",
                    "admin_area_2": "Anytown",
                    "admin_area_1": "CA",
                    "postal_code": "98765",
                    "country_code": "US"
                }
            }
        }
    ],
    "items": [
        {
            "name": "Yoga Mat",
            "description": "Elastic mat to practice yoga.",
            "quantity": "1",
            "unit_amount": {
                "currency_code": "USD",
                "value": "50.00"
            },
            "tax": {
                "name": "Sales Tax",
                "percent": "7.25",
                "amount": {
                    "currency_code": "USD",
                    "value": "3.27"
                }
            },
            "discount": {
                "percent": "5",
                "amount": {
                    "currency_code": "USD",
                    "value": "2.5"
                }
            },
            "unit_of_measure": "QUANTITY"
        },
        {
            "name": "Yoga t-shirt",
            "quantity": "1",
            "unit_amount": {
                "currency_code": "USD",
                "value": "10.00"
            },
            "tax": {
                "name": "Sales Tax",
                "percent": "7.25",
                "amount": {
                    "currency_code": "USD",
                    "value": "0.34"
                }
            },
            "discount": {
                "amount": {
                    "currency_code": "USD",
                    "value": "5.00"
                }
            },
            "unit_of_measure": "QUANTITY"
        }
    ],
    "configuration": {
        "partial_payment": {
            "allow_partial_payment": true,
            "minimum_amount_due": {
                "currency_code": "USD",
                "value": "20.00"
            }
        },
        "allow_tip": true,
        "tax_calculated_after_discount": true,
        "tax_inclusive": false
    },
    "amount": {
        "currency_code": "USD",
        "value": "74.21",
        "breakdown": {
            "item_total": {
                "currency_code": "USD",
                "value": "60.00"
            },
            "custom": {
                "label": "Packing Charges",
                "amount": {
                    "currency_code": "USD",
                    "value": "10.00"
                }
            },
            "shipping": {
                "amount": {
                    "currency_code": "USD",
                    "value": "10.00"
                },
                "tax": {
                    "name": "Sales Tax",
                    "percent": "7.25",
                    "amount": {
                        "currency_code": "USD",
                        "value": "0.73"
                    }
                }
            },
            "discount": {
                "item_discount": {
                    "currency_code": "USD",
                    "value": "-7.50"
                },
                "invoice_discount": {
                    "percent": "5",
                    "amount": {
                        "currency_code": "USD",
                        "value": "-2.63"
                    }
                }
            },
            "tax_total": {
                "currency_code": "USD",
                "value": "4.34"
            }
        }
    }
}'

返回响应

🟢200200 - Fully Update Invoice

application/json

Body

rel

string

必需

href

string

必需

method

string

必需

示例

{
  "rel": "self",
  "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-U95S-EB3F-W2WE-DMRN",
  "method": "GET"
}

🟠400400 Bad Request - Invalid Invoice Template

🟠401401 Unauthorized - Invalid Token

🟠404404 Not Found - Invoice Not Found

修改于 2023-08-16 07:18:59

Generate QR code

Send invoice