A link to share one file of an invoice, revocable
For a link someone keeps (the accountant, the customer's purchasing office): short, a code nobody can guess, without expiry or with the one you choose, revocable, and its openings counted. ANYONE with the link can download the file, without a credential: show it to the person before handing it out. The url and code are shown ONCE, here (only a hash is stored). For a link that just has to work now, use the download_url that every read of the invoice already carries.
POST
https://api.invox.page/v1/invoices/{id}/share_linksAuthorization
Path parameters
Header parameters
Request body JSON required
Returns
200
A retry: the link of the first request, without its code.
JSON
201
The link, with its url (shown once).
JSON
400
organization_required: This credential needs to say which organization it acts on · validation_failed: The request is not valid · malformed_request: The request body is not valid JSON · idempotency_key_required: This write needs an Idempotency-Key header
JSON
401
unauthenticated: No credential was sent · invalid_credential: The credential is not valid
JSON
403
missing_scope: The credential lacks the permission this operation requires · organization_mismatch: The X-Organization header names another organization than the key's · organization_archived: The organization is archived
JSON
404
not_found: The resource does not exist in this organization · file_not_found: The invoice has no file of that kind
JSON
409
file_not_ready: The file is not stored yet
JSON
422
idempotency_key_reused: This Idempotency-Key was already used with a different request
JSON
429
rate_limited: Too many requests
JSON
500
internal_error: The service failed
JSON
503
service_unavailable: The service cannot answer right now
JSON