InvoiceDto

created_atstringRequired

Date and time when the invoice was created

currencystringRequired

Three-letter currency code of the invoice

customer_idFlakeIdRequired

discount_amountintegerRequired

Total discount in smallest currency unit (e.g., cents)

giftcard_usage_amountintegerRequired

Amount paid using gift cards in smallest currency unit

idFlakeIdRequired

issued_atstringRequired

Date and time when the invoice was issued

numberintegerRequired

Sequential number of the invoice within its store

order_idFlakeIdRequired

referencestringRequired

Human readable reference of the invoice

statusenumRequired

Possible enum values

invalid
pending
generated
failed

store_idFlakeIdRequired

subtotal_amountintegerRequired

Total before tax in smallest currency unit

tax_amountintegerRequired

Total tax in smallest currency unit

total_amountintegerRequired

Total of the invoice in smallest currency unit

typeenumRequired

Possible enum values

invalid
invoice
credit_note

file_keystringOptional

Optional storage key of the generated invoice document

file_sizeintegerOptional

Optional size of the generated invoice document in bytes

parent_invoice_idFlakeIdOptional

refund_idFlakeIdOptional

Example

{
  "created_at": "2024-01-01T00:00:00Z",
  "currency": "string",
  "customer_id": "411486491630370816",
  "discount_amount": 0,
  "giftcard_usage_amount": 0,
  "id": "411486491630370816",
  "issued_at": "2024-01-01T00:00:00Z",
  "number": 0,
  "order_id": "411486491630370816",
  "reference": "string",
  "status": "invalid",
  "store_id": "411486491630370816",
  "subtotal_amount": 0,
  "tax_amount": 0,
  "total_amount": 0,
  "type": "invalid",
  "refund_id": "411486491630370816",
  "parent_invoice_id": "411486491630370816",
  "file_key": "string",
  "file_size": 0
}