Sign in

v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
invoices

Create draft invoice

Creates a draft invoice. To move the invoice from a draft to payable state, you must <a href="#invoices_send">send the invoice</a>.<br/><br/>In the JSON request body, include invoice details including merchant information. The <code>invoice</code> object must include an <code>items</code> array.<blockquote><strong>Note:</strong> The merchant that you specify in an invoice must have a PayPal account in good standing.</blockquote>.

post/v2/invoicing/invoices

Request body

idstring

The ID of the invoice.

parent_idstring

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

status'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'

The status of the invoice.

additional_recipientsEmailAddress[]

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>

Response

A successful request returns the HTTP 201 Created status code. A JSON response body that shows invoice details is returned if you set <code>prefer=return=representation</code>.

idstring

The ID of the invoice.

parent_idstring

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

status'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'

The status of the invoice.

additional_recipientsEmailAddress[]

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>