List invoices

Lists invoices. To filter the invoices that appear in the response, you can specify one or more optional query parameters.

GET /v2/invoicing/invoices

List invoices

cURL

curl --request GET \
  --url https://api-m.sandbox.paypal.com/v2/invoicing/invoices \
  --header 'Authorization: Bearer <token>'

200

{
  "total_pages": 1073741823,
  "total_items": 1073741823,
  "items": [
    {
      "detail": {
        "currency_code": "<string>",
        "reference": "<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": {
          "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>",
          "recipient_view_url": "<string>",
          "invoicer_view_url": "<string>"
        }
      },
      "id": "<string>",
      "parent_id": "<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": {
          "country_code": "<string>",
          "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>",
          "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>"
          }
        ],
        "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": {
              "country_code": "<string>",
              "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>",
              "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>"
              }
            ],
            "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": {
              "country_code": "<string>",
              "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>",
              "address_details": {
                "street_number": "<string>",
                "street_name": "<string>",
                "street_type": "<string>",
                "delivery_service": "<string>",
                "building_name": "<string>",
                "sub_building": "<string>"
              }
            }
          }
        }
      ],
      "additional_recipients": [
        "<string>"
      ],
      "items": [
        {
          "name": "<string>",
          "quantity": "<string>",
          "unit_amount": {
            "currency_code": "<string>",
            "value": "<string>"
          },
          "id": "<string>",
          "description": "<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>"
            }
          }
        }
      ],
      "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": [
          {
            "payment_id": "<string>",
            "payment_date": "<string>",
            "payment_date_time": "<string>",
            "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": {
                "country_code": "<string>",
                "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>",
                "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": [
          {
            "refund_id": "<string>",
            "refund_date": "<string>",
            "amount": {
              "currency_code": "<string>",
              "value": "<string>"
            }
          }
        ]
      },
      "links": [
        {
          "href": "<string>",
          "rel": "<string>"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Oauth 2.0 authentication

Query Parameters

page · integer · default: 1

The page number to be retrieved, for the list of templates. So, a combination of page=1 and page_size=20 returns the first 20 templates. A combination of page=2 and page_size=20 returns the next 20 templates.

Required range: 1 <= x <= 1000

page_size · integer · default: 20

The maximum number of templates to return in the response.

Required range: 1 <= x <= 100

total_required · boolean · default: false

Indicates whether the to show total_pages and total_items in the response.

fields · string · default: all

The fields to return in the response. Value is all or none. To return only the template name, ID, and default attributes, specify none.

Maximum string length: 2147483647

Pattern: ^(all|none)$

Response

200

application/json

A successful request returns the HTTP 200 OK status code and a JSON response body that lists invoices with details.

An array of merchant invoices. Includes the total invoices count and HATEOAS links for navigation.

total_pages · integer · read-only

The total number of pages that are available for the search criteria.

Note: Clients MUST NOT assume that the value of total_pages is constant. The value MAY change from one request to the next

Required range: 0 <= x <= 2147483647

total_items · integer · read-only

The total number of invoices that match the search criteria.

Note: Clients MUST NOT assume that the value of total_items is constant. The value MAY change from one request to the next.

Required range: 0 <= x <= 2147483647

items · Invoice · object[] · read-only

The list of invoices that match the search criteria.

Maximum array length: 100

Show child attributes

links · Link Description · object[] · read-only

An array of request-related HATEOAS links.

Maximum array length: 2147483647

Show child attributes