Supplier invoices
Get a supplier invoice
Returns an invoice received from a supplier by its identifier, the same compact card as GET /api.
Request examples
curl https://app.filmo.io/api/v1/supplier-invoices/supp_8f2a1c \
--header "Authorization: Bearer $FILMO_API_KEY"Generated from the schema
Authorizations
Bearer API key with the scope below. supplier-invoices:read
Headers
Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.
Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
Path parameters
Supplier invoice identifier.
Limits: min length 1
Response
Successful response.
Response schema: SupplierInvoiceDto
Envelope: SupplierInvoiceResponse. meta. is present only when the operation is deprecated.
Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag
Invoice received from a supplier.
Show child attributesHide child attributes
Supplier invoice identifier.
Number the supplier put on the invoice; null if it was not recorded.
Status of the invoice within the purchasing cycle.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
Additional information about the response.
Show child attributesHide child attributes
Lifecycle warnings; present only when the operation is deprecated.
Show child attributesHide child attributes
Stable warning code.
Available options: deprecated
For people: what is deprecated, until when, and what to use.
Day (YYYY-MM-DD) the operation stops being served.
operationId of the operation to use instead, or null if there is none.
Where the deprecation is documented (the changelog).
Not modified: the If-None-Match sent matches the current ETag. No body; the copy you have is current.
Headers: ETag
No body.
Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Headers: X-Request-Id · Content-Language
Add-on required (addon_required): the account plan does not include the add-on this operation needs; requiredAddon names it.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Not allowed (insufficient_scope: the API key does not have the required scope, named in requiredScope; forbidden: the owner of the key lacks the permission the operation requires). insufficient_scope is answered before the request counts against the rate limit, so it carries no RateLimit-* headers; forbidden does.
Headers: X-Request-Id · Content-Language
Resource not found (not_found): it does not exist or is outside the scope of the API key.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Rate limit exceeded (rate_limited): retry after Retry-After seconds; RateLimit-* says which quota ran out.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Internal error (internal_error).
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errors
| Status | Codes | Meaning |
|---|---|---|
| 402 | addon_required | The account plan does not include the add-on this operation needs; requiredAddon names it. |
| 404 | not_found | It does not exist or is outside the scope of the API key. |
401, 403, 429, 500 can be returned by any operation. Errors
Deprecation
This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy
Related pages
Link to this section: Related pagesFinance
Supplier invoice
Invoice received from a supplier.
Was this page helpful?