Invoices
Get Invoice PDF
GET

/api/invoices/{invoice_id}/pdf_url/

X-API-KEY*
Authorization*
curl --request GET \
  --url https://api.uselotus.io/api/invoices/{invoice_id}/pdf_url/ \
  --header 'Authorization: <authorization>' \
  --header 'X-API-KEY: <x-api-key>'

Retrieves a link to an invoice’s pdf, generated by Lotus.

Authorizations

Authorization[header]required
string

Token-based authentication with required prefix "Token"

Path Parameters

invoice_idrequired
string

Either an invoice ID (in the format invoice_<uuid>) or an invoice number (in the format YYMMDD-000001)

Response

amountrequired
number
cost_duerequired
number
currencyrequired
object
customerrequired
object
due_daterequired
string
end_daterequired
string
external_payment_obj_idrequired
string
external_payment_obj_status
string
external_payment_obj_typerequired
string
  • stripe - Stripe
  • braintree - Braintree
Available options:
stripe,
braintree,
null
invoice_idrequired
string
invoice_numberrequired
string
invoice_pdfrequired
string
issue_daterequired
string
line_itemsrequired
array
payment_statusrequired
  • draft - draft
  • voided - voided
  • paid - paid
  • unpaid - unpaid
Available options:
draft,
voided,
paid,
unpaid
sellerrequired
object
start_daterequired
string