v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
invoices

Show invoice details

Shows details for an invoice, by ID.

get/v2/invoicing/invoices/{invoice_id}

Path parameters

invoice_idstring required

The ID of the draft invoice to delete.

Response

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

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>