Retrieve an invoice's PDF links

Returns links to the invoice’s PDF, not the PDF file itself.

GET /invoices/{invoice_id}/pdf

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/invoices/INV-0001/pdf" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "invoice": {
    "pdf": {
      "download_url": "<string>",
      "file_size": 123,
      "id": "<string>",
      "object": "<string>",
      "preview_url": "<string>"
    }
  }
}

Returns a small JSON description of the invoice’s PDF under invoice.pdf, with a preview_url, a download_url and the file_size. Fetch download_url to get the file.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

invoice_id · string · required

The invoice's id, such as INV-0001. Not its uuid.

Response

200 - application/json

The PDF details, under invoice.pdf.

invoice · object

Show child attributes