Info

Invoices 

Active
Download Me
Name : Invoices
Base Path : /undefined
Server : https://api-m.sandbox.paypal.com
Version : 2.3
Description : "Use the Invoicing API to create, send, and manage invoices. You can also use the API or webhooks to track invoice payments. When you send an invoice to a customer, the invoice moves from draft to payable state. PayPal then emails the customer a link to the invoice on the PayPal website. Customers with a PayPal account can log in and pay the invoice with PayPal. Alternatively, customers can pay as a guest with a debit card or credit card. For more information, see the <a href=\"/docs/invoicing/\">Invoicing Overview</a> and the <a href=\"/docs/invoicing/basic-integration/\">Invoicing Integration Guide</a>."

Paths


Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
application/json The invoice details which includes all information of the invoice like items, billing information. true
Request Responses:
Status Code Description Content-Type Schema
201: A successful request returns the HTTP `201 Created` status code. A JSON response body that shows invoice details is returned if you set prefer=return=representation. application/json : multipart/mixed : #/components/schemas/invoice
400: Invalid request. application/json : multipart/mixed : [object Object],[object Object]
403: Authorization Error. application/json : multipart/mixed : #/components/schemas/error_403
422: Unprocessable Entity. application/json : multipart/mixed : [object Object],[object Object]
default: #/components/responses/default
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
page query Active Schema.type: integer
page_size query Active Schema.type: integer
total_required query Active Schema.type: boolean
fields query Active Schema.type: string
Request Responses:
Status Code Description Content-Type Schema
200: A successful request returns the HTTP `200 OK` status code and a JSON response body that lists invoices with details. application/json : multipart/mixed : #/components/schemas/invoices
400: Invalid request. application/json : multipart/mixed : [object Object],[object Object]
403: Authorization Error. application/json : multipart/mixed : #/components/schemas/error_403
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
invoice_id path Active true Schema.type: string
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/notification The email or SMS notification to send to the payer when they send an invoice..
Request Responses:
Status Code Description Content-Type Schema
200: A successful request returns the HTTP `200 OK` when the invoice issue date is current date. application/json : multipart/mixed : #/components/schemas/link_description
202: A successful request returns the HTTP `202 Accepted` status code with no JSON response body, when the invoice issue date is in future. application/json : multipart/mixed : #/components/schemas/202-response
400: Invalid request. application/json : multipart/mixed : #/components/schemas/error_400
403: Authorization Error. application/json : multipart/mixed : #/components/schemas/error_403
404: Resource Not Found. application/json : multipart/mixed : #/components/schemas/error_404
422: Unprocessable Entity. application/json : multipart/mixed : #/components/schemas/error_422
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
invoice_id path Active true Schema.type: string
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/notification The email or SMS notification that will be sent to the payer for reminder.
Request Responses:
Status Code Description Content-Type Schema
204: A successful request returns the HTTP `204 No Content` status code with no JSON response body.
400: Invalid request. application/json : multipart/mixed : [object Object],[object Object]
403: Authorization Error. application/json : multipart/mixed : [object Object],[object Object]
404: Resource Not Found. application/json : multipart/mixed : #/components/schemas/error_404
422: Unprocessable Entity. application/json : multipart/mixed : [object Object],[object Object]
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
invoice_id path Active true Schema.type: string
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/notification The email or SMS notification that will be sent to the payer on cancellation. true
Request Responses:
Status Code Description Content-Type Schema
204: A successful request returns the HTTP `204 No Content` status code with no JSON response body.
400: Invalid request. application/json : [object Object],[object Object]
403: Authorization Error. application/json : [object Object],[object Object]
404: Resource Not Found. application/json : #/components/schemas/error_404
422: Unprocessable Entity. application/json : [object Object],[object Object]
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
invoice_id path Active true Schema.type: string
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/payment_detail The details of the payment to record against the invoice. true
Request Responses:
Status Code Description Content-Type Schema
200: A successful request returns the HTTP `200 Created` status code and a reference to the recorded payment. application/json : multipart/mixed : #/components/schemas/payment_reference
400: Invalid request. application/json : multipart/mixed : [object Object],[object Object]
403: Authorization Error. application/json : multipart/mixed : [object Object],[object Object]
404: Resource Not Found. application/json : multipart/mixed : #/components/schemas/error_404
422: Unprocessable Entity. application/json : multipart/mixed : [object Object],[object Object]
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
invoice_id path Active true Schema.type: string
transaction_id path Active true Schema.type: string
Request Responses:
Status Code Description Content-Type Schema
204: A successful request returns the HTTP `204 No Content` status code with no JSON response body.
403: Authorization Error. application/json : [object Object],[object Object]
404: Resource Not Found. application/json : #/components/schemas/error_404
422: Unprocessable Entity. application/json : [object Object],[object Object]
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
invoice_id path Active true Schema.type: string
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/refund_detail The details of the refund to record against the invoice. true
Request Responses:
Status Code Description Content-Type Schema
200: A successful request returns the HTTP `200 Created` status code and a reference to the recorded refund. application/json : multipart/mixed : #/components/schemas/refund_reference
400: Invalid request. application/json : multipart/mixed : [object Object],[object Object]
403: Authorization Error. application/json : multipart/mixed : [object Object],[object Object]
404: Resource Not Found. application/json : multipart/mixed : #/components/schemas/error_404
422: Unprocessable Entity. application/json : multipart/mixed : [object Object],[object Object]
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
invoice_id path Active true Schema.type: string
transaction_id path Active true Schema.type: string
Request Responses:
Status Code Description Content-Type Schema
204: A successful request returns the HTTP `204 No Content` status code with no JSON response body.
403: Authorization Error. application/json : multipart/mixed : [object Object],[object Object]
404: Resource Not Found. application/json : multipart/mixed : #/components/schemas/error_404
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
invoice_id path Active true Schema.type: string
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/qr_config Optional configuration parameters to adjust QR code width, height and the encoded URL.
Request Responses:
Status Code Description Content-Type Schema
200: A successful request returns the HTTP `200 OK` status code and a JSON response body that shows the QR code as a PNG image.
400: Invalid request. multipart/mixed : [object Object],[object Object]
403: Authorization Error. multipart/mixed : [object Object],[object Object]
404: Resource Not Found. multipart/mixed : #/components/schemas/error_404
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
200: A successful request returns the HTTP `200 OK` status code and a JSON response body that shows the next invoice number. application/json : #/components/schemas/invoice_number
403: Authorization Error. application/json : #/components/schemas/error_403
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
invoice_id path Active true Schema.type: string
Request Responses:
Status Code Description Content-Type Schema
200: A successful request returns the HTTP `200 OK` status code and a JSON response body that shows invoice details. application/json : #/components/schemas/invoice
400: Invalid request. application/json : #/components/schemas/error_400
403: Authorization Error. application/json : [object Object],[object Object]
404: Resource Not Found. application/json : #/components/schemas/error_404
422: Unprocessable Entity. application/json : #/components/schemas/error_422
default: #/components/responses/default
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
invoice_id path Active true Schema.type: string
send_to_recipient query Active Schema.type: boolean
send_to_invoicer query Active Schema.type: boolean
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/invoice A representation of changes to make in the invoice. true
Request Responses:
Status Code Description Content-Type Schema
200: A successful request returns the HTTP `200 OK` status code. A JSON response body that shows invoice details is returned if you set prefer=return=representation. application/json : multipart/mixed : #/components/schemas/invoice
400: Invalid request. application/json : multipart/mixed : [object Object],[object Object]
403: Authorization Error. application/json : multipart/mixed : [object Object],[object Object]
404: Resource Not Found. application/json : multipart/mixed : #/components/schemas/error_404
422: Unprocessable Entity. application/json : multipart/mixed : [object Object],[object Object]
default: #/components/responses/default
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
invoice_id path Active true Schema.type: string
Request Responses:
Status Code Description Content-Type Schema
204: A successful request returns the HTTP `204 No Content` status code with no JSON response body.
400: Invalid request. application/json : #/components/schemas/error_400
403: Authorization Error. application/json : [object Object],[object Object]
404: Resource Not Found. application/json : #/components/schemas/error_404
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
page query Active Schema.type: integer
page_size query Active Schema.type: integer
total_required query Active Schema.type: boolean
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/search_data The invoice search can be used to retrieve the invoices based on the search parameters.
Request Responses:
Status Code Description Content-Type Schema
200: A successful request returns the HTTP `200 OK` status code and a JSON response body that lists the invoices that match the search criteria. application/json : multipart/mixed : #/components/schemas/invoices
400: Invalid request. application/json : multipart/mixed : [object Object],[object Object]
403: Authorization Error. application/json : multipart/mixed : #/components/schemas/error_403
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
fields query Active Schema.type: string
page query Active Schema.type: integer
page_size query Active Schema.type: integer
Request Responses:
Status Code Description Content-Type Schema
200: A successful request returns the HTTP `200 OK` status code and a JSON response body that lists invoices. application/json : multipart/mixed : #/components/schemas/templates
400: Invalid request. application/json : multipart/mixed : [object Object],[object Object]
403: Authorization Error. application/json : multipart/mixed : #/components/schemas/error_403
default: #/components/responses/default
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/template true
Request Responses:
Status Code Description Content-Type Schema
201: A successful request returns the HTTP `201 Created` status code. A JSON response body that shows template details is returned if you set prefer=return=representation. application/json : multipart/mixed : #/components/schemas/template
400: Invalid request. application/json : multipart/mixed : [object Object],[object Object]
422: Unprocessable Entity. application/json : multipart/mixed : [object Object],[object Object]
default: #/components/responses/default

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
template_id path Active true Schema.type: string
Request Responses:
Status Code Description Content-Type Schema
200: A successful request returns the HTTP `200 OK` status code and a JSON response body that shows template details. application/json : multipart/mixed : #/components/schemas/template
403: Authorization Error. application/json : multipart/mixed : [object Object],[object Object]
404: Resource Not Found. application/json : multipart/mixed : #/components/schemas/error_404
default: #/components/responses/default
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
template_id path Active true Schema.type: string
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/template A representation of changes to make in the template. true
Request Responses:
Status Code Description Content-Type Schema
200: A successful request returns the HTTP `200 OK` status code. A JSON response body that shows template details is returned if you set prefer=return=representation. application/json : #/components/schemas/template
400: Invalid request. application/json : [object Object],[object Object]
403: Authorization Error. application/json : [object Object],[object Object]
404: Resource Not Found. application/json : #/components/schemas/error_404
422: Unprocessable Entity. application/json : [object Object],[object Object]
default: #/components/responses/default
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
template_id path Active true Schema.type: string
Request Responses:
Status Code Description Content-Type Schema
204: A successful request returns the HTTP `204 No Content` status code with no JSON response body.
400: Invalid request. application/json : multipart/mixed : #/components/schemas/error_400
403: Authorization Error. application/json : multipart/mixed : [object Object],[object Object]
404: Resource Not Found. application/json : multipart/mixed : #/components/schemas/error_404
422: Unprocessable Entity. application/json : multipart/mixed : #/components/schemas/error_422
default: #/components/responses/default

Components


securitySchemes :
Oauth2
responses :
default
schemas :
400
403
422
error_details
error_default
error_link_description
error_400
error_401
error_403
error_404
error_409
error_415
error_422
error_500
error_503
invoice_status
currency_code
date_time
file_reference
detail
date_no_time
payment_term_type
payment_term
invoice_payment_term
template_metadata
invoice_creation_flow
metadata
invoice_detail
business_name
name
country_code
address_portable
contact_name_address
email_address
phone
phone_type
phone_detail
invoicer_info
language
billing_info
recipient_info
money
percentage
tax
discount
unit_of_measure
item
partial_payment
template_configuration
configuration
aggregated_discount
shipping_cost
custom_amount
amount_with_breakdown
amount_summary_detail
payment_type
payment_method
payment_detail
payments
refund_detail
refunds
link_description
invoice
invoices
invoices.create-400
notification
202-response
invoices.remind-400
invoices.remind-422
invoices.cancel-400
invoices.cancel-422
payment_reference
invoices.payments-400
invoices.payments-422
invoices.payments-delete-422
refund_reference
invoices.refunds-400
invoices.refunds-422
qr_config
invoices.generate-qr-code-400
invoice_number
invoices.update-400
amount_range
date_range
date_time_range
search_data
invoices.search-invoices-400
template_detail
template_info
template_item_field
template_display_preference
template_item_setting
template_subtotal_field
template_subtotal_setting
template_settings
template
templates
templates.create-400
templates.create-422
templates.get-403
templates.update-400
templates.update-422
templates.delete-403