Purchase orders
List purchase orders
Returns what the company buys or subcontracts from its suppliers, with their amounts and their payment status.
Request examples
curl https://app.filmo.io/api/v1/purchase-orders \
--header "Authorization: Bearer $FILMO_API_KEY"Generated from the schema
Amounts are COST amounts, because the object is a purchase. Lines are not published, so the expense cannot be attributed to a specific item of a rental.
Authorizations
Bearer API key with the scope below. purchase-orders:read
Query parameters
Page size (1-500). Defaults to 50.
Limits: min 1, max 500
Opaque cursor of the page to return. Pass the value of pagination. from the previous response; treat it as opaque.
Limits: max length 200
The creation date of the resource falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
The creation date of the resource is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
The creation date of the resource is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
The creation date of the resource is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
The creation date of the resource is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
The last update date of the resource falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
The last update date of the resource is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
The last update date of the resource is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
The last update date of the resource is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
The last update date of the resource is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, poNumber, poDate, status, type, grossPrice, netPrice, isDraft. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.
Limits: max length 200
Filter by purchase order status.
Available options: draft, pending, completed, cancelled
Filter by status, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Available options: draft, pending, completed, cancelled
Limits: min 1 items, max 50 items
Filter by purchase order type.
Available options: subrental, stock_purchase, resale_purchase, consumable_purchase, technician, transport, repair, consignment
Filter by type, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Available options: subrental, stock_purchase, resale_purchase, consumable_purchase, technician, transport, repair, consignment
Limits: min 1 items, max 50 items
Filter by supplier.
Limits: min length 1, max length 100
Filter by supplierId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Filter by associated rental order.
Limits: min length 1, max length 100
Filter by orderId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Filter by associated project.
Limits: min length 1, max length 100
Filter by projectId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Set it to true to include pagination., the number of results that match the filters across all pages. Off by default.
Response
Successful response.
Response schema: PurchaseOrderDto
Envelope: PurchaseOrderList. meta. is present only when the operation is deprecated.
Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Show child attributesHide child attributes
Unique purchase order identifier.
Purchase order number; null while it is a draft.
Purchase order status.
Available options: draft, pending, completed, cancelled
Purchase order type.
Available options: subrental, stock_purchase, resale_purchase, consumable_purchase, technician, transport, repair, consignment
true if the purchase order is still a draft.
Purchase order date in ISO 8601 UTC; null if not set.
Supplier identifier; null while a draft has no supplier. Resolve it against /api.
Free-form reference of the purchase order; null if it has none.
Currency of the purchase order, as an ISO 4217 code.
Subtotal before discounts and taxes, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Discount total, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Tax total, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Taxable base, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Total including taxes, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Amount already paid, as a decimal string "1234.50"; null if no payment has been recorded.
Limits: pattern ^-?\d+\.\d{2}$
Associated rental order; null if it has none.
Number of that order; null if it has none.
Associated project; null if it has none.
Repair ticket that originated the purchase; null if it does not come from one.
Purchase order notes; null if it has none.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
Opaque-cursor pagination metadata.
Show child attributesHide child attributes
Opaque cursor of the next page; null when there are no more results. Pass it as cursor in the next request.
Whether more results exist beyond this page.
Number of results matching the filters across all pages. Present only when the request sets includeTotal=true.
Limits: min 0
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).
Invalid request (validation_error): malformed query or body. errors[] lists every offending field with its stable code.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
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
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 |
|---|---|---|
| 400 | validation_error | Malformed query or body. errors[] lists every offending field with its stable code. |
| 402 | addon_required | The account plan does not include the add-on this operation needs; requiredAddon names it. |
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
Purchase order
Purchase order to a supplier.
Was this page helpful?