<- Invoices API

Invoices API

All versions ->

Create invoice attachment

POST

 /v2/invoices/{invoice_id}/attachments

Uploads a file and attaches it to an invoice.

This endpoint accepts HTTP multipart/form-data file uploads with a JSON request part and a file part. The file part must be a readable stream that contains a file in a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF.

Invoices can have up to 10 attachments with a total file size of 25 MB. Attachments can be added only to invoices in the DRAFT, SCHEDULED, UNPAID, or PARTIALLY_PAID state.

NOTE: When testing in the Sandbox environment, the total file size is limited to 1 KB.

Permissions:INVOICES_WRITE, ORDERS_WRITE

Guide

Create invoice attachments

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

invoice_id

string

Required

The ID of the invoice to attach the file to.

Link to section

Request body

Link to section

idempotency_key

string

A unique string that identifies the CreateInvoiceAttachment request. For more information, see Idempotency.

Max Length
128
Link to section

description

string

The description of the attachment to display on the invoice.

Max Length
128
Link to section

Response fields

Link to section

attachment

Metadata about the attachment that was added to the invoice.

Link to section

errors

Information about errors encountered during the request.