Skip to main content
GET
/
v2
/
invoicing
/
invoices
/
{invoice_id}
Show invoice details
curl --request GET \
  --url https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{invoice_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "parent_id": "<string>",
  "status": "DRAFT",
  "detail": {
    "reference": "<string>",
    "currency_code": "<string>",
    "note": "<string>",
    "terms_and_conditions": "<string>",
    "memo": "<string>",
    "attachments": [
      {
        "id": "<string>",
        "reference_url": "<string>",
        "content_type": "<string>",
        "create_time": "<string>",
        "size": "<string>"
      }
    ],
    "invoice_number": "<string>",
    "invoice_date": "<string>",
    "payment_term": {
      "term_type": "DUE_ON_RECEIPT",
      "due_date": "<string>"
    },
    "metadata": {
      "create_time": "<string>",
      "created_by": "<string>",
      "last_update_time": "<string>",
      "last_updated_by": "<string>",
      "cancel_time": "<string>",
      "cancelled_by": "<string>",
      "first_sent_time": "<string>",
      "last_sent_time": "<string>",
      "last_sent_by": "<string>",
      "created_by_flow": "MULTIPLE_RECIPIENTS_GROUP",
      "recipient_view_url": "<string>",
      "invoicer_view_url": "<string>"
    }
  },
  "invoicer": {
    "business_name": "<string>",
    "name": {
      "prefix": "<string>",
      "given_name": "<string>",
      "surname": "<string>",
      "middle_name": "<string>",
      "suffix": "<string>",
      "alternate_full_name": "<string>",
      "full_name": "<string>"
    },
    "address": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "address_line_3": "<string>",
      "admin_area_4": "<string>",
      "admin_area_3": "<string>",
      "admin_area_2": "<string>",
      "admin_area_1": "<string>",
      "postal_code": "<string>",
      "country_code": "<string>",
      "address_details": {
        "street_number": "<string>",
        "street_name": "<string>",
        "street_type": "<string>",
        "delivery_service": "<string>",
        "building_name": "<string>",
        "sub_building": "<string>"
      }
    },
    "email_address": "<string>",
    "phones": [
      {
        "country_code": "<string>",
        "national_number": "<string>",
        "extension_number": "<string>",
        "phone_type": "FAX"
      }
    ],
    "website": "<string>",
    "tax_id": "<string>",
    "additional_notes": "<string>",
    "logo_url": "<string>"
  },
  "primary_recipients": [
    {
      "billing_info": {
        "business_name": "<string>",
        "name": {
          "prefix": "<string>",
          "given_name": "<string>",
          "surname": "<string>",
          "middle_name": "<string>",
          "suffix": "<string>",
          "alternate_full_name": "<string>",
          "full_name": "<string>"
        },
        "address": {
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "address_line_3": "<string>",
          "admin_area_4": "<string>",
          "admin_area_3": "<string>",
          "admin_area_2": "<string>",
          "admin_area_1": "<string>",
          "postal_code": "<string>",
          "country_code": "<string>",
          "address_details": {
            "street_number": "<string>",
            "street_name": "<string>",
            "street_type": "<string>",
            "delivery_service": "<string>",
            "building_name": "<string>",
            "sub_building": "<string>"
          }
        },
        "email_address": "<string>",
        "phones": [
          {
            "country_code": "<string>",
            "national_number": "<string>",
            "extension_number": "<string>",
            "phone_type": "FAX"
          }
        ],
        "additional_info": "<string>",
        "language": "<string>"
      },
      "shipping_info": {
        "business_name": "<string>",
        "name": {
          "prefix": "<string>",
          "given_name": "<string>",
          "surname": "<string>",
          "middle_name": "<string>",
          "suffix": "<string>",
          "alternate_full_name": "<string>",
          "full_name": "<string>"
        },
        "address": {
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "address_line_3": "<string>",
          "admin_area_4": "<string>",
          "admin_area_3": "<string>",
          "admin_area_2": "<string>",
          "admin_area_1": "<string>",
          "postal_code": "<string>",
          "country_code": "<string>",
          "address_details": {
            "street_number": "<string>",
            "street_name": "<string>",
            "street_type": "<string>",
            "delivery_service": "<string>",
            "building_name": "<string>",
            "sub_building": "<string>"
          }
        }
      }
    }
  ],
  "additional_recipients": [
    "<string>"
  ],
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "quantity": "<string>",
      "unit_amount": {
        "currency_code": "<string>",
        "value": "<string>"
      },
      "tax": {
        "name": "<string>",
        "percent": "<string>",
        "amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "tax_note": "<string>"
      },
      "item_date": "<string>",
      "discount": {
        "percent": "<string>",
        "amount": {
          "currency_code": "<string>",
          "value": "<string>"
        }
      },
      "unit_of_measure": "QUANTITY"
    }
  ],
  "configuration": {
    "tax_calculated_after_discount": true,
    "tax_inclusive": false,
    "allow_tip": false,
    "partial_payment": {
      "allow_partial_payment": false,
      "minimum_amount_due": {
        "currency_code": "<string>",
        "value": "<string>"
      }
    },
    "has_conditional_rule": false,
    "template_id": "PayPal system template"
  },
  "amount": {
    "currency_code": "<string>",
    "value": "<string>",
    "breakdown": {
      "item_total": {
        "currency_code": "<string>",
        "value": "<string>"
      },
      "discount": {
        "invoice_discount": {
          "percent": "<string>",
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          }
        },
        "item_discount": {
          "currency_code": "<string>",
          "value": "<string>"
        }
      },
      "tax_total": {
        "currency_code": "<string>",
        "value": "<string>"
      },
      "shipping": {
        "amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "tax": {
          "name": "<string>",
          "percent": "<string>",
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          },
          "tax_note": "<string>"
        }
      },
      "custom": {
        "label": "<string>",
        "amount": {
          "currency_code": "<string>",
          "value": "<string>"
        }
      }
    }
  },
  "due_amount": {
    "currency_code": "<string>",
    "value": "<string>"
  },
  "gratuity": {
    "currency_code": "<string>",
    "value": "<string>"
  },
  "payments": {
    "paid_amount": {
      "currency_code": "<string>",
      "value": "<string>"
    },
    "transactions": [
      {
        "type": "PAYPAL",
        "payment_id": "<string>",
        "payment_date": "<string>",
        "payment_date_time": "<string>",
        "method": "BANK_TRANSFER",
        "note": "<string>",
        "amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "shipping_info": {
          "business_name": "<string>",
          "name": {
            "prefix": "<string>",
            "given_name": "<string>",
            "surname": "<string>",
            "middle_name": "<string>",
            "suffix": "<string>",
            "alternate_full_name": "<string>",
            "full_name": "<string>"
          },
          "address": {
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "address_line_3": "<string>",
            "admin_area_4": "<string>",
            "admin_area_3": "<string>",
            "admin_area_2": "<string>",
            "admin_area_1": "<string>",
            "postal_code": "<string>",
            "country_code": "<string>",
            "address_details": {
              "street_number": "<string>",
              "street_name": "<string>",
              "street_type": "<string>",
              "delivery_service": "<string>",
              "building_name": "<string>",
              "sub_building": "<string>"
            }
          }
        }
      }
    ]
  },
  "refunds": {
    "refund_amount": {
      "currency_code": "<string>",
      "value": "<string>"
    },
    "transactions": [
      {
        "type": "PAYPAL",
        "refund_id": "<string>",
        "refund_date": "<string>",
        "amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "method": "BANK_TRANSFER"
      }
    ]
  },
  "links": [
    {
      "href": "<string>",
      "rel": "<string>",
      "method": "GET"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Oauth 2.0 authentication

Path Parameters

​
invoice_id
string
required

The ID of the draft invoice to delete.

Maximum length: 2147483647

Response

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

The invoice details which includes all information of the invoice like items, billing information.

​
detail
object
required

The details of the invoice. Includes the invoice number, date, payment terms, and audit metadata. The details of the invoice like notes, terms and conditions, memo, attachments.

​
id
string

The ID of the invoice.

Maximum length: 30
​
parent_id
string

The parent ID to an invoice that defines the group invoice to which the invoice is related.

Maximum length: 30
​
status
enum<string>

The status of the invoice.

Available options:
DRAFT,
SENT,
SCHEDULED,
PAID,
MARKED_AS_PAID,
CANCELLED,
REFUNDED,
PARTIALLY_PAID,
PARTIALLY_REFUNDED,
MARKED_AS_REFUNDED,
UNPAID,
PAYMENT_PENDING,
AUTO_CANCELLED,
PAID_EXTERNAL,
REFUNDED_EXTERNAL,
SHARED
​
invoicer
object

The invoicer information. Includes the business name, email, address, phone, fax, tax ID, additional notes, and logo URL. The contact information of the user. Includes name and address. The business name of the party.

​
primary_recipients
Recipient Information · object[]

The billing and shipping information. Includes name, email, address, phone and language.

Maximum length: 100
​
additional_recipients
string<ppaas_common_email_address_v2>[]

An array of one or more CC: emails to which notifications are sent. If you omit this parameter, a notification is sent to all CC: email addresses that are part of the invoice.<blockquote><strong>Note:</strong> Valid values are email addresses in the additional_recipients value associated with the invoice.</blockquote>

Maximum length: 100

The internationalized email address.<blockquote><strong>Note:</strong> Up to 64 characters are allowed before and 255 characters are allowed after the <code>@</code> sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted <code>@</code> sign exists.</blockquote>

​
items
Invoice Item · object[]

An array of invoice line item information.

Maximum length: 100
​
configuration
object

The invoice configuration details. Includes partial payment, tip, and tax calculated after discount. The template configuration details. Includes tax information, tip, and partial payment.

​
amount
object

The invoice amount summary of item total, discount, tax total and shipping..

​
due_amount
object

The due amount, which is the balance amount outstanding after payments.

​
gratuity
object

The amount paid by the payer as gratuity to the invoicer.

​
payments
object

List of payments registered against the invoice..

​
refunds
object

List of refunds against this invoice. The invoicing refund details includes refund type, date, amount, and method.

​
links
Link Description · object[]

An array of request-related HATEOAS links.

Maximum length: 2147483647
⌘I