Generate invoice number

Generates the next invoice number that is available to the merchant. The next invoice number uses the prefix and suffix from the last invoice number and increments the number by one. For example, the next invoice number after INVOICE-1234 is INVOICE-1235.

POST /v2/invoicing/generate-next-invoice-number

Generate invoice number

cURL

curl --request POST \
  --url https://api-m.sandbox.paypal.com/v2/invoicing/generate-next-invoice-number \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fetch_id": "false"
}
'

200

{
  "invoice_number": "<string>",
  "invoice_id": "<string>"
}

Authorizations

Authorization · string · header · required

Oauth 2.0 authentication

Body

application/json

Is the fetch type invoice number or id.

Is the fetch type invoice number or id.

fetch_id · boolean · default: false

Optional to decide the number or ID.

Response

200

application/json

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the next invoice number.

The invoice number.

invoice_number · string · read-only

The invoice number. If you omit this value, the default is the auto-incremented number from the last number.

Required string length: 1 - 25

Pattern: ^[\S\s]*$

invoice_id · string · read-only

Resource Id.

Required string length: 1 - 24

Pattern: ^(INV2-)[A-Z0-9\-]{19}$