Static Data
GET
/api/v1/inventory/staticInventoryReturns the list of available services.
Auth Scope
urn:grt:inventoryContent-Type
application/jsonRate Limit
60 req/min
Headers
| Header | Value |
|---|---|
Authorization | Bearer access-token |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
granted_tenant_macnum | string | No | The company macnum on whose behalf the action is performed |
Response
Success Response (200 OK)
Response Fields
| Field | Type | Description |
|---|---|---|
account_billing_type_options | array of strings | A list of available options for filtering accounts by billing type |
account_parent_options | array of arrays | A list of available parent accounts for filtering. Each inner array contains the parent account number (string) and the parent account name (string) |
account_service_categories_options | array of strings | A list of available service categories for filtering accounts |
account_sort_columns_options | array of strings | A list of available column names that can be used to sort account data |
account_sort_order_options | array of strings | A list of available sort orders (e.g., "ASC" for ascending, "DESC" for descending) |
account_state_options | array of strings | A list of available states for filtering |
invoice_vendors | array of strings | A list of vendors available for invoice-related filtering |
service_completion_date_options | array of strings | A list of predefined time ranges for filtering services by their completion date |
service_end_date_options | array of strings | A list of predefined time ranges for filtering services by their end date |
service_sort_columns_options | array of strings | A list of available column names that can be used to sort service data |
service_sort_order_options | array of strings | A list of available sort orders (e.g., "ASC" for ascending, "DESC" for descending) |
service_status_options | array of strings | A list of available statuses for filtering services |
service_type_options | array of strings | A list of available service types for filtering |
service_vendor_options | object | An object containing available vendor options for filtering services, where each key is a vendor group and the value is a list of specific vendor names |
Success Response (200 OK)
Code Examples
Errors
| HTTP Status | Error Description | Resolution |
|---|---|---|
401 | Authentication Failed | Verify your access token is valid and included in the Authorization header with the "Bearer " prefix. |
403 | Permission Denied | Your access token does not have the required scope (urn:grt:inventory). Contact your administrator to request the appropriate permissions. |
Last updated on