autopilot

Read Invoice

One invoice, draft or issued. 404 when the id is unknown or not the caller's.

Polls for this invoice alone (AP-036) rather than for the whole stale batch: opening one document is one vendor call, and the rest of the account converges on the next list read.

Carries credit_notes (AP-090) — the notes written against this invoice, oldest first — because the link only matters where the document is being read: a partially credited invoice is still worth its face value in the list, and what is left of it is a question asked with the document open. The lookup is scoped by the same ownership predicate as the read above, so it cannot become a second way to see somebody else's documents.

get/api/autopilot/invoices/{invoice_id}

Request

  • Base URL: https://api.taxcompass.it (the document declares no server; this is the origin it was published from)
  • URL: https://api.taxcompass.it/api/autopilot/invoices/{invoice_id}
  • Auth: HTTP bearer

Path parameters

invoice_idstring uuid required

Response

Successful Response

client_idstring uuid nullable
atecostring nullable
issue_datestring date nullable
due_datestring date nullable
causalestring nullable
idstring uuid required
yearinteger required
numberinteger nullable
doc_typestring
status'draft' | 'sending' | 'issued' | 'delivered' | 'not_delivered' | 'rejected' | 'error' | 'imported'
total_amountstring
bollo_appliedboolean
credit_note_ofstring uuid nullable
client_labelstring nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.