CAcausaprima

Fetch invoice metadata

Changed on

Returns the Invoice to its sender: prove the sender's email with X-Email-Verification-Token (or the scribo_session cookie), as for a create. Each call mints a fresh signed download URL that expires at download_url_expires_at, 15 minutes later. Another sender's invoice and an unknown id return the same 404.

get/api/v1/invoices/{id}

Request

Path parameters

idstring uuid required

Invoice UUID

Headers

X-Email-Verification-Tokenstring

Email-ownership token of the invoice's sender, from POST /api/v1/scribo/email-verifications/{id}/redeem (reusable for about 30 minutes). Required on every read unless a scribo_session cookie is sent; without either the read answers 401 email_verification_required.

Response

Invoice metadata

invoice_idstring uuid required
document_idstring uuid required
format'zugferd_comfort' | 'zugferd_basic' | 'xrechnung_cii' | 'xrechnung_ubl' | 'plain_pdf' required
download_urlstring uri required
download_url_expires_atstring date-time required
preview_urlstring uri
preview_url_expires_atstring date-time
magic_link_sentboolean required
recipient_email_sentboolean

Changes

  • 5ebae81e6187Revision changes
    • info

      added the new optional header request parameter X-Email-Verification-Token

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status