SMsmokeball
Invoices

Get download url for an invoice

Retrieves download details for a specified invoice.

get/matters/{matterId}/invoices/{invoiceId}/download

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/matters/{matterId}/invoices/{invoiceId}/download
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

matterIdstring required
invoiceIdstring required

Response

When request is successful. Returns an 'InvoiceFileInfo' object.

invoiceIdstring nullable

Unique identifier of the requested invoice

versionIdstring nullable

Unique identifier of the invoice version

downloadUrlstring nullable

Link to download file

expirystring date-time

Expiry date/time when the download link is no longer accessible

statusstring nullable

Current status of the invoice

Example response

{
  "invoiceId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "versionId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "expiry": "2022-04-23T14:30:00Z",
  "status": "Draft"
}

Changes

No recorded changes to this operation across all 15 revisions of this API.